OOP規約

1.【強制】避免通過一個類的對象引用通路通路此類的靜态變量或靜态方法，無謂的增加編譯器的解析成本，直接用類名來通路即可。

2. 【強制】所有的覆寫方法，必須加@Override 注解。

說明：getObject()與 get0bject()的問題。一個是字母的 O，一個是數字的 0，加@Override可以準确判斷是否覆寫成功。另外，如果在抽象類中對方法簽名進行修改，其實作類會馬上編譯報錯。

3.【強制】相同參數類型，相同業務含義，才可以使用 Java 的可變參數，避免使用 Object。說明：可變參數必須放置在參數清單的最後。（提倡同學們盡量不用可變參數程式設計）正例：public List<User> listUsers(String type, Long... ids) {...}

4.【強制】外部正在調用或者二方庫依賴的接口，不允許修改方法簽名，避免對接口調用方産生影響。接口過時必須加@Deprecated 注解，并清晰地說明采用的新接口或者新服務是什麼。

5.【強制】不能使用過時的類或方法。

說明：java.net.URLDecoder 中的方法 decode(String encodeStr) 這個方法已經過時，應該使用雙參數 decode(String source, String encode)。接口提供方既然明确是過時接口，那麼有義務同時提供新的接口；作為調用方來說，有義務去考證過時方法的新實作是什麼。

6.【強制】Object 的 equals 方法容易抛空指針異常，應使用常量或确定有值的對象來調用equals。

正例："test".equals(object);

反例：object.equals("test");

說明：推薦使用 java.util.Objects#equals（JDK7 引入的工具類）

7.【強制】所有的相同類型的包裝類對象之間值的比較，全部使用 equals 方法比較。

說明：對于 Integer var = ? 在-128 至 127 範圍内的指派，Integer 對象是在IntegerCache.cache 産生，會複用已有對象，這個區間内的 Integer 值可以直接使用==進行判斷，但是這個區間之外的所有資料，都會在堆上産生，并不會複用已有對象，這是一個大坑，推薦使用 equals 方法進行判斷

8.關于基本資料類型與包裝資料類型的使用标準如下：

1） 【強制】所有的 POJO 類屬性必須使用包裝資料類型。

2） 【強制】RPC 方法的傳回值和參數必須使用包裝資料類型。

3） 【推薦】所有的局部變量使用基本資料類型。

說明：POJO 類屬性沒有初值是提醒使用者在需要使用時，必須自己顯式地進行指派，任何NPE 問題，或者入庫檢查，都由使用者來保證。

正例：資料庫的查詢結果可能是 null，因為自動拆箱，用基本資料類型接收有 NPE 風險。

反例：比如顯示成交總額漲跌情況，即正負 x%，x 為基本資料類型，調用的 RPC 服務，調用不成功時，傳回的是預設值，頁面顯示為 0%，這是不合理的，應該顯示成中劃線。是以包裝資料類型的 null 值，能夠表示額外的資訊，如：遠端調用失敗，異常退出。

9. 【強制】定義 DO/DTO/VO 等 POJO 類時，不要設定任何屬性預設值。

反例：POJO 類的 gmtCreate 預設值為 new Date()，但是這個屬性在資料提取時并沒有置入具體值，在更新其它字段時又附帶更新了此字段，導緻建立時間被修改成目前時間。

10. 【強制】序列化類新增屬性時，請不要修改 serialVersionUID 字段，避免反序列失敗；如果完全不相容更新，避免反序列化混亂，那麼請修改 serialVersionUID 值。

說明：注意 serialVersionUID 不一緻會抛出序列化運作時異常。

11. 【強制】構造方法裡面禁止加入任何業務邏輯，如果有初始化邏輯，請放在 init 方法中。

12. 【強制】POJO 類必須寫 toString 方法。使用 IDE 中的工具：source> generate toString時，如果繼承了另一個 POJO 類，注意在前面加一下 super.toString。

說明：在方法執行抛出異常時，可以直接調用 POJO 的 toString()方法列印其屬性值，便于排查問題。

13. 【強制】禁止在 POJO 類中，同時存在對應屬性 xxx 的 isXxx()和 getXxx()方法。

說明：架構在調用屬性 xxx 的提取方法時，并不能确定哪個方法一定是被優先調用到。

14. 【推薦】使用索引通路用 String 的 split 方法得到的數組時，需做最後一個分隔符後有無

内容的檢查，否則會有抛 IndexOutOfBoundsException 的風險。

說明：

String str = "a,b,c,,"; 

String[] ary = str.split(","); 

// 預期大于 3，結果是 3

System.out.println(ary.length); 

15. 【推薦】當一個類有多個構造方法，或者多個同名方法，這些方法應該按順序放置在一起，

便于閱讀，此條規則優先于第 16 條規則。

16. 【推薦】 類内方法定義的順序依次是：公有方法或保護方法 > 私有方法 > getter/setter

方法。

說明：公有方法是類的調用者和維護者最關心的方法，首屏展示最好；保護方法雖然隻是子類

關心，也可能是“模闆設計模式”下的核心方法；而私有方法外部一般不需要特别關心，是一個

黑盒實作；因為承載的資訊價值較低，所有 Service 和 DAO 的 getter/setter 方法放在類體

最後。

17. 【推薦】setter 方法中，參數名稱與類成員變量名稱一緻，this.成員名 = 參數名。在

getter/setter 方法中，不要增加業務邏輯，增加排查問題的難度。

反例：

public Integer getData() { 

if (condition) { 

return this.data + 100; 

} else {

return this.data - 100;

} 

} 

18. 【推薦】循環體内，字元串的連接配接方式，使用 StringBuilder 的 append 方法進行擴充。

說明：下例中，反編譯出的位元組碼檔案顯示每次循環都會 new 出一個 StringBuilder 對象，

然後進行 append 操作，最後通過 toString 方法傳回 String 對象，造成記憶體資源浪費。

反例：

String str = "start"; 

for (int i = 0; i < 100; i++) { 

str = str + "hello"; 

} 

19. 【推薦】final 可以聲明類、成員變量、方法、以及本地變量，下列情況使用 final 關鍵字：

1） 不允許被繼承的類，如：String 類。

2） 不允許修改引用的域對象。

3） 不允許被重寫的方法，如：POJO 類的 setter 方法。

4） 不允許運作過程中重新指派的局部變量。

5） 避免上下文重複使用一個變量，使用 final 描述可以強制重新定義一個變量，友善更好

地進行重構。

20. 【推薦】慎用 Object 的 clone 方法來拷貝對象。

說明：對象的 clone 方法預設是淺拷貝，若想實作深拷貝需要重寫 clone 方法實作域對象的

深度周遊式拷貝。

21. 【推薦】類成員與方法通路控制從嚴：

1） 如果不允許外部直接通過 new 來建立對象，那麼構造方法必須是 private。

2） 工具類不允許有 public 或 default 構造方法。

3） 類非 static 成員變量并且與子類共享，必須是 protected。

4） 類非 static 成員變量并且僅在本類使用，必須是 private。

5） 類 static 成員變量如果僅在本類使用，必須是 private。

6） 若是 static 成員變量，考慮是否為 final。

7） 類成員方法隻供類内部調用，必須是 private。

8） 類成員方法隻對繼承類公開，那麼限制為 protected。

說明：任何類、方法、參數、變量，嚴控通路範圍。過于寬泛的通路範圍，不利于子產品解耦。

思考：如果是一個 private 的方法，想删除就删除，可是一個 public 的 service 成員方法或

成員變量，删除一下，不得手心冒點汗嗎？變量像自己的小孩，盡量在自己的視線内，變量作

用域太大，無限制的到處跑，那麼你會擔心的。