溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
本篇內容介紹了“為什么不使用isSuccess作為變量名”的有關知識，在實際案例的操作過程中，不少人都會遇到這樣的困境，接下來就讓小編帶領大家學習一下如何處理這些情況吧！希望大家仔細閱讀，能夠學有所成！
在日常開發中，我們會經常要在類中定義布爾類型的變量，比如在給外部系統提供一個RPC接口的時候，我們一般會定義一個字段表示本次請求是否成功的。
關于這個”本次請求是否成功”的字段的定義，其實是有很多種講究和坑的，稍有不慎就會掉入坑里，作者在很久之前就遇到過類似的問題，本文就來圍繞這個簡單分析一下。到底該如何定一個布爾類型的成員變量。
一般情況下，我們可以有以下四種方式來定義一個布爾類型的成員變量：
boolean success
boolean isSuccess
Boolean success
Boolean isSuccess以上四種定義形式，你日常開發中最常用的是哪種呢？到底哪一種才是正確的使用姿勢呢？
通過觀察我們可以發現，前兩種和后兩種的主要區別是變量的類型不同，前者使用的是boolean，后者使用的是Boolean。
另外，第一種和第三種在定義變量的時候，變量命名是success，而另外兩種使用isSuccess來命名的。
首先，我們來分析一下，到底應該是用success來命名，還是使用isSuccess更好一點。
到底應該是用success還是isSuccess來給變量命名呢？從語義上面來講，兩種命名方式都可以講的通，并且也都沒有歧義。那么還有什么原則可以參考來讓我們做選擇呢。
在阿里巴巴Java開發手冊中關于這一點，有過一個『強制性』規定：
那么，為什么會有這樣的規定呢？我們看一下POJO中布爾類型變量不同的命名有什么區別吧。
class Model1 {
private Boolean isSuccess;
public void setSuccess(Boolean success) {
isSuccess = success;
}
public Boolean getSuccess() {
return isSuccess;
}
}
class Model2 {
private Boolean success;
public Boolean getSuccess() {
return success;
}
public void setSuccess(Boolean success) {
this.success = success;
}
}
class Model3 {
private boolean isSuccess;
public boolean isSuccess() {
return isSuccess;
}
public void setSuccess(boolean success) {
isSuccess = success;
}
}
class Model4 {
private boolean success;
public boolean isSuccess() {
return success;
}
public void setSuccess(boolean success) {
this.success = success;
}
}以上代碼的setter/getter是使用Intellij IDEA自動生成的，仔細觀察以上代碼，你會發現以下規律：
基本類型自動生成的getter和setter方法，名稱都是isXXX()和setXXX()形式的。
包裝類型自動生成的getter和setter方法，名稱都是getXXX()和setXXX()形式的。
既然，我們已經達成一致共識使用基本類型boolean來定義成員變量了，那么我們再來具體看下Model3和Model4中的setter/getter有何區別。
3y：看到這里的同學可能有點懵，為啥這里說“已經達成一致共識使用基本類型boolean來定義成員變量” 。其實原作者就這篇文章寫了兩篇。至于為什么原作者贊同使用基本數據類型，可以看為什么贊同boolean使用基本數據類型。本文的后面也有相應解釋。
我們可以發現，雖然Model3和Model4中的成員變量的名稱不同，一個是success，另外一個是isSuccess，但是他們自動生成的getter和setter方法名稱都是isSuccess和setSuccess。
Java Bean中關于setter/getter的規范
關于Java Bean中的getter/setter方法的定義其實是有明確的規定的，根據JavaBeans(TM) Specification規定，如果是普通的參數，命名為propertyName，需要通過以下方式定義其setter/getter：
public <PropertyType> get<PropertyName>();
public void set<PropertyName>(<PropertyType> a);但是，布爾類型的變量propertyName則是另外一套命名原則的：
public boolean is<PropertyName>();
public void set<PropertyName>(boolean m);
通過對照這份JavaBeans規范，我們發現，在Model4中，變量名為isSuccess，如果嚴格按照規范定義的話，他的getter方法應該叫isIsSuccess。但是很多IDE都會默認生成為isSuccess。
那這樣做會帶來什么問題呢。
在一般情況下，其實是沒有影響的。但是有一種特殊情況就會有問題，那就是發生序列化的時候。
序列化帶來的影響
關于序列化和反序列化請參考Java對象的序列化與反序列化。我們這里拿比較常用的JSON序列化來舉例，看看常用的fastJson、jackson和Gson之間有何區別：
/**
* @author Hollis
*/
public class BooleanMainTest {
public static void main(String[] args) throws IOException {
//定一個Model3類型
Model3 model3 = new Model3();
model3.setSuccess(true);
//使用fastjson(1.2.16)序列化model3成字符串并輸出
System.out.println("Serializable Result With fastjson :" + JSON.toJSONString(model3));
//使用Gson(2.8.5)序列化model3成字符串并輸出
Gson gson =new Gson();
System.out.println("Serializable Result With Gson :"+gson.toJson(model3));
//使用jackson(2.9.7)序列化model3成字符串并輸出
ObjectMapper om = new ObjectMapper();
System.out.println("Serializable Result With jackson :" +om.writeValueAsString(model3));
}
}
class Model3 implements Serializable {
private static final long serialVersionUID = 1836697963736227954L;
private boolean isSuccess;
public boolean isSuccess() {
return isSuccess;
}
public void setSuccess(boolean success) {
isSuccess = success;
}
public String getHollis(){
return "hollischuang";
}
}以上代碼的Model3中，只有一個成員變量即isSuccess，三個方法，分別是IDE幫我們自動生成的isSuccess和setSuccess，另外一個是作者自己增加的一個符合getter命名規范的方法。
以上代碼輸出結果：
Serializable Result With fastjson :{"hollis":"hollischuang","success":true}
Serializable Result With Gson :{"isSuccess":true}
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:
{“hollis”:”hollischuang”,”success”:true}但是Gson并不是這么做的，他是通過反射遍歷該類中的所有屬性，并把其值序列化成json:
{“isSuccess”:true}可以看到，由于不同的序列化工具，在進行序列化的時候使用到的策略是不一樣的，所以，對于同一個類的同一個對象的序列化結果可能是不同的。
前面提到的關于對getHollis的序列化只是為了說明fastjson、jackson和Gson之間的序列化策略的不同，我們暫且把他放到一邊，我們把他從Model3中刪除后，重新執行下以上代碼，得到結果：
Serializable Result With fastjson :{"success":true}
Serializable Result WithGson :{"isSuccess":true}
Serializable Result With jackson :{"success":true}現在，不同的序列化框架得到的json內容并不相同，如果對于同一個對象，我使用fastjson進行序列化，再使用Gson反序列化會發生什么？
public class BooleanMainTest {
public static void main(String[] args) throws IOException {
Model3 model3 = new Model3();
model3.setSuccess(true);
Gson gson =new Gson();
System.out.println(gson.fromJson(JSON.toJSONString(model3),Model3.class));
}
}
class Model3 implements Serializable {
private static final long serialVersionUID = 1836697963736227954L;
private boolean isSuccess;
public boolean isSuccess() {
return isSuccess;
}
public void setSuccess(boolean success) {
isSuccess = success;
}
@Override
public String toString() {
return new StringJoiner(", ", Model3.class.getSimpleName() + "[","]")
.add("isSuccess=" + isSuccess)
.toString();
}
}以上代碼，輸出結果：
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開發手冊中這條規定的評價
所以，在定義POJO中的布爾類型的變量時，不要使用isSuccess這種形式，而要直接使用success！
前面我們介紹完了在success和isSuccess之間如何選擇，那么排除錯誤答案后，備選項還剩下：
boolean success
Boolean success那么，到底應該是用Boolean還是boolean來給定一個布爾類型的變量呢？
我們知道，boolean是基本數據類型，而Boolean是包裝類型。
那么，在定義一個成員變量的時候到底是使用包裝類型更好還是使用基本數據類型呢？
我們來看一段簡單的代碼
/**
* @author Hollis
*/
public class BooleanMainTest {
public static void main(String[] args) {
Model model1 = new Model();
System.out.println("default model : " + model1);
}
}
class Model {
/**
* 定一個Boolean類型的success成員變量
*/
private Boolean success;
/**
* 定一個boolean類型的failure成員變量
*/
private boolean failure;
/**
* 覆蓋toString方法，使用Java 8 的StringJoiner
*/
@Override
public String toString() {
return new StringJoiner(", ", Model.class.getSimpleName() + "[","]")
.add("success=" + success)
.add("failure=" + failure)
.toString();
}
}以上代碼輸出結果為：
default model : Model[success=null, failure=false]
可以看到，當我們沒有設置Model對象的字段的值的時候，Boolean類型的變量會設置默認值為null，而boolean類型的變量會設置默認值為false。
即對象的默認值是null，boolean基本數據類型的默認值是false。
在阿里巴巴Java開發手冊中，對于POJO中如何選擇變量的類型也有著一些規定：
這里建議我們使用包裝類型，原因是什么呢？
舉一個扣費的例子，我們做一個扣費系統，扣費時需要從外部的定價系統中讀取一個費率的值，我們預期該接口的返回值中會包含一個浮點型的費率字段。當我們取到這個值得時候就使用公式：金額*費率=費用 進行計算，計算結果進行劃扣。
如果由于計費系統異常，他可能會返回個默認值，如果這個字段是Double類型的話，該默認值為null，如果該字段是double類型的話，該默認值為0.0。
如果扣費系統對于該費率返回值沒做特殊處理的話，拿到null值進行計算會直接報錯，阻斷程序。拿到0.0可能就直接進行計算，得出接口為0后進行扣費了。這種異常情況就無法被感知。
這種使用包裝類型定義變量的方式，通過異常來阻斷程序，進而可以被識別到這種線上問題。如果使用基本數據類型的話，系統可能不會報錯，進而認為無異常。
“為什么不使用isSuccess作為變量名”的內容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站，小編將為大家輸出更多高質量的實用文章！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
