在java应用开发中，尤其是在构建restful api时，我们经常使用jackson库进行json数据的序列化与反序列化，并结合lombok来简化pojo类的编写。然而，一个常见的陷阱是，当类中定义了带有默认值的boolean包装类型字段，并且该字段在传入的json数据中缺失时，jackson在反序列化后并不会应用我们预设的默认值，而是将其设为null，这可能导致后续操作中出现nullpointerexception。
问题分析：Boolean与boolean的差异
问题的核心在于Java中Boolean包装类型和boolean基本类型的行为差异。
-
boolean基本类型：
- boolean是Java的原始数据类型，它只有两个可能的值：true和false。
- 它的默认值是false。这意味着，如果你在一个类中声明了一个boolean字段而没有显式初始化它，它在对象创建后将自动被初始化为false。
- 它不能为null。
-
Boolean包装类型：
- Boolean是boolean的包装类，它是一个对象。
- 它有三个可能的值：true、false和null。
- 当一个Boolean字段没有被显式初始化或赋值时，它的默认值是null。
- Jackson在反序列化JSON时，如果对应的字段在JSON中不存在，对于Boolean类型的字段，它通常会保持其null状态，而不是触发Java对象中声明的默认值（如= false）。Lombok生成的构造器或setter方法并不会改变Jackson的这一默认反序列化行为。
考虑以下场景：一个DTO类中有一个negate字段，我们希望当JSON中不包含此字段时，其值默认为false。
@Data // Lombok注解，生成getter, setter, equals, hashCode, toString
@AllArgsConstructor
@ApiModel // Swagger注解，此处不影响Jackson行为
public class RelationEntityTypeFilter {
private String relationType;
private List entityTypes;
private Boolean negate = false; // 期望默认值为false
} 当接收到如{ "relationType": "Contains", "entityTypes": []}这样的JSON时，尽管negate字段在类中被初始化为false，但Jackson在反序列化时，由于JSON中没有negate字段，它会将negate属性设置为null，而不是使用Java代码中定义的默认值。这导致调用relationEntityTypeFilter.getNegate()时，如果直接解引用，就会抛出NullPointerException。
解决方案：使用boolean基本类型
最直接且推荐的解决方案是将字段类型从Boolean包装类型更改为boolean基本类型。
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
// 简化后的示例类
@NoArgsConstructor // Lombok注解，生成无参构造器
@Getter // Lombok注解，生成getter方法
@Setter // Lombok注解，生成setter方法
@ToString // Lombok注解，生成toString方法
public class RelationEntityTypeFilter {
private boolean negate; // 将Boolean改为boolean
}代码示例：
让我们通过一个简单的Jackson反序列化示例来验证这一点。
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
public class JacksonBooleanDefaultDemo {
@NoArgsConstructor
@Getter
@Setter
@ToString
public static class RelationEntityTypeFilter {
private boolean negate; // 使用基本类型boolean
}
public static void main(String[] args) throws Exception {
ObjectMapper mapper = new ObjectMapper();
// JSON中缺少negate字段
String negateIsMissing = "{ }";
// JSON中显式指定negate为false
String negateIsFalse = """
{
"negate" : false
}
""";
// JSON中显式指定negate为true
String negateIsTrue = """
{
"negate" : true
}
""";
System.out.println("--- negate字段缺失 ---");
RelationEntityTypeFilter filterMissing = mapper.readValue(negateIsMissing, RelationEntityTypeFilter.class);
System.out.println(filterMissing); // 预期输出: RelationEntityTypeFilter(negate=false)
System.out.println("\n--- negate字段显式为false ---");
RelationEntityTypeFilter filterFalse = mapper.readValue(negateIsFalse, RelationEntityTypeFilter.class);
System.out.println(filterFalse); // 预期输出: RelationEntityTypeFilter(negate=false)
System.out.println("\n--- negate字段显式为true ---");
RelationEntityTypeFilter filterTrue = mapper.readValue(negateIsTrue, RelationEntityTypeFilter.class);
System.out.println(filterTrue); // 预期输出: RelationEntityTypeFilter(negate=true)
}
}输出结果：
--- negate字段缺失 --- RelationEntityTypeFilter(negate=false) --- negate字段显式为false --- RelationEntityTypeFilter(negate=false) --- negate字段显式为true --- RelationEntityTypeFilter(negate=true)
从输出可以看出，当JSON中缺少negate字段时，Jackson在反序列化为RelationEntityTypeFilter对象后，negate字段的值自动为false，这正是我们期望的默认行为。这是因为Java的boolean基本类型默认值就是false，Jackson在反序列化时会遵循这一语言特性。
注意事项
-
何时使用Boolean包装类型？
- 当你需要明确表示“未知”或“不存在”的布尔状态时（即允许字段为null）。例如，在一个数据库表中，某个布尔字段允许NULL值。
- 当字段需要存储在泛型集合中时（如List
），因为Java泛型不支持基本类型。 - 在某些API设计中，如果布尔参数是可选的，并且缺失与false具有不同的语义，那么使用Boolean并允许其为null可能更合适。
Lombok的@Data与默认值： Lombok的@Data注解会生成构造器、getter、setter等方法。对于private Boolean negate = false;这样的声明，Lombok并不会在生成的无参构造器中显式地设置这个默认值。这个= false的初始化实际上是在JVM加载类并创建实例时执行的。然而，Jackson在反序列化时，会直接通过反射机制或setter方法填充字段，如果JSON中缺少该字段，它不会去触发这个Java层面的默认初始化。而对于boolean基本类型，即使JSON中缺少字段，由于其语言层面的默认值就是false，所以Jackson反序列化后自然就是false。
Jackson的默认值处理： Jackson提供了多种处理默认值的方式，例如使用@JsonSetter(defaultValue = "false")或@JsonInclude(JsonInclude.Include.NON_DEFAULT)等注解。但对于简单的false默认值场景，将Boolean改为boolean是最简洁、性能最好的方法，因为它利用了Java语言本身的特性。
总结
在Java应用中，当设计数据传输对象（DTO）时，如果一个布尔字段的默认值明确为false，并且在JSON中缺失时也应视为false，那么强烈建议使用boolean基本类型而非Boolean包装类型。这不仅可以避免潜在的NullPointerException，还能提高内存效率，并简化代码逻辑。只有当你确实需要区分true、false和null三种状态时，才应考虑使用Boolean包装类型，并相应地处理null值。
