1.问题说明
application.yml配置文件里的布尔值获取后一直为false。
2.bug复现
2.1 yml配置
# 测试 test-config: is: true open: true isOpen: true
2.2 配置类
@Data @Component @ConfigurationProperties(TestConfiguration.PREFIX) public class TestConfiguration { public static final String PREFIX = "test-config"; /** * 参数key为is的boolean值 */ public boolean is; /** * 参数key为open的boolean值 */ public boolean open; /** * 参数key为isOpen的boolean值 */ public boolean isOpen; }
2.3 测试类
@Component @Slf4j public class TestManager { @Autowired private TestConfiguration testConfiguration; @PostConstruct public void init() { boolean is = testConfiguration.is; boolean open = testConfiguration.open; boolean isOpen = testConfiguration.isOpen; log.info("is[{}];open[{}];isOpen[{}]", is, open, isOpen); } }
2.4 结果输出
17:07:25.804 [restartedMain] INFO x.x.x.x.x.TestManager - [init,28] - is[true];open[true];isOpen[false]
3.源码分析
3.1 @Data
阿里巴巴的《Java开发手册》有这么一条规则：【强制】POJO 类中的任何布尔类型的变量，都不要加 is 前缀，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时候，“误以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。
由于TestConfiguration类使用了lombok的@Data这里贴出编译结果【为了简洁这里删除了重写的hashCode()和equals()及相关的方法】：
@Component @ConfigurationProperties("test-config") public class TestConfiguration { public static final String PREFIX = "test-config"; public boolean is; public boolean open; public boolean isOpen; public TestConfiguration() { } public boolean isIs() { return this.is; } public boolean isOpen() { return this.open; } public void setIs(final boolean is) { this.is = is; } public void setOpen(final boolean open) { this.open = open; } public String toString() { return "TestConfiguration(is=" + this.isIs() + ", open=" + this.isOpen() + ", isOpen=" + this.isOpen() + ")"; } }
查看源码后我们可以发现以下问题：
- open的get方法是isOpen()。
- isOpen属性根本就没有被赋值。
- isOpen的属性值等于open的值。
这里修改open的值进行验证：
# 测试 test-config: is: true open: false isOpen: true
17:34:46.783 [restartedMain] INFO c.x.d.g.m.TestManager - [init,28] - is[true];open[false];isOpen[false]
3.2 Generate Getters and Setters
神奇的是，自动生成的get和set方法也只给is和open进行了赋值和获取：
public boolean isIs() { return is; } public void setIs(boolean is) { this.is = is; } public boolean isOpen() { return open; } public void setOpen(boolean open) { this.open = open; }
直接测试，isOpen的值果不其然就是false。
4.问题解决
4.1 修改参数名称
不使用isXXX这样的参数名称。
4.2 添加Getter和Setter方法
public boolean isIsOpen() { return isOpen; } public void setIsOpen(boolean isOpen) { this.isOpen = isOpen; }
重新测试：
# 测试 test-config: is: false open: false isOpen: true
结果：
17:46:29.591 [restartedMain] INFO c.x.d.g.m.TestManager - [init,28] - is[false];open[false];isOpen[true]
