จะบอกแจ็คสันให้เพิกเฉยฟิลด์ในระหว่างการทำให้เป็นอนุกรมได้อย่างไรถ้าค่าเป็นโมฆะ?

แจ็กสันสามารถกำหนดค่าให้ละเว้นค่าฟิลด์ในระหว่างการทำให้เป็นอนุกรมได้อย่างไรถ้าค่าของฟิลด์นั้นเป็นโมฆะ

ตัวอย่างเช่น:

public class SomeClass {
   // what jackson annotation causes jackson to skip over this value if it is null but will 
   // serialize it otherwise 
   private String someValue; 
}

ในการระงับคุณสมบัติซีเรียลไลซ์เซชั่นด้วยค่า Null โดยใช้ Jackson> 2.0 คุณสามารถกำหนดค่าObjectMapperโดยตรงหรือใช้ประโยชน์จาก@JsonIncludeหมายเหตุประกอบ:

mapper.setSerializationInclusion(Include.NON_NULL);

หรือ:

@JsonInclude(Include.NON_NULL)
class Foo
{
  String bar;
}

หรือคุณสามารถใช้@JsonIncludeใน getter เพื่อให้แอททริบิวปรากฏขึ้นหากค่าไม่เป็นโมฆะ

เป็นตัวอย่างที่สมบูรณ์มากขึ้นมีอยู่ในคำตอบของฉันที่จะวิธีการป้องกันค่า null ภายในแผนที่และสาขา null ภายในถั่วจากการต่อเนื่องผ่านแจ็คสัน

ด้วย Jackson> 1.9.11 และ <2.x ใช้@JsonSerializeคำอธิบายประกอบเพื่อทำสิ่งนี้:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

เพียงเพื่อขยายคำตอบอื่น ๆ - หากคุณต้องการควบคุมการละเว้นค่า Null บนพื้นฐานต่อฟิลด์ให้ใส่คำอธิบายประกอบในคำถาม (หรือเพิ่มคำอธิบายประกอบของ 'getter')

ตัวอย่าง -ที่นี่เท่านั้นfieldOneจะถูก ommitted จาก json ถ้ามันเป็นโมฆะ fieldTwoจะรวมอยู่เสมอไม่ว่าจะเป็นโมฆะหรือไม่ก็ตาม

public class Foo {

    @JsonInclude(JsonInclude.Include.NON_NULL) 
    private String fieldOne;

    private String fieldTwo;
}

ในการละเว้นค่า Null ทั้งหมดในคลาสเป็นค่าเริ่มต้นให้ใส่คำอธิบายประกอบคลาส คำอธิบายประกอบแบบต่อฟิลด์ / ทะเยอทะยานยังสามารถใช้เพื่อแทนที่ค่าเริ่มต้นนี้หากจำเป็น

ตัวอย่าง -ที่นี่fieldOneและfieldTwoจะถูก ommitted จาก json หากพวกเขาเป็นโมฆะตามลำดับเพราะนี่คือชุดเริ่มต้นโดยคำอธิบายประกอบในชั้นเรียน fieldThreeอย่างไรก็ตามจะแทนที่ค่าเริ่มต้นและจะรวมอยู่ด้วยเสมอเนื่องจากมีคำอธิบายประกอบในฟิลด์

@JsonInclude(JsonInclude.Include.NON_NULL)
public class Foo {

    private String fieldOne;

    private String fieldTwo;

    @JsonInclude(JsonInclude.Include.ALWAYS)
    private String fieldThree;
}

UPDATE

ข้างต้นเป็นสำหรับแจ็คสัน 2 สำหรับแจ็คสันรุ่นก่อนหน้าคุณต้องใช้:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 

แทน

@JsonInclude(JsonInclude.Include.NON_NULL)

หากการอัปเดตนี้มีประโยชน์โปรด upvote คำตอบของ ZiglioUK ด้านล่างมันชี้ให้เห็นคำอธิบายประกอบ Jackson 2 ที่ใหม่กว่าก่อนที่ฉันจะอัปเดตคำตอบเพื่อใช้!

ใน Jackson 2.x ให้ใช้:

@JsonInclude(JsonInclude.Include.NON_NULL)

คุณสามารถใช้การกำหนดค่า mapper ต่อไปนี้:

mapper.getSerializationConfig().setSerializationInclusion(Inclusion.NON_NULL);

ตั้งแต่ 2.5 คุณสามารถใช้:

mapper.setSerializationInclusion(Include.NON_NULL);

คุณสามารถตั้งค่าapplication.properties:

spring.jackson.default-property-inclusion=non_null

หรือapplication.yaml:

spring:
  jackson:
    default-property-inclusion: non_null

http://docs.spring.io/spring-boot/docs/current/reference/html/common-application-properties.html

ในกรณีของฉัน

@JsonInclude(Include.NON_EMPTY)

ทำให้มันทำงาน

@JsonInclude(JsonInclude.Include.NON_NULL)
@JsonInclude(JsonInclude.Include.NON_EMPTY)

ควรทำงาน.

Include.NON_EMPTYบ่งชี้ว่าคุณสมบัตินั้นเป็นอนุกรมหากค่าไม่เป็นโมฆะและไม่ว่างเปล่า Include.NON_NULLบ่งชี้ว่าคุณสมบัตินั้นเป็นอนุกรมหากค่าไม่เป็นโมฆะ

หากคุณต้องการเพิ่มกฎนี้ให้กับทุกรุ่นใน Jackson 2.6+ ให้ใช้:

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

หากในSpring Bootคุณสามารถปรับแต่งแจ็คสันObjectMapperได้โดยตรงผ่านไฟล์คุณสมบัติ

ตัวอย่างapplication.yml:

spring:
  jackson:
    default-property-inclusion: non_null # only include props if non-null

ค่าที่เป็นไปได้คือ:

always|non_null|non_absent|non_default|non_empty

เพิ่มเติม: https://docs.spring.io/spring-boot/docs/current/reference/html/howto-spring-mvc.html#howto-customize-the-jackson-objectmapper

สิ่งนี้จะทำงานในSpring boot 2.0.3+ และ Jackson 2.0+

import com.fasterxml.jackson.annotation.JsonInclude;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ApiDTO
{
    // your class variable and 
    // methods
}

สำหรับแจ็คสัน 2.5 ใช้:

@JsonInclude(content=Include.NON_NULL)

สิ่งนี้ทำให้ฉันหนักใจมาระยะหนึ่งและในที่สุดก็พบปัญหา ปัญหานี้เกิดจากการนำเข้าผิด ก่อนหน้านี้ฉันเคยใช้

com.fasterxml.jackson.databind.annotation.JsonSerialize

ซึ่งเลิกใช้แล้ว เพียงแทนที่การนำเข้าโดย

import org.codehaus.jackson.map.annotate.JsonSerialize;
import org.codehaus.jackson.map.annotate.JsonSerialize.Inclusion;

และใช้มันเป็น

@JsonSerialize(include=Inclusion.NON_NULL)

การกำหนดค่าส่วนกลางหากคุณใช้ Spring

@Configuration
public class JsonConfigurations {

    @Bean
    public Jackson2ObjectMapperBuilder objectMapperBuilder() {
        Jackson2ObjectMapperBuilder builder = new Jackson2ObjectMapperBuilder();
        builder.serializationInclusion(JsonInclude.Include.NON_NULL);
        builder.serializationInclusion(JsonInclude.Include.NON_EMPTY);
        builder.failOnUnknownProperties(false);
        return builder;
    }

}

หากคุณพยายามเรียงลำดับรายการวัตถุและหนึ่งในนั้นเป็นโมฆะคุณจะต้องจบลงด้วยการรวมรายการว่างไว้ใน JSON ด้วย

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

จะส่งผลให้:

[{myObject},null]

เพื่อรับสิ่งนี้:

[{myObject}]

เราสามารถทำสิ่งที่ชอบ:

mapper.getSerializerProvider().setNullValueSerializer(new JsonSerializer<Object>() {
        @Override
        public void serialize(Object obj, JsonGenerator jsonGen, SerializerProvider unused)
                throws IOException
        {
            //IGNORES NULL VALUES!
        }
    });

เคล็ดลับ: หากคุณใช้ DropWizard คุณสามารถดึงข้อมูลที่ObjectMapperJersey ใช้มาใช้environment.getObjectMapper()

เรามีคำตอบสำหรับคำถามนี้มากมาย คำตอบนี้อาจเป็นประโยชน์ในบางสถานการณ์หากคุณต้องการละเว้นค่า Null คุณสามารถใช้ NOT_NULL ในระดับชั้นเรียนได้ ดังต่อไปนี้

@JsonInclude(Include.NON_NULL)
class Foo
{
  String bar;
}

บางครั้งคุณอาจต้องละเว้นค่าว่างเช่นคุณอาจเริ่มต้น arrayList แต่ไม่มีองค์ประกอบในรายการนั้นในเวลานั้นใช้หมายเหตุประกอบแบบ NOT_EMPTY เพื่อละเว้นฟิลด์ค่าว่างเหล่านั้น

@JsonInclude(Include.NON_EMPTY)
class Foo
{
  String bar;
}

ใช้แจ็คสัน 2.x +

mapper.getSerializationConfig().withSerializationInclusion(JsonInclude.Include.NON_NULL);

นอกจากนี้คุณต้องเปลี่ยนวิธีการของคุณเมื่อใช้ Map myVariable ตามที่อธิบายไว้ในเอกสารประกอบเพื่อเผยแพร่ nulls:

From documentation:
com.fasterxml.jackson.annotation.JsonInclude

@JacksonAnnotation
@Target(value={ANNOTATION_TYPE, FIELD, METHOD, PARAMETER, TYPE})
@Retention(value=RUNTIME)
Annotation used to indicate when value of the annotated property (when used for a field, method or constructor parameter), or all properties of the annotated class, is to be serialized. Without annotation property values are always included, but by using this annotation one can specify simple exclusion rules to reduce amount of properties to write out.

*Note that the main inclusion criteria (one annotated with value) is checked on Java object level, for the annotated type, and NOT on JSON output -- so even with Include.NON_NULL it is possible that JSON null values are output, if object reference in question is not `null`. An example is java.util.concurrent.atomic.AtomicReference instance constructed to reference null value: such a value would be serialized as JSON null, and not filtered out.

To base inclusion on value of contained value(s), you will typically also need to specify content() annotation; for example, specifying only value as Include.NON_EMPTY for a {link java.util.Map} would exclude Maps with no values, but would include Maps with `null` values. To exclude Map with only `null` value, you would use both annotations like so:
public class Bean {
   @JsonInclude(value=Include.NON_EMPTY, content=Include.NON_NULL)
   public Map<String,String> entries;
}

Similarly you could Maps that only contain "empty" elements, or "non-default" values (see Include.NON_EMPTY and Include.NON_DEFAULT for more details).
In addition to `Map`s, `content` concept is also supported for referential types (like java.util.concurrent.atomic.AtomicReference). Note that `content` is NOT currently (as of Jackson 2.9) supported for arrays or java.util.Collections, but supported may be added in future versions.
Since:
2.0

กรณีที่หนึ่ง

@JsonInclude(JsonInclude.Include.NON_NULL)
private String someString;

กรณีที่สอง

@JsonInclude(JsonInclude.Include.NON_EMPTY)
private String someString;

หากsomeStringเป็นโมฆะมันจะถูกละเว้นในทั้งสองกรณี ถ้าsomeStringเป็น "" มันจะถูกละเว้นเฉพาะในกรณีที่สอง

เหมือนกันสำหรับList = nullหรือList.size() = 0