文章目錄

• 1.2常量定義
• 1.3程式碼格式
• 1.4 OOP規約

1.2常量定義

1. 【強制】不允許任何魔法值（即未經預先定義的常量） 直接出現在程式碼中。
反例
String key = "Id#taobao_" + tradeId;，這時候我每次看這個變數我們都要去確認一下這個id究竟是指的是訂單id還是商品id，還是使用者id
改正為

final String orderTag= "Id#taobao_";
String key = orderTag+tradeId;

2.【強制】 在 long 或者 Long 賦值時， 數值後使用大寫的 L，不能是小寫的 l，小寫容易跟數字

1.3程式碼格式

略，純記憶

1.4 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 引入的工具類）
 

解析：只有6點需要使用解析一下，體會一下Objects的好處

@Test
	public void test4(){
		String a =null;
		String b =null;
		boolean result = Objects.equals(a, b);
		System.out.println(result); //返回true
	}

7. 【強制】所有的相同型別的包裝類物件之間值的比較，全部使用 equals 方法比較
   講解

public class MainTest {
	public static void main(String[] args) {
		Integer a = 55;
		Integer b = 55;
	    boolean result = a==b;
	    System.out.println(result);
	}
}
 

不是 new Integer() 時，使用valueOf(Integer) 方法進行初始化 Integer物件

public static Integer valueOf(int i) {
        if (i >= IntegerCache.low && i <= IntegerCache.high)
            return IntegerCache.cache[i + (-IntegerCache.low)];
        return new Integer(i);
    }
  private static class IntegerCache {
        static final int low = -128;
        static final int high;
        static final Integer cache[];

        static {
            // high value may be configured by property
            int h = 127;
            ...
}

所以理解了為什麼是-128到127

再理解一下long為什麼

public static void main(String[] args) {
		Long a = null;
		Long b = null;
		a = init();
		b = init();
	    boolean result = a==b;
	    System.out.println(result);
	}

	private static Long init() {
		return (long) 255; // 127返回true 255返回false
	}
	
public static Long valueOf(long l) {
        final int offset = 128;
        if (l >= -128 && l <= 127) { // will cache
            return LongCache.cache[(int)l + offset];
        }
        return new Long(l);
    }

下一個

8. 關於基本資料型別與包裝資料型別的使用標準如下：
1） 【強制】 所有的 POJO 類屬性必須使用包裝資料型別。
2） 【強制】 RPC 方法的返回值和引數必須使用包裝資料型別。
3） 【推薦】 所有的區域性變數使用基本資料型別。
9. 【強制】定義 DO/DTO/VO 等 POJO 類時，不要設定任何屬性預設值。

解析

這是針對NULL和0的問題決定的
而DO，DTO,VO等POJO類，因為大部分是查詢資料庫再二次封裝的輔助資訊，插入和查詢公用的類
，所以不建議新增預設值。插入有時候需要預設值，但是查詢不需要，所以不建議。

下一個

10. 【強制】序列化類新增屬性時，請不要修改 serialVersionUID 欄位，避免反序列失敗； 如
果完全不相容升級，避免反序列化混亂，那麼請修改 serialVersionUID 值。
說明： 注意 serialVersionUID 不一致會丟擲序列化執行時異常。
11. 【強制】構造方法裡面禁止加入任何業務邏輯，如果有初始化邏輯，請放在 init 方法中。
12. 【強制】 POJO 類必須寫 toString 方法。使用 IDE 中的工具： source> generate toString
時，如果繼承了另一個 POJO 類，注意在前面加一下 super.toString。
說明： 在方法執行丟擲異常時，可以直接呼叫 POJO 的 toString()方法列印其屬性值，便於排
查問題。 建議使用lombook @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;
}
}

解析

split原始碼看不懂，後續補充一下

下一個

18. 【推薦】迴圈體內，字串的連線方式，使用 StringBuilder 的 append 方法進行擴充套件。
說明： 下例中， 反編譯出的位元組碼檔案顯示每次迴圈都會 new 出一個 StringBuilder 物件，
然後進行 append 操作，最後通過 toString 方法返回 String 物件，造成記憶體資源浪費。
反例：
String str = "start";
for (int i = 0; i < 100; i++) {
str = str + "hello";
}

位元組碼

看到 第34行 goto即可理解到是迴圈 很多次 new SringBuilder.append，再tuString 複製方法

下一個

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 成員方法或
成員變數，刪除一下，不得手心冒點汗嗎？變數像自己的小孩，儘量在自己的視線內，變數作
用域太大， 無限制的到處跑，那麼你會擔心的。