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

浅浅的花香味﹌ 2022-12-23 13:30 77阅读 0赞

java中，对于非boolean类型的参数，getter和setter方法命名的规范是以get和set开头，如下：

private String Success;
    
    
    public String getSuccess() {
    
    return Success;
    
    }
    
    
    public void setSuccess(String success) {
    
    Success = success;
    
    }

而对于boolean类型的参数，setter方法是以set开头，但是getter方法命名的规范是以is开头，如下：

private boolean Success;
    
    
    public boolean isSuccess() {
    
    return Success;
    
    }
    
    
    public void setSuccess(boolean success) {
    
    Success = success;
    
    }

以上的方式都是正常的。

但是，如果我们将属性值定义为isSuccess，再来看看生成的getter和settter方法，如下：

private boolean isSuccess;
    
    
    public boolean isSuccess() {
    
    return isSuccess;
    
    }
    
    
    public void setSuccess(boolean success) {
    
    isSuccess = success;
    
    }

这种方式在某些时候是可以正常运行的，但是在一些rpc框架里面，当反向解析读取到isSuccess()方法的时候，rpc框架会“以为”其对应的属性值是success，而实际上其对应的属性值是isSuccess，导致属性值获取不到，从而抛出异常。

如果我有两个boolean值变量，一个是success，一个是isSuccess会怎么样呢？ 用IDEA自动生成getter setter方法后结果是下面这样，更加混乱了。

private Boolean isSuccess;
    
        private Boolean success;
    
        public Boolean getSuccess() {
            return isSuccess;
        }
    
        public void setSuccess(Boolean success) {
            isSuccess = success;
        }

![20190121091640997.png][]

这个时候，我就好奇了，如果我强行写成getSuccess()的方式，会不会正常获取到Success属性值呢？，经过测试，发现是可以的。

那如果我两个方法都写了，结果是怎样的呢？

private boolean Success;
    
    
    public boolean isSuccess() {
    
    return Success;
    
    }
    
    
    public boolean getSuccess() {
    
    return Success;
    
    }
    
    
    public void setSuccess(boolean success) {
    
    Success = success;
    
    }

结果是：只会走getSuccess()方式获取属性值。

总结：

1、boolean类型的属性值不建议设置为is开头，否则会引起rpc框架的序列化异常。

2、如果强行将IDE自动生成的isSuccess()方法修改成getSuccess()，也能获取到Success属性值，若两者并存，则之后通过getSuccess()方法获取Success属性值。

[20190121091640997.png]: /images/20221120/c0a5b411be9841d08d45264fe5ce00eb.png