歡迎光臨
每天分享高質量文章

為什麼阿裡巴巴禁止開發人員使用isSuccess作為變數名

在日常開發中,我們會經常要在類中定義布爾型別的變數,比如在給外部系統提供一個RPC接口的時候,我們一般會定義一個欄位表示本次請求是否成功的。

關於這個”本次請求是否成功”的欄位的定義,其實是有很多種講究和坑的,稍有不慎就會掉入坑裡,作者在很久之前就遇到過類似的問題,本文就來圍繞這個簡單分析一下。到底該如何定一個布爾型別的成員變數。

一般情況下,我們可以有以下四種方式來定義一個布爾型別的成員變數:

  1. boolean success
  2. boolean isSuccess
  3. Boolean success
  4. Boolean isSuccess

以上四種定義形式,你日常開發中最常用的是哪種呢?到底哪一種才是正確的使用姿勢呢?

通過觀察我們可以發現,前兩種和後兩種的主要區別是變數的型別不同,前者使用的是boolean,後者使用的是Boolean。

另外,第一種和第三種在定義變數的時候,變數命名是success,而另外兩種使用isSuccess來命名的。

首先,我們來分析一下,到底應該是用Boolean來定義,還是使用boolean更好一點。

Boolean還是boolean?

我們知道,boolean是基本資料型別,而Boolean是包裝型別。

那麼,在定義一個成員變數的時候到底是使用包裝型別更好還是使用基本資料型別呢?

我們來看一段簡單的代碼

  1. /**
  2. * @author Hollis
  3. */ public class BooleanMainTest {
  4.    public static void main(String[] args) {
  5.        Model model1 = new Model();
  6.        System.out.println("default model : " + model1);
  7.    }
  8. }
  9. class Model {
  10.    /**
  11.     * 定一個Boolean型別的success成員變數
  12.     */
  13.    private Boolean success;
  14.    /**
  15.     * 定一個boolean型別的failure成員變數
  16.     */
  17.    private boolean failure;
  18.    /**
  19.     * 改寫toString方法,使用Java 8 的StringJoiner
  20.     */
  21.    @Override
  22.    public String toString() {
  23.        return new StringJoiner(", ", Model.class.getSimpleName() + "[","]")
  24.            .add("success=" + success)
  25.            .add("failure=" + failure)
  26.            .toString();
  27.    }
  28. }

以上代碼輸出結果為:

  1. default model : Model[success=null, failure=false]

可以看到,當我們沒有設置Model物件的欄位的值的時候,Boolean型別的變數會設置預設值為 null,而boolean型別的變數會設置預設值為 false

即物件的預設值是 null,boolean基本資料型別的預設值是 false

我建議,在代碼中,儘量避免出現和處理null。

null何罪之有?

null是很模棱兩可的,很多時候會導致令人疑惑的錯誤,很難去判斷傳回一個 null代表著什麼意思。

圖靈獎得主Tony Hoare 曾經公開表達過 null是一個糟糕的設計。

我把 null 取用稱為自己的十億美元錯誤。它的發明是在1965 年,那時我用一個面向物件語言( ALGOL W )設計了第一個全面的取用型別系統。我的目的是確保所有取用的使用都是絕對安全的,編譯器會自動進行檢查。但是我未能抵禦住誘惑,加入了Null取用,僅僅是因為實現起來非常容易。它導致了數不清的錯誤、漏洞和系統崩潰,可能在之後 40 年中造成了十億美元的損失。

當我們在設計一個接口的時候,對於接口的傳回值的定義,儘量避免使用Boolean型別來定義。大多數情況下,別人使用我們的接口傳回值時可能用 if(response.isSuccess){}else{}的方式,如果我們由於忽略沒有設置 success欄位的值,就可能導致NPE,這明顯是我們不希望看到的。

所以,當我們要定義一個布爾型別的成員變數時,儘量選擇boolean,而不是Boolean。當然,編程中並沒有絕對。

success 還是 isSuccess

前面我們介紹完了在boolean和Boolean之間如何選擇,那麼排除錯誤答案後,備選項還剩下:

  1. boolean success
  2. boolean isSuccess

那麼,到底應該是用success還是isSuccess來給變數命名呢。

從語意上面來講,兩種命名方式都可以講的通,並且也都沒有歧義。那麼還有什麼原則可以參考來讓我們做選擇呢。

在阿裡巴巴Java開發手冊中關於這一點,有過一個『強制性』規定:

那麼,為什麼會有這樣的規定呢?我們看一下POJO中布爾型別變數不同的命名有什麼區別吧。

  1. class Model1  {
  2.    private Boolean isSuccess;
  3.    public void setSuccess(Boolean success) {
  4.        isSuccess = success;
  5.    }
  6.    public Boolean getSuccess() {
  7.        return isSuccess;
  8.    }
  9. }
  10. class Model2 {
  11.    private Boolean success;
  12.    public Boolean getSuccess() {
  13.        return success;
  14.    }
  15.    public void setSuccess(Boolean success) {
  16.        this.success = success;
  17.    }
  18. }
  19. class Model3 {
  20.    private boolean isSuccess;
  21.    public boolean isSuccess() {
  22.        return isSuccess;
  23.    }
  24.    public void setSuccess(boolean success) {
  25.        isSuccess = success;
  26.    }
  27. }
  28. class Model4 {
  29.    private boolean success;
  30.    public boolean isSuccess() {
  31.        return success;
  32.    }
  33.    public void setSuccess(boolean success) {
  34.        this.success = success;
  35.    }
  36. }

以上代碼的setter/getter是使用Intellij IDEA自動生成的,仔細觀察以上代碼,你會發現以下規律:

  • 基本型別自動生成的getter和setter方法,名稱都是 isXXX()和 setXXX()形式的。
  • 包裝型別自動生成的getter和setter方法,名稱都是 getXXX()和 setXXX()形式的。

既然,我們已經達成一致共識使用基本型別boolean來定義成員變數了,那麼我們再來具體看下Model3和Model4中的setter/getter有何區別。

我們可以發現,雖然Model3和Model4中的成員變數的名稱不同,一個是success,另外一個是isSuccess,但是他們自動生成的getter和setter方法名稱都是 isSuccess和 setSuccess

Java Bean中關於setter/getter的規範

關於Java Bean中的getter/setter方法的定義其實是有明確的規定的,根據JavaBeans(TM) Specification規定,如果是普通的引數,命名為propertyName,需要通過以下方式定義其setter/getter:

  1. public <PropertyType> get<PropertyName>();
  2. public void set<PropertyName>(<PropertyType> a);

但是,布爾型別的變數propertyName則是另外一套命名原則的:

  1. public boolean is<PropertyName>();
  2. public void set<PropertyName>(boolean m);

通過對照這份JavaBeans規範,我們發現,在Model4中,變數名為isSuccess,如果嚴格按照規範定義的話,他的getter方法應該叫isIsSuccess。但是很多IDE都會預設生成為isSuccess。

那這樣做會帶來什麼問題呢。

在一般情況下,其實是沒有影響的。但是有一種特殊情況就會有問題,那就是發生序列化的時候。

序列化帶來的影響

關於序列化和反序列化請參考Java物件的序列化與反序列化。我們這裡拿比較常用的JSON序列化來舉例,看看常用的fastJson、jackson和Gson之間有何區別:

  1. public class BooleanMainTest {
  2.    public static void main(String[] args) throws IOException {
  3.        //定一個Model3型別
  4.        Model3 model3 = new Model3();
  5.        model3.setSuccess(true);
  6.        //使用fastjson(1.2.16)序列化model3成字串並輸出
  7.        System.out.println("Serializable Result With fastjson :" + JSON.toJSONString(model3));
  8.        //使用Gson(2.8.5)序列化model3成字串並輸出
  9.        Gson gson =new Gson();
  10.        System.out.println("Serializable Result With Gson :"+gson.toJson(model3));
  11.        //使用jackson(2.9.7)序列化model3成字串並輸出
  12.        ObjectMapper om = new ObjectMapper();
  13.        System.out.println("Serializable Result With jackson :" +om.writeValueAsString(model3));
  14.    }
  15. }
  16. class Model3 implements Serializable {
  17.    private static final long serialVersionUID = 1836697963736227954L;
  18.    private boolean isSuccess;
  19.    public boolean isSuccess() {
  20.        return isSuccess;
  21.    }
  22.    public void setSuccess(boolean success) {
  23.        isSuccess = success;
  24.    }
  25.    public String getHollis(){
  26.        return "hollischuang";
  27.    }
  28. }

以上代碼的Model3中,只有一個成員變數即isSuccess,三個方法,分別是IDE幫我們自動生成的isSuccess和setSuccess,另外一個是作者自己增加的一個符合getter命名規範的方法。

以上代碼輸出結果:

  1. Serializable Result With fastjson :{"hollis":"hollischuang","success":true}
  2. Serializable Result With Gson :{"isSuccess":true}
  3. Serializable Result With jackson :{"success":true,"hollis":"hollischuang"}

在fastjson和jackson的結果中,原來類中的isSuccess欄位被序列化成success,並且其中還包含hollis值。而Gson中只有isSuccess欄位。

我們可以得出結論:fastjson和jackson在把物件序列化成json字串的時候,是通過反射遍歷出該類中的所有getter方法,得到getHollis和isSuccess,然後根據JavaBeans規則,他會認為這是兩個屬性hollis和success的值。直接序列化成json:

  1. {“hollis”:”hollischuang”,”success”:true}

但是Gson並不是這麼做的,他是通過反射遍歷該類中的所有屬性,並把其值序列化成json:

  1. {“isSuccess”:true}

可以看到,由於不同的序列化工具,在進行序列化的時候使用到的策略是不一樣的,所以,對於同一個類的同一個物件的序列化結果可能是不同的。

前面提到的關於對getHollis的序列化只是為了說明fastjson、jackson和Gson之間的序列化策略的不同,我們暫且把他放到一邊,我們把他從Model3中刪除後,重新執行下以上代碼,得到結果:

  1. Serializable Result With fastjson :{"success":true}
  2. Serializable Result WithGson :{"isSuccess":true}
  3. Serializable Result With jackson :{"success":true}

現在,不同的序列化框架得到的json內容並不相同,如果對於同一個物件,我使用fastjson進行序列化,再使用Gson反序列化會發生什麼?

  1. public class BooleanMainTest {
  2.    public static void main(String[] args) throws IOException {
  3.        Model3 model3 = new Model3();
  4.        model3.setSuccess(true);
  5.        Gson gson =new Gson();
  6.        System.out.println(gson.fromJson(JSON.toJSONString(model3),Model3.class));
  7.    }
  8. }
  9. class Model3 implements Serializable {
  10.    private static final long serialVersionUID = 1836697963736227954L;
  11.    private boolean isSuccess;
  12.    public boolean isSuccess() {
  13.        return isSuccess;
  14.    }
  15.    public void setSuccess(boolean success) {
  16.        isSuccess = success;
  17.    }
  18.    @Override
  19.    public String toString() {
  20.        return new StringJoiner(", ", Model3.class.getSimpleName() + "[","]")
  21.            .add("isSuccess=" + isSuccess)
  22.            .toString();
  23.    }
  24. }

以上代碼,輸出結果:

  1. Model3[isSuccess=false]

這和我們預期的結果完全相反,原因是因為JSON框架通過掃描所有的getter後發現有一個isSuccess方法,然後根據JavaBeans的規範,解析出變數名為success,把model物件序列化城字串後內容為 {"success":true}

根據 {"success":true}這個json串,Gson框架在通過解析後,通過反射尋找Model類中的success屬性,但是Model類中只有isSuccess屬性,所以,最終反序列化後的Model類的物件中,isSuccess則會使用預設值false。

但是,一旦以上代碼發生在生產環境,這絕對是一個致命的問題。

所以,作為開發者,我們應該想辦法儘量避免這種問題的發生,對於POJO的設計者來說,只需要做簡單的一件事就可以解決這個問題了,那就是把isSuccess改為success。

這樣,該類裡面的成員變數時success,getter方法是isSuccess,這是完全符合JavaBeans規範的。無論哪種序列化框架,執行結果都一樣。就從源頭避免了這個問題。

取用一下R大關於阿裡巴巴Java開發手冊中這條規定的評價

(https://www.zhihu.com/question/55642203):

所以,在定義POJO中的布爾型別的變數時,不要使用isSuccess這種形式,而要直接使用success!

總結

本文圍繞布爾型別的變數定義的型別和命名展開了介紹,最終我們可以得出結論,在定義一個布爾型別的變數,尤其是一個給外部提供的接口傳回值時,要使用 booleansuccess來定義:

  1. public class BaseResponse implements Serializable {
  2.    private boolean success;
  3.    private String errorCode;
  4.    private String errorMessage;
  5. }

好啦,以上就是關於POJO中布爾型別變數的正確定義姿勢。你用對了麽?

赞(0)

分享創造快樂