如果字段值为空，如何告诉杰克逊在序列化期间忽略字段？

要使用 Jackson > 2.0 禁止序列化具有空值的属性，您可以 configure the ObjectMapper directly 或使用 @JsonInclude 注释：

mapper.setSerializationInclusion(Include.NON_NULL);

或者：

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

或者，您可以在 getter 中使用 @JsonInclude，以便在值不为 null 时显示属性。

my answer 到 How to prevent null values inside a Map and null fields inside a bean from getting serialized through Jackson 中提供了更完整的示例。

---

只是为了扩展其他答案-如果您需要在每个字段的基础上控制空值的省略，请注释有问题的字段（或者注释字段的“getter”）。

示例 - 这里只有 fieldOne 如果为 null 则从 JSON 中省略。 fieldTwo 将始终包含在 JSON 中，无论它是否为空。

public class Foo {

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

    private String fieldTwo;
}

要默认忽略类中的所有空值，请对类进行注释。如有必要，仍然可以使用每个字段/getter 注释来覆盖此默认值。

example - 此处的 fieldOne 和 fieldTwo 如果它们分别为 null，则将分别从 JSON 中省略，因为这是类注释设置的默认值。但是，fieldThree 将覆盖默认值并始终包含在内，因为该字段上有注释。

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

    private String fieldOne;

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

更新

以上是杰克逊 2。对于杰克逊的早期版本，您需要使用：

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL) 

代替

@JsonInclude(JsonInclude.Include.NON_NULL)

如果此更新有用，请在下面支持 ZiglioUK 的答案，它早在我更新我的答案以使用它之前就指出了较新的 Jackson 2 注释！

---

与杰克逊 > 1.9.11 和 < 2.x 使用 @JsonSerialize 注释来做到这一点：

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

---

在 Jackson 2.x 中，使用：

@JsonInclude(JsonInclude.Include.NON_NULL)

---

您可以使用以下映射器配置：

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 表示如果属性的值不为 null 且不为空，则该属性被序列化。 Include.NON_NULL 表示如果属性的值不为 null，则该属性被序列化。

---

这将适用于 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
}

---

如果您想将此规则添加到 Jackson 2.6+ 中的所有模型，请使用：

mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

---

如果在Spring Boot中，可以直接通过属性文件自定义jacksonObjectMapper。

示例 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

---

对于杰克逊 2.5 使用：

@JsonInclude(content=Include.NON_NULL)

---

如果您尝试序列化一个对象列表并且其中一个为空，您最终会在 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，您可以使用 environment.getObjectMapper() 检索 Jersey 使用的 ObjectMapper

---

这一直困扰着我很长一段时间，我终于找到了问题。问题是由于错误的导入。早些时候我一直在使用

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

}

---

这个问题我们有很多答案。这个答案在某些情况下可能会有所帮助如果您想忽略空值，您可以在类级别使用 NOT_NULL。如下

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

有时您可能需要忽略空值，例如您可能已经初始化了 arrayList 但该列表中没有元素。那时使用 NOT_EMPTY 注释来忽略那些空值字段

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

---

案例一

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

案例二

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

如果 someString 为 null，则在这两种情况下都将被忽略。如果 someString 是 "" 它只会在情况 2 中被忽略。

List = null 或 List.size() = 0 相同

---

杰克逊 2.x+ 使用

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

---

此外，在使用 Map myVariable 时，您必须更改方法，如文档中所述以消除空值：

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

---

尝试这个 -

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)
public class XYZ {
    
    protected String field1;
    
    protected String field2;
 }

对于非空值（在 getters/class 级别） -

@JsonSerialize(include=JsonSerialize.Inclusion.NON_EMPTY)

---