阿里规范:为何boolean类型变量命名禁用is开头

11,748 阅读4分钟

欢迎大家关注 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类型的变量。