阿里规范：为什么boolean类型变量命名禁用is开头

欢迎你们关注 github.com/hsfxuebao/j… ，但愿对你们有所帮助，要是以为能够的话麻烦给点一下Star哈

转自：www.cnblogs.com/Zzwena/p/13…

一般定义Java实体类时，对于boolean属性，阿里规约中明确要求不能使用is开头。

至于为何，咱们稍后再讲。

这里先讲一下前几天在工做中，项目遇到的一个问题。库表中某个字段存入了一个实体类的json字符串，在查询库表后，须要将json字符串转为实体类对象进行更改后再转为json字符串后返回给前端。

在这当中就出现了一个问题，库表中存入的数据明明是isUpdate的字段，但是在返回到前端后的代码就是update。
这个问题，起初并无想到是字段定义的问题，经过一步一步的debug，最后才发现是实体类中isUpdate字段的问题，在经过json解析后就转成了update返回给了前端。

下面讲一下，为何会出现isUpdate变成update的问题。

首先，咱们先定义一个Java实体类，包含一个is开头的属性，如isSuccess，再使用idea自动生成的get/set，看看是什么样子。

public class IsEntity1 {

    private boolean isSuccess;   
    
    public boolean isSuccess() {
    	return isSuccess;        
    }  
    
    public void setSuccess(boolean success) {
    	isSuccess = success;        
    }   
    
}
复制代码

而后再定义一个Java实体类，不是用is开头的属性，如success，再使用idea自动生成的get/set，看看是什么样子。

public class IsEntity2 {

    private boolean success;

    public boolean isSuccess() {
        return success;
    }

    public void setSuccess(boolean success) {
        this.success = success;
    }
    
}
复制代码

此时，会发现不管你是用is开头或者不用is开头定义属性，使用idea自动生成的get/set都是一个样子的，并且在setSuccess的时候，会将is省略掉。这里就是项目中遇到的问题所在。

由于当类进行序列化时，有些框架的序列化会根据JavaBean的属性进行序列化，而部分框架是根据JavaBean的getter方法进行序列化，这就会致使在反序列化时与实体类的属性对应不上。

好比说将IsEntity1转换为json字符串时，会根据实体类中的get方法进行序列化取isSuccess的值，而使用idea自动生成的get方法直接就是public boolean isSuccess()方法，在取值的时候会认定success是字段名，就会取成success，与原来定义的字段不一样。

若是非要使用is开头来定义字段，怎么才能保证json解析过程是正确的呢

答案是本身写get方法，不用idea自动生成的get方法。

以下：

public boolean getIsSuccess() {
	return isSuccess;
}
复制代码

这样，再将实体类转为json字符串时，就会认定isSuccess是字段名。

还有一种方法，就是使用JSONField注解

@JSONField(name = "isSuccess")
    private boolean isSuccess;
复制代码

虽然这些方法均可以解决json解析过程丢失is的问题，可是为了不出现这种问题，咱们最好仍是遵照规约，不使用is开头定义字段。

分析：

申明属性，而后用idea自带的Generator生成getter，setter（封装类型和基本数据类型生成的还不同），以下：

当我去构造一个PropertyDescriptor时，会报错

后来跟代码，发现，报错缘由是PropertyDescriptor的构造函数去找一个叫setIsSuccess的写值函数时，发现找不到，因而报错了。

从上图能够看到，实际在构造PropertyDescriptor时，它会尝试去寻找一个叫isIsSuccess的读函数，一个叫setIsSuccess的写函数。当isIsSuccess没找到时，它会尝试去找叫getIsSuccess的读函数，若是仍是没找到，则抛出异常。当setIsSuccess没找到时，也会抛出异常。

试了一下发现，用idea自动生成getter，setter只有在使用is打头的boolean时有这个问题（封装类型和基本数据类型都有问题），其余数据类型没有这个问题。

这方面的问题有时还涉及到json转换，因此在处理布尔类型数据时，又用is打头来命名时，不要使用idea自动生成getter和setter。另外，行业里好像比较合理的作法是禁止Bean里用is打头申明boolean类型的变量。