关于boolean类型isXxx的问题【2024-01-31】

1.0、见解文章：

https://blog.csdn.net/yuechuzhixing/article/details/124775266

1.1、问题来源

对于基础平台的响应体中，命名只有三个字段信息：code、msg、data，但是在响应的时候会莫名其妙出现一个ok字段。

如下是一个该问题的简单demo：

响应体：

@Data
public class R<T> {

    private int code;

    private String msg;

    private T data;

    public static <T> R<T> ok() {
        return restResult(null, 0, null);
    }

    static <T> R<T> restResult(T data, int code, String msg) {
        R<T> apiResult = new R<>();
        apiResult.setCode(code);
        apiResult.setData(data);
        apiResult.setMsg(msg);
        return apiResult;
    }

    public boolean isOk() {
        return this.code == 1;
    }

}

控制层：

@RestController
@RequestMapping("/demo")
public class Democontroller {

    @PostMapping("/test")
    public R excelTest(){
        return R.ok();
    }

}

响应：

{
    "code": 0,
    "msg": null,
    "data": null,
    "ok": false
}

1.2、问题原因

上述问题的原因是如下这个代码产生的

public boolean isOk() {
    return this.code == 1;
}

1.3、原因分析

阿里巴巴发布的java开发手册中强制规定，布尔类型的数据，无论是boolean还是Boolean都不准使用isXXX来命名，否则部分框架在解析的时候会引起序列化错误。

首先来了解一下，基础类型和包装类的getter和setter方法的命名规范（可以参照@Data自动生成）:

• 对于非boolean类型的变量，getter和setter方法的命名规范都是以get和set开头的
  参数 = xxx
  getter = getXxx
  setter = setXxx

• 对于boolean类型的变量，setter方法是以set开头，但是getter方法的命名的命名规范是以is开头
  参数 = xxx
  getter = isXxx
  setter = setXxx

• 对于包装类的变量，getter和setter方法的命名规范都是以get和set开头的
  参数 = xxx
  getter = getXxx
  setter = setXxx

再是了解一下序列化和反序列化：

序列化和反序列化是将对象转换为字节流（序列化）以及将字节流恢复为对象（反序列化）的过程。

• 序列化是指将对象转换为字节流的过程。在Java中，可以通过实现Serializable接口来标记一个类可序列化。当一个对象需要进行序列化时，它的状态信息（属性值）会被写入到字节流中，包括对象的类型、属性名和属性值等。序列化后的字节流可以保存到文件、数据库或通过网络进行传输。
• 反序列化是指将字节流恢复为对象的过程。在Java中，可以使用ObjectInputStream类来进行反序列化操作。通过读取字节流，反序列化过程会根据字节流中的信息重建出原始对象，包括对象的类型、属性名和属性值等。

在RPC框架进行远程调用的时候涉及到序列化和序列化，在反序列化的时候，当遇到boolean方法，且是isXxx前缀的，有些框架会默认解析成存在xxx属性。因此，对于boolean类型的属性值，不建议设置为is开头，否则会引起RPC框架的序列化异常。

1.4、扩展内容

关于基本数据类型与包装数据类型的使用标准：

1）【强制】所有的 Pojo 类属性必须使用包装数据类型

2）【强制】RPC方法的返回值和参数必须使用包装数据类型。

3）【强制】所有的局部变量使用基本数据类型

说明:Pojo类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE 问题，或者入库检查，都由使用者来保证。

正例:数据库的查询结果可能是 null，因为自动拆箱，用基本数据类型接收有 NPE 风险。

反例:比如显示成交总额涨跌情况，即正负x%，x为基本数据类型，调用的 RPC服务，调用不成功时，返回的是默认值，页面显示为0%，这是不合理的，应该显示成中划线。所以包装数据类型的 null值，能够表示额外的信息，如:远程调用失败，异常退出。