在使用 jackson 转换 Java 对象时如何忽略可选属性

json java jackson

2022-09-04 02:39:18

我正在使用Jackson 1.9.2（org.codehaus.jackson）从Java对象到匹配JSON构造。这是我的java对象：

Class ColorLight {
    String type;
    boolean isOn;
    String value;

    public String getType(){
        return type;
    }

    public setType(String type) {
        this.type = type;
    }

    public boolean getIsOn(){
        return isOn;
    }

    public setIsOn(boolean isOn) {
        this.isOn = isOn;
    }

    public String getValue(){
        return value;
    }

    public setValue(String value) {
        this.value = value;
    }
}

如果我进行以下转换，我会得到我想要的结果。

ColorLight light = new ColorLight();
light.setType("red");
light.setIsOn("true");
light.setValue("255");
objectMapper mapper = new ObjectMapper();
jsonString = mapper.writeValueAsString();

jsonString是这样的：

{"type":"red","isOn":"true", "value":"255"}

但有时我没有isOn属性的价值

ColorLight light = new ColorLight();
light.setType("red");
light.setValue("255");

但是jsonString仍然是这样的：

{"type":"red","isOn":"false", "value":"255"}

其中“isOn：false”是Java布尔类型的默认值，我不希望它在那里。如何删除最终 json 构造中的 isOn 属性，如下所示？

{"type":"red","value":"255"}

答案 1

如果该值不存在，则跳过该值：

使用代替基元（值始终设置为 or ）。Booleanbooleanbooleantruefalse
将 Jackson 配置为不使用或序列化 null，具体取决于版本。@JsonInclude(Include.NON_NULL)@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

答案 2

您可以使用 in 1.x 批注标记您的类，该批注指示仅包含具有与默认设置不同的值的属性（即在使用其无参数构造函数构造 Bean 时它们具有的值）。@JsonSerialize(include = JsonSerialize.Inclusion.NON_DEFAULT)

该批注用于版本 2.x。@JsonInclude(JsonInclude.Include.NON_DEFAULT)

下面是一个示例：

public class JacksonInclusion {

    @JsonSerialize(include = JsonSerialize.Inclusion.NON_DEFAULT)
    public static class ColorLight {
        public String type;
        public boolean isOn;

        public ColorLight() {
        }

        public ColorLight(String type, boolean isOn) {
            this.type = type;
            this.isOn = isOn;
        }
    }

    public static void main(String[] args) throws IOException {
        ColorLight light = new ColorLight("value", false);
        ObjectMapper mapper = new ObjectMapper();
        System.out.println(mapper.writeValueAsString(light));
    }
}

输出：

{"type":"value"}