为什么阿里强制 boolean 类型变量不能使用 is 开头?你造吗

为什么阿里强制 boolean 类型变量不能使用 is 开头?你造吗

背景

平时工作中大家经常使用到boolean以及Boolean类型的数据,前者是基本数据类型,后者是包装类,为什么不推荐使用isXXX来命名呢?到底是用基本类型的数据好呢还是用包装类好呢?

例子

1.其他非boolean类型
    private String isHot;
    public String getIsHot() {
        return isHot;
    }
2.boolean类型
    private boolean isHot;
    public boolean isHot() {
        return isHot;
    }
3.包装类型
    private Boolean isHot;
    public Boolean getHot() {
        return isHot;
    }
4.不以is开头
    private boolean hot;
    public boolean isHot() {
        return hot;
    }
5.包装类型
    private Boolean hot;
    public Boolean getHot() {
        return hot;
    }    

其实阿里巴巴发布的java开发手册中就写明了,强制规定,布尔类型的数据,无论是boolean还是Boolean都不准使用isXXX来命名

为什么阿里强制 boolean 类型变量不能使用 is 开头?你造吗

  • 对于非boolean类型的参数,getter和setter方法命名的规范是以get和set开头
  • 对于boolean类型的参数,setter方法是以set开头,但是getter方法命名的规范是以is开头
  • 包装类自动生成的getter和setter方法的名称都是getXXX()setXXX()

1.其实javaBeans规范中对这些均有相应的规定,基本数据类型的属性,其getter和setter方法是getXXX()setXXX,但是对于基本数据中布尔类型的数据,又有一套规定,其getter和setter方法是isXXX()setXXX。但是包装类型都是以get开头

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

总结

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

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

工作中使用基本类型的数据好还是包装类好

咱们举个例子,一个计算盈利的系统,其盈利比例有正有负,若使用了基本类型bouble定义了数据,当RPC调用时,若出现了问题,本来应该返回错误的,但是由于使用了基本类型,返回了0.0,系统会认为没有任何问题,今年收支平衡,而不会发现其实是出现了错误。

若使用了包装数据类型Double,当RPC调用失败时,会返回null,这样直接就能看到出现问题了,而不会因为默认值的问题影响判断。

其实阿里java开发手册中对于这个也有强制规定:

为什么阿里强制 boolean 类型变量不能使用 is 开头?你造吗

因此,这里建议大家POJO中使用包装数据类型,局部变量使用基本数据类型。

你真的会使用“布尔类型(Boolean)”么?

布尔型(Boolean)是一种数据的类型,这种类型只有两种值,即"真"与"假"。但你真的会使用么?

本文列举了布尔型的常见错误用法,以及在ABAP语言中使用布尔型的一些最佳实践。

1. 典型的误区

1.1 用布尔型声明状态

要点1: 布尔类型不是一种“类型代码”。布尔型是“逻辑运算”的结果类型。

在编程中,我们会直觉地将一些变量声明成布尔型,例如男性/女性, 国内/国外, 看起来这些状态有且仅有2个状态。

data(is_male) = abap_ture. 

这是一个典型的误区, 因为使用布尔类型指示状态经常被一些特殊场景打脸(如下例),迫使我们不得不改用其它类型,例如枚举类型。

lv_gender = gs_gender=>male.
lv_gender = gs_gender=>female.
lv_gender = gs_gender=>unkonwn.
lv_gender = gs_gender=>not_applicable.
lv_gender = gs_gender=>answer_refused.

解决上述尴尬场景的方法很简单,使用状态变量标识“状态”,让布尔型回归“逻辑运算”,使用is_male( ), is_female( )等方法来返回逻辑运算结果。

METHOD is_male.
 IF mv_state = gs_gender=>male.
    rv_yes = abap_true.
 ELSE.
    rv_yes = abap_false.
 ENDIF.
ENDMETHOD.

1.2 在API中使用布尔型控制行为

要点2:遵循“单一职责”原则,一个API仅负责一个职责。

有时为了功能的扩展,我们经常尝试使用一些布尔类型的变量来控制一个API的行为,如下例:

METHOD dosomething.
 " setup
 " ...

 " algorithm 
 IF iv_flag = abap_true.
    " path A
 ELSE.
    " path B
 ENDIF.

  " cleanup
  " ...
ENDMETHOD.

然而,这样的API设计会直接降低代码的可读性,同时强化了不同逻辑间的耦合关系。

调用方在使用API时,不得不去了解这个布尔型变量的含义,同时运维的同事在阅读代码时,也不得不去猜测这个布尔型变量的含义。

  " what's the difference ?
  mo_document->create_file(filename, filecontent, true);

  mo_document->create_file(filename, filecontent, false);

如果一个API有两种职责,那么应当拆分成两个不同的API, 方法名称要有明确的含义.

  " split to different APIs
  mo_document->create_file(filename, filecontent);
  
  mo_document->create_temp_file(filename, filecontent);

2. ABAP语言中,布尔类型的使用规范

2.1 使用ABAP_BOOL声明布尔变量

对于布尔类型的运行变量,不要使用generic的类型,而是要明确地使用abap_bool。

" bad
DATA lv_has_entries TYPE CHAR1. 

" good
DATA lv_has_entries type abap_bool.

2.2 使用ABAP_TRUE和ABAP_FALSE

逻辑表达式中,不要使用’X’ , ’ ', space来进行比较,而是更直接地使用ABAP_TRUE和ABAP_FALSE。

" bad
lv_has_entries = 'X'.

IF lv_has_entries = ''.

ENDIF.
" good
lv_has_entries = abap_true.

IF has_entries = abap_false.

ENDIF.

2.3使用XSDBOOL来赋值布尔类型

XSDBOOL( log_exp )会判断一个逻辑表达式,并直接返回一个type XSDBOOLEAN 类型的变量,无任何歧义, 并且更加简洁。

" bad
IF lt_lines IS INITIAL.
  lv_has_entries = abap_false.
ELSE.
  lv_has_entries = abap_true.
ENDIF.
" good
DATA(has_entries) = xsdbool( lt_lines IS NOT INITIAL ).

2.4 数据元素BOOLE_D和XFELD

如果是数据字典中需要使用到布尔类型,我们可遵循下面的原则:

  • 如果xml/json转换为xsd时需要布尔类型,此时可用数据元素xsdboolean (data element)或xsdboolean (domain)
  • 其他情况,在数据字典中则可直接使用数据元素boole_d或xfeld,或定义你自己的布尔类型数据元素
发表评论
留言与评论(共有 0 条评论) “”
   
验证码:

相关文章

推荐文章