Làm thế nào để bảo Jackson bỏ qua một trường trong quá trình tuần tự hóa nếu giá trị của nó là null?

Làm thế nào Jackson có thể được cấu hình để bỏ qua một giá trị trường trong quá trình tuần tự hóa nếu giá trị của trường đó là null.

Ví dụ:

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; 
}

Để loại bỏ các thuộc tính tuần tự hóa với các giá trị null bằng Jackson> 2.0, bạn có thể định cấu hình ObjectMappertrực tiếp hoặc sử dụng @JsonIncludechú thích:

mapper.setSerializationInclusion(Include.NON_NULL);

hoặc là:

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

Ngoài ra, bạn có thể sử dụng @JsonIncludetrong một getter để thuộc tính sẽ được hiển thị nếu giá trị không phải là null.

Một ví dụ đầy đủ hơn có sẵn trong câu trả lời của tôi về Cách ngăn các giá trị null bên trong Bản đồ và các trường null bên trong một bean không được tuần tự hóa thông qua Jackson .

Với Jackson> 1.9.11 và <2.x, hãy sử dụng @JsonSerializechú thích để làm điều đó:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

Chỉ để mở rộng các câu trả lời khác - nếu bạn cần kiểm soát việc bỏ qua các giá trị null trên cơ sở từng trường, hãy chú thích trường đang đề cập (hoặc thay vào đó là chú thích 'getter' của trường).

ví dụ - ở đây fieldOnesẽ chỉ được thông báo từ json nếu nó là null. fieldTwosẽ luôn được bao gồm bất kể nó là null.

public class Foo {

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

    private String fieldTwo;
}

Để bỏ qua tất cả các giá trị null trong lớp làm mặc định, chú thích lớp. Chú thích trên mỗi trường / getter vẫn có thể được sử dụng để ghi đè mặc định này nếu cần.

ví dụ - ở đây fieldOnevà fieldTwosẽ được thông báo từ json nếu chúng là null, vì đây là mặc định được đặt bởi chú thích lớp. fieldThreetuy nhiên sẽ ghi đè mặc định và sẽ luôn được đưa vào, vì chú thích trên trường.

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

    private String fieldOne;

    private String fieldTwo;

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

CẬP NHẬT

Trên đây là cho Jackson 2 . Đối với các phiên bản trước của Jackson, bạn cần sử dụng:

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 

thay vì

@JsonInclude(JsonInclude.Include.NON_NULL)

Nếu bản cập nhật này hữu ích, vui lòng nâng cấp câu trả lời của ZiglioUK bên dưới, nó chỉ ra chú thích Jackson 2 mới hơn trước khi tôi cập nhật câu trả lời của mình để sử dụng nó!

Trong Jackson 2.x, sử dụng:

@JsonInclude(JsonInclude.Include.NON_NULL)

Bạn có thể sử dụng cấu hình mapper sau:

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

Kể từ 2.5 bạn có thể sử dụng:

mapper.setSerializationInclusion(Include.NON_NULL);

Bạn có thể đặt application.properties:

spring.jackson.default-property-inclusion=non_null

hoặc application.yaml:

spring:
  jackson:
    default-property-inclusion: non_null

http://docs.spring.io/spring-boot/docs/civerse/reference/html/common-application-properIES.html

trong trường hợp của tôi

@JsonInclude(Include.NON_EMPTY)

làm cho nó hoạt động.

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

nên làm việc.

Include.NON_EMPTYchỉ ra rằng thuộc tính được tuần tự hóa nếu giá trị của nó không rỗng và không trống. Include.NON_NULLchỉ ra rằng thuộc tính được tuần tự hóa nếu giá trị của nó không phải là null.

Nếu bạn muốn thêm quy tắc này cho tất cả các mô hình trong Jackson 2.6+, hãy sử dụng:

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Nếu trong Spring Boot , bạn có thể tùy chỉnh jackson ObjectMappertrực tiếp thông qua các tệp thuộc tính.

Ví dụ application.yml:

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

Các giá trị có thể là:

always|non_null|non_absent|non_default|non_empty

Thêm: https://docs.spring.io/spring-boot/docs/civerse/reference/html/howto-spring-mvc.html#howto-customize-the-jackson-objectmapper

Điều này sẽ hoạt động trong Spring boot 2.0.3+ và Jackson 2.0+

import com.fasterxml.jackson.annotation.JsonInclude;

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

Đối với Jackson 2.5 sử dụng:

@JsonInclude(content=Include.NON_NULL)

Điều này đã gây rắc rối cho tôi trong một thời gian và cuối cùng tôi đã tìm thấy vấn đề. Vấn đề là do nhập sai. Trước đó tôi đã sử dụng

com.fasterxml.jackson.databind.annotation.JsonSerialize

Mà đã bị phản đối. Chỉ cần thay thế nhập khẩu bằng

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

và sử dụng nó như

@JsonSerialize(include=Inclusion.NON_NULL)

Cấu hình toàn cầu nếu bạn sử dụng 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;
    }

}

Nếu bạn đang cố gắng tuần tự hóa một danh sách các đối tượng và một trong số chúng là null, bạn sẽ kết thúc bao gồm cả mục null trong JSON ngay cả với

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

sẽ cho kết quả:

[{myObject},null]

để có được điều này:

[{myObject}]

người ta có thể làm một cái gì đó như:

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

MIPO: Nếu bạn đang sử dụng DropWizard, bạn có thể truy xuất việc ObjectMapperđang được Jersey sử dụng bằng cách sử dụngenvironment.getObjectMapper()

Chúng tôi có rất nhiều câu trả lời cho câu hỏi này. Câu trả lời này có thể hữu ích trong một số trường hợp Nếu bạn muốn bỏ qua các giá trị null, bạn có thể sử dụng NOT_NULL ở cấp lớp. như sau

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

Đôi khi bạn có thể cần bỏ qua các giá trị trống, chẳng hạn như bạn có thể đã khởi tạo mảng ListList nhưng không có phần tử nào trong danh sách đó. Trong thời gian đó, sử dụng chú thích NOT_EMPTY để bỏ qua các trường giá trị trống đó

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

Jackson 2.x + sử dụng

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

Ngoài ra, bạn phải thay đổi cách tiếp cận của mình khi sử dụng Map myVariable như được mô tả trong tài liệu để làm nổi bật null:

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

Trường hợp một

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

Trường hợp hai

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

Nếu someStringlà null, nó sẽ bị bỏ qua trên cả hai trường hợp. Nếu someStringlà "" nó chỉ được bỏ qua trong trường hợp hai.

Tương tự cho List = nullhoặcList.size() = 0