Jackson - Serialize boolean to 1/0 instead of true/false

Question

I have REST resource that receives JSON object which is a map from user ID to some boolean that indicate if this user had errors.

Since I'm expecting a large number of users, I would like to shrink the size of this JSON by using 1/0 instead of true/false.

I tried and found that during desalinization Jackson will convert 1/0 to true/false successfully, but is there a way to tell Jackson (maybe using annotation?) to serialize this boolean field to 1/0 instead of true/false?

Add a [custom serializer](http://wiki.fasterxml.com/JacksonHowToCustomSerializers) for the `boolean` type. — Boris the Spider, Nov 09 '14 at 10:52

score 20 · Answer 1 · answered Jul 20 '18 at 16:20

20

Since jackson-databind 2.9, @JsonFormat supports numeric (0/1) boolean serialization (but not deserialization):

@JsonFormat(shape = JsonFormat.Shape.NUMBER)
abstract boolean isActive();

See https://github.com/fasterxml/jackson-databind/issues/1480 which references this SO post.

answered Jul 20 '18 at 16:20

Brice Roncace

10,110
9
60
69

2

@danieln: I suggest marking this as the correct answer. – Christoffer Hammarström Mar 11 '21 at 12:09

score 17 · Answer 2 · answered May 31 '16 at 15:58

Here is a Jackson JsonSerializer that will serialize booleans as 1 or 0.

public class NumericBooleanSerializer extends JsonSerializer<Boolean> {
    @Override
    public void serialize(Boolean b, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
        jsonGenerator.writeNumber(b ? 1 : 0);
    }
}

Then annotate boolean fields like so:

@JsonSerialize(using = NumericBooleanSerializer.class)
private boolean fieldName;

Or register it in a Jackson Module:

module.addSerializer(new NumericBooleanSerializer());

Just in case of "Class serializer has no default (no arg) constructor", have a look at https://stackoverflow.com/a/54605694/573034 — Paolo, Feb 18 '20 at 12:59

Jackson - Serialize boolean to 1/0 instead of true/false

2 Answers2