Java中boolean类型属性is丢失问题分析及序列化时注意事项

最新推荐文章于 2025-03-02 18:06:55 发布

Basililon

最新推荐文章于 2025-03-02 18:06:55 发布

阅读量5.7k

点赞数 25

分类专栏： Java 文章标签： java spring 后端开发语言 guava

本文链接：https://blog.csdn.net/weixin_44713589/article/details/132352741

版权

Java 专栏收录该内容

7 篇文章

订阅专栏

1. 背景与问题

在阿里开发手册中，强制规定不要在布尔类型的字段上使用is作为前缀来定义方法，而应该采用其他方式。原因在于JavaBeans Specification对于普通参数和布尔类型参数的命名规则是不同的。具体来说，对于普通参数，getter和setter方法以get和set开头，而对于布尔类型参数，setter方法仍然以set开头，但getter方法则以is开头。

这就导致在一些情况下，如使用不同的序列化工具，会出现不一致的行为，甚至出现字段丢失或被重命名的问题。
在这里插入图片描述

2. 示例说明

2.1 定义实体类

@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class TestBooleanType {
    private Boolean isAaa;
    private boolean isBbb;

	//用于后续序列化区别演示
    public String getColor() {
        return "red";
    }
}

2.2 测试方法

@Test
public void test() throws JsonProcessingException {
    TestBooleanType booleanType = TestBooleanType.builder()
            .isAaa(true)
            .isBbb(true)
            .build();
            
	//getter和setter方法不一样
    booleanType.getIsAaa();
    booleanType.setIsAaa(false);
    booleanType.isBbb();
    booleanType.setBbb(false);

	//jackson序列化
    ObjectMapper objectMapper = new ObjectMapper();
    System.out.println(objectMapper.writeValueAsString(booleanType));
	//fastjson序列化
    System.out.println(JsonUtil.getJsonString(booleanType));
	//Gson序列化
    System.out.println(new Gson().toJson(booleanType));
}

2.3 运行结果

{"isAaa":false,"bbb":false,"color":"red"} // Jackson
{"bbb":false,"color":"red","isAaa":false} // Fastjson
{"isAaa":false,"isBbb":false} // Gson

2.4 结果分析

从中可以看出，不同的序列化工具会对布尔类型字段的命名产生不同的影响

在使用fastjson和jackson进行对象序列化时，会遍历类中的所有getter方法。对于以is开头的布尔类型字段，fastjson和jackson会将其识别为属性，并去掉is前缀。这可能导致类似isBbb被序列化为bbb，同时也会包含其他方法（如getColor）的结果。这种行为是根据JavaBeans规范来决定的。
而Gson的序列化策略不同，它会直接遍历类中的所有属性，并将其值序列化为JSON。因此，对于以is开头的布尔类型字段，Gson会保持原有命名，不会丢失is前缀，也不会包含其他方法的结果。

综上所述，针对不同的序列化工具，它们在处理布尔类型字段时的策略是有所不同的。在进行项目开发时，我们需要根据具体需求选择合适的方式来处理布尔类型字段的命名和序列化问题。

3. 解决方案

3.1 避免使用`is`前缀（建议）

在实际开发中，尽量避免使用is作为布尔类型字段的前缀。遵循阿里开发手册的建议，采用其他命名方式来定义这些字段，从而避免命名冲突和序列化问题。

3.2 使用Boolean类型，或手动编写getter和setter方法（不建议）

为了规避上述问题，你可以使用Boolean类型来代替基本数据类型boolean。或者，你也可以手动编写getter和setter方法，遵循JavaBeans Specification，确保命名规范的一致性。

3.3 使用Gson序列化，或使用序列化别名注解（如果需要）

如果你使用的是Jackson框架，可以使用@JsonProperty注解来指定字段的序列化名字，从而避免不一致的序列化结果。例如：

@JsonProperty("isBbb")
private boolean isBbb;

//jackson序列化结果
{"isAaa":false,"color":"red","isBbb":false}

这样在使用Jackson进行序列化时，字段isBbb将会被序列化为"isBbb"。

4. 总结

处理布尔类型字段时，需要注意JavaBeans Specification对于命名规则的不同处理方式，以及不同序列化工具可能带来的影响。遵循阿里开发手册的建议，避免使用is前缀作为布尔类型字段的命名，可以有效地规避这些问题。另外，也可以使用Boolean类型或手动编写getter和setter方法来确保命名规范的一致性。如需序列化使用Gson或者框架的别名注解进行配置。