Alibaba Java 開發(fā)手冊

一、編程規(guī)約

(一)命名規(guī)約

  1. 【強(qiáng)制】 代碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結(jié)束。
    反例: _name / _name / $Object / name / name$ / Object$
  2. 【強(qiáng)制】 代碼中的命名嚴(yán)禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。
    說明:正確的英文拼寫和語法可以讓閱讀者易于理解,避免歧義。注意,即使純拼音命名方式
    也要避免采用。
    反例: DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變量 = 3
    正例: alibaba / taobao / youku / hangzhou 等國際通用的名稱,可視同英文。
  3. 【強(qiáng)制】類名使用 UpperCamelCase 風(fēng)格,必須遵從駝峰形式,但以下情形例外:(領(lǐng)域模型
    的相關(guān)命名)DO / BO / DTO / VO 等。
    正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
    反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
  4. 【強(qiáng)制】方法名、參數(shù)名、成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風(fēng)格,必須遵從
    駝峰形式。
    正例: localValue / getHttpMessage() / inputUserId
  5. 【強(qiáng)制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達(dá)完整清楚,不要嫌名字長。
    正例: MAX_STOCK_COUNT
    反例: MAX_COUNT
  6. 【強(qiáng)制】抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結(jié)尾;測試類
    命名以它要測試的類的名稱開始,以 Test 結(jié)尾。
  7. 【強(qiáng)制】中括號是數(shù)組類型的一部分,數(shù)組定義如下:String[] args;
    反例:使用 String args[]的方式來定義。
  8. 【強(qiáng)制】POJO 類中布爾類型的變量,都不要加 is,否則部分框架解析會引起序列化錯(cuò)誤。
    反例:定義為基本數(shù)據(jù)類型 boolean isSuccess;的屬性,它的方法也是 isSuccess(),RPC
    框架在反向解析的時(shí)候,“以為”對應(yīng)的屬性名稱是 success,導(dǎo)致屬性獲取不到,進(jìn)而拋出異
    常。
  9. 【強(qiáng)制】包名統(tǒng)一使用小寫,點(diǎn)分隔符之間有且僅有一個(gè)自然語義的英語單詞。包名統(tǒng)一使用
    單數(shù)形式,但是類名如果有復(fù)數(shù)含義,類名可以使用復(fù)數(shù)形式。
    正例: 應(yīng)用工具類包名為 com.alibaba.open.util、類名為 MessageUtils(此規(guī)則參考
    spring 的框架結(jié)構(gòu))
  10. 【強(qiáng)制】杜絕完全不規(guī)范的縮寫,避免望文不知義。
    反例: AbstractClass“縮寫”命名成 AbsClass;condition“縮寫”命名成 condi,此類
    隨意縮寫嚴(yán)重降低了代碼的可閱讀性。
  11. 【推薦】如果使用到了設(shè)計(jì)模式,建議在類名中體現(xiàn)出具體模式。
    說明:將設(shè)計(jì)模式體現(xiàn)在名字中,有利于閱讀者快速理解架構(gòu)設(shè)計(jì)思想。
    正例:public class OrderFactory;
    public class LoginProxy;
    public class ResourceObserver;
  12. 【推薦】接口類中的方法和屬性不要加任何修飾符號(public 也不要加),保持代碼的簡潔
    性,并加上有效的 Javadoc 注釋。盡量不要在接口里定義變量,如果一定要定義變量,肯定是
    與接口方法相關(guān),并且是整個(gè)應(yīng)用的基礎(chǔ)常量。
    正例:接口方法簽名:void f();
    接口基礎(chǔ)常量表示:String COMPANY = "alibaba";
    反例:接口方法定義:public abstract void f();
    說明:JDK8 中接口允許有默認(rèn)實(shí)現(xiàn),那么這個(gè) default 方法,是對所有實(shí)現(xiàn)類都有價(jià)值的默
    認(rèn)實(shí)現(xiàn)。
  13. 接口和實(shí)現(xiàn)類的命名有兩套規(guī)則:
    1)【強(qiáng)制】對于 Service 和 DAO 類,基于 SOA 的理念,暴露出來的服務(wù)一定是接口,內(nèi)部
    的實(shí)現(xiàn)類用 Impl 的后綴與接口區(qū)別。
    正例:CacheServiceImpl 實(shí)現(xiàn) CacheService 接口。
    2)【推薦】如果是形容能力的接口名稱,取對應(yīng)的形容詞做接口名(通常是–able 的形式)。
    正例:AbstractTranslator 實(shí)現(xiàn) Translatable。
  14. 【參考】枚舉類名建議帶上 Enum 后綴,枚舉成員名稱需要全大寫,單詞間用下劃線隔開。
    說明:枚舉其實(shí)就是特殊的常量類,且構(gòu)造方法被默認(rèn)強(qiáng)制是私有。
    正例:枚舉名字:DealStatusEnum,成員名稱:SUCCESS / UNKOWN_REASON。
  15. 【參考】各層命名規(guī)約:
    A) Service/DAO 層方法命名規(guī)約
    1) 獲取單個(gè)對象的方法用 get 做前綴。
    2) 獲取多個(gè)對象的方法用 list 做前綴。
    3) 獲取統(tǒng)計(jì)值的方法用 count 做前綴。
    4) 插入的方法用 save(推薦)或 insert 做前綴。
    5) 刪除的方法用 remove(推薦)或 delete 做前綴。
    6) 修改的方法用 update 做前綴。
    B) 領(lǐng)域模型命名規(guī)約
    1) 數(shù)據(jù)對象:xxxDO,xxx 即為數(shù)據(jù)表名。
    2) 數(shù)據(jù)傳輸對象:xxxDTO,xxx 為業(yè)務(wù)領(lǐng)域相關(guān)的名稱。
    3) 展示對象:xxxVO,xxx 一般為網(wǎng)頁名稱。
    4) POJO 是 DO/DTO/BO/VO 的統(tǒng)稱,禁止命名成 xxxPOJO。

(二)常量定義

  1. 【強(qiáng)制】不允許出現(xiàn)任何魔法值(即未經(jīng)定義的常量)直接出現(xiàn)在代碼中。
    反例: String key="Id#taobao_"+tradeId;
    cache.put(key, value);
  2. 【強(qiáng)制】long 或者 Long 初始賦值時(shí),必須使用大寫的 L,不能是小寫的 l,小寫容易跟數(shù)字
    1 混淆,造成誤解。
    說明:Long a = 2l; 寫的是數(shù)字的 21,還是 Long 型的 2?
  3. 【推薦】不要使用一個(gè)常量類維護(hù)所有常量,應(yīng)該按常量功能進(jìn)行歸類,分開維護(hù)。如:緩存
    相關(guān)的常量放在類:CacheConsts 下;系統(tǒng)配置相關(guān)的常量放在類:ConfigConsts 下。
    說明:大而全的常量類,非得使用查找功能才能定位到修改的常量,不利于理解和維護(hù)。
  4. 【推薦】常量的復(fù)用層次有五層:跨應(yīng)用共享常量、應(yīng)用內(nèi)共享常量、子工程內(nèi)共享常量、包
    內(nèi)共享常量、類內(nèi)共享常量。
    1) 跨應(yīng)用共享常量:放置在二方庫中,通常是 client.jar 中的 constant 目錄下。
    2) 應(yīng)用內(nèi)共享常量:放置在一方庫的 modules 中的 constant 目錄下。
    反例:易懂變量也要統(tǒng)一定義成應(yīng)用內(nèi)共享常量,兩位攻城師在兩個(gè)類中分別定義了表示
    “是”的變量:
    類 A 中:public static final String YES = "yes";
    類 B 中:public static final String YES = "y";
    A.YES.equals(B.YES),預(yù)期是 true,但實(shí)際返回為 false,導(dǎo)致產(chǎn)生線上問題。
    3) 子工程內(nèi)部共享常量:即在當(dāng)前子工程的 constant 目錄下。
    4) 包內(nèi)共享常量:即在當(dāng)前包下單獨(dú)的 constant 目錄下。
    5) 類內(nèi)共享常量:直接在類內(nèi)部 private static final 定義。
  5. 【推薦】如果變量值僅在一個(gè)范圍內(nèi)變化用 Enum 類。如果還帶有名稱之外的延伸屬性,必須
    使用 Enum 類,下面正例中的數(shù)字就是延伸信息,表示星期幾。
    正例:public Enum{ MONDAY(1), TUESDAY(2), WEDNESDAY(3), THURSDAY(4), FRIDAY(5),
    SATURDAY(6), SUNDAY(7);}

(三)格式規(guī)約

  1. 【強(qiáng)制】大括號的使用約定。如果是大括號內(nèi)為空,則簡潔地寫成{}即可,不需要換行;如果
    是非空代碼塊則:
    1) 左大括號前不換行。
    2) 左大括號后換行。
    3) 右大括號前換行。
    4) 右大括號后還有 else 等代碼則不換行;表示終止右大括號后必須換行。
  2. 【強(qiáng)制】 左括號和后一個(gè)字符之間不出現(xiàn)空格;同樣,右括號和前一個(gè)字符之間也不出現(xiàn)空
    格。詳見第 5 條下方正例?示。
  3. 【強(qiáng)制】if/for/while/switch/do 等保留字與左右括號之間都必須加空格。
  4. 【強(qiáng)制】任何運(yùn)算符左右必須加一個(gè)空格。
    說明:運(yùn)算符包括賦值運(yùn)算符=、邏輯運(yùn)算符&&、加減乘除符號、三目運(yùn)行符等。
  5. 【強(qiáng)制】縮進(jìn)采用 4 個(gè)空格,禁止使用 tab 字符。
    說明:如果使用 tab 縮進(jìn),必須設(shè)置 1 個(gè) tab 為 4 個(gè)空格。IDEA 設(shè)置 tab 為 4 個(gè)空格時(shí),
    請勿勾選 Use tab character;而在 eclipse 中,必須勾選 insert spaces for tabs。
    正例: (涉及 1-5 點(diǎn))
public static void main(String[] args) {
    // 縮進(jìn) 4 個(gè)空格
    String say = "hello";
    // 運(yùn)算符的左右必須有一個(gè)空格
    int flag = 0;
    // 關(guān)鍵詞 if 與括號之間必須有一個(gè)空格,括號內(nèi)的 f 與左括號,0 與右括號不需要空格
    if (flag == 0) {
        System.out.println(say);
    }

    // 左大括號前加空格且不換行;左大括號后換行
    if (flag == 1) {
        System.out.println("world");
        // 右大括號前換行,右大括號后有 else,不用換行 
    } else {
        System.out.println("ok");
        // 在右大括號后直接結(jié)束,則必須換行
    }
}
  1. 【強(qiáng)制】單行字符數(shù)限制不超過 120 個(gè),超出需要換行,換行時(shí)遵循如下原則:
    1) 第二行相對第一行縮進(jìn) 4 個(gè)空格,從第三行開始,不再繼續(xù)縮進(jìn),參考示例。
    2) 運(yùn)算符與下文一起換行。
    3) 方法調(diào)用的點(diǎn)符號與下文一起換行。
    4) 在多個(gè)參數(shù)超長,逗號后進(jìn)行換行。
    5) 在括號前不要換行,見反例。
    正例:
    StringBuffer sb = new StringBuffer();
    //超過 120 個(gè)字符的情況下,換行縮進(jìn) 4 個(gè)空格,并且方法前的點(diǎn)符號一起換行
    sb.append("zi").append("xin")...
    .append("huang")...
    .append("huang")...
    .append("huang");
    反例:
    StringBuffer sb = new StringBuffer();
    //超過 120 個(gè)字符的情況下,不要在括號前換行
    sb.append("zi").append("xin")...append
    ("huang");
    //參數(shù)很多的方法調(diào)用可能超過 120 個(gè)字符,不要在逗號前換行
    method(args1, args2, args3, ...
    , argsX);
  2. 【強(qiáng)制】方法參數(shù)在定義和傳入時(shí),多個(gè)參數(shù)逗號后邊必須加空格。
    正例:下例中實(shí)參的"a",后邊必須要有一個(gè)空格。
    method("a", "b", "c");
  3. 【強(qiáng)制】IDE 的 text file encoding 設(shè)置為 UTF-8; IDE 中文件的換行符使用 Unix 格式,
    不要使用 windows 格式。
  4. 【推薦】沒有必要增加若干空格來使某一行的字符與上一行的相應(yīng)字符對齊。
    正例:
    int a = 3;
    long b = 4L;
    float c = 5F;
    StringBuffer sb = new StringBuffer();
    說明:增加 sb 這個(gè)變量,如果需要對齊,則給 a、b、c 都要增加幾個(gè)空格,在變量比較多的
    情況下,是一種累贅的事情。
  5. 【推薦】方法體內(nèi)的執(zhí)行語句組、變量的定義語句組、不同的業(yè)務(wù)邏輯之間或者不同的語義
    之間插入一個(gè)空行。相同業(yè)務(wù)邏輯和語義之間不需要插入空行。
    說明:沒有必要插入多行空格進(jìn)行隔開。

(四)OOP 規(guī)約

  1. 【強(qiáng)制】避免通過一個(gè)類的對象引用訪問此類的靜態(tài)變量或靜態(tài)方法,無謂增加編譯器解析成
    本,直接用類名來訪問即可。
  2. 【強(qiáng)制】所有的覆寫方法,必須加@Override 注解。
    反例:getObject()與 get0bject()的問題。一個(gè)是字母的 O,一個(gè)是數(shù)字的 0,加@Override
    可以準(zhǔn)確判斷是否覆蓋成功。另外,如果在抽象類中對方法簽名進(jìn)行修改,其實(shí)現(xiàn)類會馬上編
    譯報(bào)錯(cuò)。
  3. 【強(qiáng)制】相同參數(shù)類型,相同業(yè)務(wù)含義,才可以使用 Java 的可變參數(shù),避免使用 Object。
    說明:可變參數(shù)必須放置在參數(shù)列表的最后。(?倡同學(xué)們盡量不用可變參數(shù)編程)
    正例:public User getUsers(String type, Integer... ids)
  4. 【強(qiáng)制】對外暴露的接口簽名,原則上不允許修改方法簽名,避免對接口調(diào)用方產(chǎn)生影響。接
    口過時(shí)必須加@Deprecated 注解,并清晰地說明采用的新接口或者新服務(wù)是什么。
  5. 【強(qiáng)制】不能使用過時(shí)的類或方法。
    說明:java.net.URLDecoder 中的方法 decode(String encodeStr) 這個(gè)方法已經(jīng)過時(shí),應(yīng)
    該使用雙參數(shù) decode(String source, String encode)。接口?供方既然明確是過時(shí)接口,
    那么有義務(wù)同時(shí)?供新的接口;作為調(diào)用方來說,有義務(wù)去考證過時(shí)方法的新實(shí)現(xiàn)是什么。
  6. 【強(qiáng)制】Object 的 equals 方法容易拋空指針異常,應(yīng)使用常量或確定有值的對象來調(diào)用
    equals。
    正例: "test".equals(object);
    反例: object.equals("test");
    說明:推薦使用 java.util.Objects#equals (JDK7 引入的工具類)
  7. 【強(qiáng)制】所有的相同類型的包裝類對象之間值的比較,全部使用 equals 方法比較。
    說明:對于 Integer var=?在-128 至 127 之間的賦值,Integer 對象是在
    IntegerCache.cache 產(chǎn)生,會復(fù)用已有對象,這個(gè)區(qū)間內(nèi)的 Integer 值可以直接使用==進(jìn)行
    判斷,但是這個(gè)區(qū)間之外的所有數(shù)據(jù),都會在堆上產(chǎn)生,并不會復(fù)用已有對象,這是一個(gè)大坑,
    推薦使用 equals 方法進(jìn)行判斷。
  8. 【強(qiáng)制】關(guān)于基本數(shù)據(jù)類型與包裝數(shù)據(jù)類型的使用標(biāo)準(zhǔn)如下:
    1) 所有的 POJO 類屬性必須使用包裝數(shù)據(jù)類型。
    2) RPC 方法的返回值和參數(shù)必須使用包裝數(shù)據(jù)類型。
    3) 所有的局部變量【推薦】使用基本數(shù)據(jù)類型。
    說明:POJO 類屬性沒有初值是?醒使用者在需要使用時(shí),必須自己顯式地進(jìn)行賦值,任何
    NPE 問題,或者入庫檢查,都由使用者來保證。
    正例:數(shù)據(jù)庫的查詢結(jié)果可能是 null,因?yàn)樽詣?dòng)拆箱,用基本數(shù)據(jù)類型接收有 NPE 風(fēng)險(xiǎn)。
    反例:比如顯示成交總額漲跌情況,即正負(fù) x%,x 為基本數(shù)據(jù)類型,調(diào)用的 RPC 服務(wù),調(diào)用
    不成功時(shí),返回的是默認(rèn)值,頁面顯示:0%,這是不合理的,應(yīng)該顯示成中劃線-。所以包裝
    數(shù)據(jù)類型的 null 值,能夠表示額外的信息,如:遠(yuǎn)程調(diào)用失敗,異常退出。
  9. 【強(qiáng)制】定義 DO/DTO/VO 等 POJO 類時(shí),不要設(shè)定任何屬性默認(rèn)值。
    反例:POJO 類的 gmtCreate 默認(rèn)值為 new Date();但是這個(gè)屬性在數(shù)據(jù)?取時(shí)并沒有置入具
    體值,在更新其它字段時(shí)又附帶更新了此字段,導(dǎo)致創(chuàng)建時(shí)間被修改成當(dāng)前時(shí)間。
  10. 【強(qiáng)制】序列化類新增屬性時(shí),請不要修改 serialVersionUID 字段,避免反序列失?。蝗?br> 果完全不兼容升級,避免反序列化混亂,那么請修改 serialVersionUID 值。
    說明:注意 serialVersionUID 不一致會拋出序列化運(yùn)行時(shí)異常。
  11. 【強(qiáng)制】構(gòu)造方法里面禁止加入任何業(yè)務(wù)邏輯,如果有初始化邏輯,請放在 init 方法中。
  12. 【強(qiáng)制】POJO 類必須寫 toString 方法。使用 IDE 的中工具:source> generate toString
    時(shí),如果繼承了另一個(gè) POJO 類,注意在前面加一下 super.toString。
    說明:在方法執(zhí)行拋出異常時(shí),可以直接調(diào)用 POJO 的 toString()方法打印其屬性值,便于排
    查問題。
  13. 【推薦】使用索引訪問用 String 的 split 方法得到的數(shù)組時(shí),需做最后一個(gè)分隔符后有無
    內(nèi)容的檢查,否則會有拋 IndexOutOfBoundsException 的風(fēng)險(xiǎn)。
    說明:
    String str = "a,b,c,,";
    String[] ary = str.split(",");
    //預(yù)期大于 3,結(jié)果是 3
    System.out.println(ary.length);
  14. 【推薦】當(dāng)一個(gè)類有多個(gè)構(gòu)造方法,或者多個(gè)同名方法,這些方法應(yīng)該按順序放置在一起,
    便于閱讀。
  15. 【推薦】 類內(nèi)方法定義順序依次是:公有方法或保護(hù)方法 > 私有方法 > getter/setter
    方法。
    說明:公有方法是類的調(diào)用者和維護(hù)者最關(guān)心的方法,首屏展示最好;保護(hù)方法雖然只是子類
    關(guān)心,也可能是“模板設(shè)計(jì)模式”下的核心方法;而私有方法外部一般不需要特別關(guān)心,是一個(gè)
    黑盒實(shí)現(xiàn);因?yàn)榉椒ㄐ畔r(jià)值較低,所有 Service 和 DAO 的 getter/setter 方法放在類體最
    后。
  16. 【推薦】setter 方法中,參數(shù)名稱與類成員變量名稱一致,this.成員名=參數(shù)名。在
    getter/setter 方法中,盡量不要增加業(yè)務(wù)邏輯,增加排查問題的難度。
    反例:
    public Integer getData(){
    if(true) {
    return data + 100;
    } else {
    return data - 100;
    }
    }
  17. 【推薦】循環(huán)體內(nèi),字符串的聯(lián)接方式,使用 StringBuilder 的 append 方法進(jìn)行擴(kuò)展。
    反例:
    String str = "start";
    for(int i=0; i<100; i++){
    str = str + "hello";
    }
    說明:反編譯出的字節(jié)碼文件顯示每次循環(huán)都會 new 出一個(gè) StringBuilder 對象,然后進(jìn)行
    append 操作,最后通過 toString 方法返回 String 對象,造成內(nèi)存資源浪費(fèi)。
  18. 【推薦】final 可?高程序響應(yīng)效率,聲明成 final 的情況:
    1) 不需要重新賦值的變量,包括類屬性、局部變量。
    2) 對象參數(shù)前加 final,表示不允許修改引用的指向。
    3) 類方法確定不允許被重寫。
  19. 【推薦】慎用 Object 的 clone 方法來拷貝對象。
    說明:對象的 clone 方法默認(rèn)是淺拷貝,若想實(shí)現(xiàn)深拷貝需要重寫 clone 方法實(shí)現(xiàn)屬性對象
    的拷貝。
  20. 【推薦】類成員與方法訪問控制從嚴(yán):
    1) 如果不允許外部直接通過 new 來創(chuàng)建對象,那么構(gòu)造方法必須是 private。
    2) 工具類不允許有 public 或 default 構(gòu)造方法。
    3) 類非 static 成員變量并且與子類共享,必須是 protected。
    4) 類非 static 成員變量并且僅在本類使用,必須是 private。
    5) 類 static 成員變量如果僅在本類使用,必須是 private。
    6) 若是 static 成員變量,必須考慮是否為 final。
    7) 類成員方法只供類內(nèi)部調(diào)用,必須是 private。
    8) 類成員方法只對繼承類公開,那么限制為 protected。
    說明:任何類、方法、參數(shù)、變量,嚴(yán)控訪問范圍。過寬泛的訪問范圍,不利于模塊解耦。思
    考:如果是一個(gè) private 的方法,想刪除就刪除,可是一個(gè) public 的 Service 方法,或者一
    個(gè) public 的成員變量,刪除一下,不得手心冒點(diǎn)汗嗎?變量像自己的小孩,盡量在自己的視
    線內(nèi),變量作用域太大,如果無限制的到處跑,那么你會擔(dān)心的。
    (五)集合處理
  21. 【強(qiáng)制】關(guān)于 hashCode 和 equals 的處理,遵循如下規(guī)則:
    1) 只要重寫 equals,就必須重寫 hashCode。
    2) 因?yàn)?Set 存儲的是不重復(fù)的對象,依據(jù) hashCode 和 equals 進(jìn)行判斷,所以 Set 存儲的
    對象必須重寫這兩個(gè)方法。
    3) 如果自定義對象做為 Map 的鍵,那么必須重寫 hashCode 和 equals。
    正例:String 重寫了 hashCode 和 equals 方法,所以我們可以非常愉快地使用 String 對象
    作為 key 來使用。
  22. 【強(qiáng)制】ArrayList的subList結(jié)果不可強(qiáng)轉(zhuǎn)成ArrayList,否則會拋出ClassCastException
    異常:java.util.RandomAccessSubList cannot be cast to java.util.ArrayList ;
    說明:subList 返回的是 ArrayList 的內(nèi)部類 SubList,并不是 ArrayList ,而是
    ArrayList 的一個(gè)視圖,對于 SubList 子列表的所有操作最終會反映到原列表上。
  23. 【強(qiáng)制】 在 subList 場景中,高度注意對原集合元素個(gè)數(shù)的修改,會導(dǎo)致子列表的遍歷、增
    加、刪除均產(chǎn)生 ConcurrentModificationException 異常。
  24. 【強(qiáng)制】使用集合轉(zhuǎn)數(shù)組的方法,必須使用集合的 toArray(T[] array),傳入的是類型完全
    一樣的數(shù)組,大小就是 list.size()。
    反例:直接使用 toArray 無參方法存在問題,此方法返回值只能是 Object[]類,若強(qiáng)轉(zhuǎn)其它
    類型數(shù)組將出現(xiàn) ClassCastException 錯(cuò)誤。
    正例:
    List<String> list = new ArrayList<String>(2);
    list.add("guan");
    list.add("bao");
    String[] array = new String[list.size()];
    array = list.toArray(array);
    說明:使用 toArray 帶參方法,入?yún)⒎峙涞臄?shù)組空間不夠大時(shí),toArray 方法內(nèi)部將重新分配
    內(nèi)存空間,并返回新數(shù)組地址;如果數(shù)組元素大于實(shí)際所需,下標(biāo)為[ list.size() ]的數(shù)組
    元素將被置為 null,其它數(shù)組元素保持原值,因此最好將方法入?yún)?shù)組大小定義與集合元素
    個(gè)數(shù)一致。
  25. 【強(qiáng)制】使用工具類 Arrays.asList()把數(shù)組轉(zhuǎn)換成集合時(shí),不能使用其修改集合相關(guān)的方
    法,它的 add/remove/clear 方法會拋出 UnsupportedOperationException 異常。
    說明:asList 的返回對象是一個(gè) Arrays 內(nèi)部類,并沒有實(shí)現(xiàn)集合的修改方法。Arrays.asList
    體現(xiàn)的是適配器模式,只是轉(zhuǎn)換接口,后臺的數(shù)據(jù)仍是數(shù)組。
    String[] str = new String[] { "a", "b" };
    List list = Arrays.asList(str);
    第一種情況:list.add("c"); 運(yùn)行時(shí)異常。
    第二種情況:str[0]= "gujin"; 那么 list.get(0)也會隨之修改。
  26. 【強(qiáng)制】泛型通配符<? extends T>來接收返回的數(shù)據(jù),此寫法的泛型集合不能使用 add 方
    法。
    說明:蘋果裝箱后返回一個(gè)<? extends Fruits>對象,此對象就不能往里加任何水果,包括
    蘋果。
  27. 【強(qiáng)制】不要在 foreach 循環(huán)里進(jìn)行元素的 remove/add 操作。remove 元素請使用 Iterator
    方式,如果并發(fā)操作,需要對 Iterator 對象加鎖。
    反例:
    List<String> a = new ArrayList<String>();
    a.add("1");
    a.add("2");
    for (String temp : a) {
    if("1".equals(temp)){
    a.remove(temp);
    }
    }
    說明:以上代碼的執(zhí)行結(jié)果肯定會出乎大家的意料,那么試一下把“1”換成“2”,會是同樣的
    結(jié)果嗎?
    正例:
    Iterator<String> it = a.iterator();
    while(it.hasNext()){
    String temp = it.next();
    if(刪除元素的條件){
    it.remove();
    }
    }
  28. 【強(qiáng)制】在 JDK7 版本以上,Comparator 要滿足自反性,傳遞性,對稱性,不然 Arrays.sort,
    Collections.sort 會報(bào) IllegalArgumentException 異常。
    說明:
    1) 自反性:x,y 的比較結(jié)果和 y,x 的比較結(jié)果相反。
    2) 傳遞性:x>y,y>z,則 x>z。
    3) 對稱性:x=y,則 x,z 比較結(jié)果和 y,z 比較結(jié)果相同。
    反例:下例中沒有處理相等的情況,實(shí)際使用中可能會出現(xiàn)異常:
new Comparator<Student>() {
    @Override
    public int compare(Student o1, Student o2) {
        return o1.getId() > o2.getId() ? 1 : -1;
    }
} 
  1. 【推薦】集合初始化時(shí),盡量指定集合初始值大小。
    說明:ArrayList 盡量使用 ArrayList(int initialCapacity) 初始化。
  2. 【推薦】使用 entrySet 遍歷 Map 類集合 KV,而不是 keySet 方式進(jìn)行遍歷。
    說明:keySet 其實(shí)是遍歷了 2 次,一次是轉(zhuǎn)為 Iterator 對象,另一次是從 hashMap 中取出
    key 所對應(yīng)的 value。而 entrySet 只是遍歷了一次就把 key 和 value 都放到了 entry 中,效
    率更高。如果是 JDK8,使用 Map.foreach 方法。
    正例:values()返回的是 V 值集合,是一個(gè) list 集合對象;keySet()返回的是 K 值集合,是
    一個(gè) Set 集合對象;entrySet()返回的是 K-V 值組合集合。
  3. 【推薦】高度注意 Map 類集合 K/V 能不能存儲 null 值的情況,如下表格:
    集合類 Key Value Super 說明
    Hashtable 不允許為 null 不允許為 null Dictionary 線程安全
    ConcurrentHashMap 不允許為 null 不允許為 null AbstractMap 分段鎖技術(shù)
    TreeMap 不允許為 null 允許為 null AbstractMap 線程不安全
    HashMap 允許為 null 允許為 null AbstractMap 線程不安全
    反例: 由于 HashMap 的干擾,很多人認(rèn)為 ConcurrentHashMap 是可以置入 null 值,注意存儲
    null 值時(shí)會拋出 NPE 異常。
  4. 【參考】合理利用好集合的有序性(sort)和穩(wěn)定性(order),避免集合的無序性(unsort)和
    不穩(wěn)定性(unorder)帶來的負(fù)面影響。
    說明:有序性是指遍歷的結(jié)果是按某種比較規(guī)則依次排列的。穩(wěn)定性指集合每次遍歷的元素次
    序是一定的。如:ArrayList 是 order/unsort;HashMap 是 unorder/unsort;TreeSet 是
    order/sort。
  5. 【參考】利用 Set 元素唯一的特性,可以快速對一個(gè)集合進(jìn)行去重操作,避免使用 List 的
    contains 方法進(jìn)行遍歷、對比、去重操作。

(六)并發(fā)處理

  1. 【強(qiáng)制】獲取單例對象需要保證線程安全,其中的方法也要保證線程安全。
    說明:資源驅(qū)動(dòng)類、工具類、單例工廠類都需要注意。
  2. 【強(qiáng)制】創(chuàng)建線程或線程池時(shí)請指定有意義的線程名稱,方便出錯(cuò)時(shí)回溯。
    正例:
public class TimerTaskThread extends Thread {
    public TimerTaskThread(){
        super.setName("TimerTaskThread"); ...
    } 
  1. 【強(qiáng)制】線程資源必須通過線程池?供,不允許在應(yīng)用中自行顯式創(chuàng)建線程。
    說明:使用線程池的好處是減少在創(chuàng)建和銷毀線程上所花的時(shí)間以及系統(tǒng)資源的開銷,解決資
    源不足的問題。如果不使用線程池,有可能造成系統(tǒng)創(chuàng)建大量同類線程而導(dǎo)致消耗完內(nèi)存或者
    “過度切換”的問題。
  2. 【強(qiáng)制】線程池不允許使用 Executors 去創(chuàng)建,而是通過 ThreadPoolExecutor 的方式,這樣
    的處理方式讓寫的同學(xué)更加明確線程池的運(yùn)行規(guī)則,規(guī)避資源耗盡的風(fēng)險(xiǎn)。
    說明:Executors 返回的線程池對象的弊端如下:
    1)FixedThreadPool 和 SingleThreadPool:
    允許的請求隊(duì)列長度為 Integer.MAX_VALUE,可能會堆積大量的請求,從而導(dǎo)致 OOM。
    2)CachedThreadPool 和 ScheduledThreadPool:
    允許的創(chuàng)建線程數(shù)量為 Integer.MAX_VALUE,可能會創(chuàng)建大量的線程,從而導(dǎo)致 OOM。
  3. 【強(qiáng)制】SimpleDateFormat 是線程不安全的類,一般不要定義為 static 變量,如果定義為
    static,必須加鎖,或者使用 DateUtils 工具類。
    正例:注意線程安全,使用 DateUtils。亦推薦如下處理:
    private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
    @Override
    protected DateFormat initialValue() {
    return new SimpleDateFormat("yyyy-MM-dd");
    }
    };
    說明:如果是 JDK8 的應(yīng)用,可以使用 Instant 代替 Date,LocalDateTime 代替 Calendar,
    DateTimeFormatter代替Simpledateformatter,官方給出的解釋:simple beautiful strong
    immutable thread-safe。
  4. 【強(qiáng)制】高并發(fā)時(shí),同步調(diào)用應(yīng)該去考量鎖的性能損耗。能用無鎖數(shù)據(jù)結(jié)構(gòu),就不要用鎖;能
    鎖區(qū)塊,就不要鎖整個(gè)方法體;能用對象鎖,就不要用類鎖。
  5. 【強(qiáng)制】對多個(gè)資源、數(shù)據(jù)庫表、對象同時(shí)加鎖時(shí),需要保持一致的加鎖順序,否則可能會造
    成死鎖。
    說明:線程一需要對表 A、B、C 依次全部加鎖后才可以進(jìn)行更新操作,那么線程二的加鎖順序
    也必須是 A、B、C,否則可能出現(xiàn)死鎖。
  6. 【強(qiáng)制】并發(fā)修改同一記錄時(shí),避免更新丟失,要么在應(yīng)用層加鎖,要么在緩存加鎖,要么在
    數(shù)據(jù)庫層使用樂觀鎖,使用 version 作為更新依據(jù)。
    說明:如果每次訪問沖突概率小于 20%,推薦使用樂觀鎖,否則使用悲觀鎖。樂觀鎖的重試次
    數(shù)不得小于 3 次。
  7. 【強(qiáng)制】多線程并行處理定時(shí)任務(wù)時(shí),Timer 運(yùn)行多個(gè) TimeTask 時(shí),只要其中之一沒有捕獲
    拋出的異常,其它任務(wù)便會自動(dòng)終止運(yùn)行,使用 ScheduledExecutorService 則沒有這個(gè)問題。
  8. 【推薦】使用 CountDownLatch 進(jìn)行異步轉(zhuǎn)同步操作,每個(gè)線程退出前必須調(diào)用 countDown
    方法,線程執(zhí)行代碼注意 catch 異常,確保 countDown 方法可以執(zhí)行,避免主線程無法執(zhí)行
    至 await 方法,直到超時(shí)才返回結(jié)果。
    說明:注意,子線程拋出異常堆棧,不能在主線程 try-catch 到。
  9. 【推薦】避免 Random 實(shí)例被多線程使用,雖然共享該實(shí)例是線程安全的,但會因競爭同一
    seed 導(dǎo)致的性能下降。
    說明:Random 實(shí)例包括 java.util.Random 的實(shí)例或者 Math.random()實(shí)例。
    正例:在 JDK7 之后,可以直接使用 API ThreadLocalRandom,在 JDK7 之前,可以做到每個(gè)
    線程一個(gè)實(shí)例。
  10. 【推薦】通過雙重檢查鎖(double-checked locking)(在并發(fā)場景)實(shí)現(xiàn)延遲初始化的優(yōu)
    化問題隱患(可參考 The "Double-Checked Locking is Broken" Declaration),推薦問題
    解決方案中較為簡單一種(適用于 JDK5 及以上版本),將目標(biāo)屬性聲明為 volatile 型。
    反例:
    class Foo {
    private Helper helper = null;
    public Helper getHelper() {
    if (helper == null) synchronized(this) {
    if (helper == null)
    helper = new Helper();
    }
    return helper;
    }
    // other functions and members...
    }
  11. 【參考】volatile 解決多線程內(nèi)存不可見問題。對于一寫多讀,是可以解決變量同步問題,
    但是如果多寫,同樣無法解決線程安全問題。如果是 count++操作,使用如下類實(shí)現(xiàn):
    AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8,推
    薦使用 LongAdder 對象,比 AtomicLong 性能更好(減少樂觀鎖的重試次數(shù))。
  12. 【參考】 HashMap 在容量不夠進(jìn)行 resize 時(shí)由于高并發(fā)可能出現(xiàn)死鏈,導(dǎo)致 CPU 飆升,在
    開發(fā)過程中注意規(guī)避此風(fēng)險(xiǎn)。
  13. 【參考】ThreadLocal 無法解決共享對象的更新問題,ThreadLocal 對象建議使用 static
    修飾。這個(gè)變量是針對一個(gè)線程內(nèi)所有操作共有的,所以設(shè)置為靜態(tài)變量,所有此類實(shí)例共享
    此靜態(tài)變量 ,也就是說在類第一次被使用時(shí)裝載,只分配一塊存儲空間,所有此類的對象(只
    要是這個(gè)線程內(nèi)定義的)都可以操控這個(gè)變量。

(七)控制語句

  1. 【強(qiáng)制】在一個(gè) switch 塊內(nèi),每個(gè) case 要么通過 break/return 等來終止,要么注釋說明程
    序?qū)⒗^續(xù)執(zhí)行到哪一個(gè) case 為止;在一個(gè) switch 塊內(nèi),都必須包含一個(gè) default 語句并且
    放在最后,即使它什么代碼也沒有。
  2. 【強(qiáng)制】在 if/else/for/while/do 語句中必須使用大括號,即使只有一行代碼,避免使用
    下面的形式:if (condition) statements;
  3. 【推薦】推薦盡量少用 else, if-else 的方式可以改寫成:
    if(condition){
    ...
    return obj;
    }
    // 接著寫 else 的業(yè)務(wù)邏輯代碼;
    說明:如果非得使用 if()...else if()...else...方式表達(dá)邏輯,【強(qiáng)制】請勿超過 3 層,
    超過請使用狀態(tài)設(shè)計(jì)模式。
    正例:邏輯上超過 3 層的 if-else 代碼可以使用衛(wèi)語句,或者狀態(tài)模式來實(shí)現(xiàn)。
  4. 【推薦】除常用方法(如 getXxx/isXxx)等外,不要在條件判斷中執(zhí)行其它復(fù)雜的語句,將復(fù)
    雜邏輯判斷的結(jié)果賦值給一個(gè)有意義的布爾變量名,以?高可讀性。
    說明:很多 if 語句內(nèi)的邏輯相當(dāng)復(fù)雜,閱讀者需要分析條件表達(dá)式的最終結(jié)果,才能明確什么
    樣的條件執(zhí)行什么樣的語句,那么,如果閱讀者分析邏輯表達(dá)式錯(cuò)誤呢?
    正例:
    //偽代碼如下
    boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
    if (existed) {
    ...
    }
    反例:
    if ((file.open(fileName, "w") != null) && (...) || (...)) {
    ...
    }
  5. 【推薦】循環(huán)體中的語句要考量性能,以下操作盡量移至循環(huán)體外處理,如定義對象、變量、
    獲取數(shù)據(jù)庫連接,進(jìn)行不必要的 try-catch 操作(這個(gè) try-catch 是否可以移至循環(huán)體外)。
  6. 【推薦】接口入?yún)⒈Wo(hù),這種場景常見的是用于做批量操作的接口。
  7. 【參考】方法中需要進(jìn)行參數(shù)校驗(yàn)的場景:
    1) 調(diào)用頻次低的方法。
    2) 執(zhí)行時(shí)間開銷很大的方法,參數(shù)校驗(yàn)時(shí)間幾乎可以忽略不計(jì),但如果因?yàn)閰?shù)錯(cuò)誤導(dǎo)致
    中間執(zhí)行回退,或者錯(cuò)誤,那得不償失。
    3) 需要極高穩(wěn)定性和可用性的方法。
    4) 對外?供的開放接口,不管是 RPC/API/HTTP 接口。
    5) 敏感權(quán)限入口。
  8. 【參考】方法中不需要參數(shù)校驗(yàn)的場景:
    1) 極有可能被循環(huán)調(diào)用的方法,不建議對參數(shù)進(jìn)行校驗(yàn)。但在方法說明里必須注明外部參
    數(shù)檢查。
    2) 底層的方法調(diào)用頻度都比較高,一般不校驗(yàn)。畢竟是像純凈水過濾的最后一道,參數(shù)錯(cuò)
    誤不太可能到底層才會暴露問題。一般 DAO 層與 Service 層都在同一個(gè)應(yīng)用中,部署在同一
    臺服務(wù)器中,所以 DAO 的參數(shù)校驗(yàn),可以省略。
    3) 被聲明成 private 只會被自己代碼所調(diào)用的方法,如果能夠確定調(diào)用方法的代碼傳入?yún)?br> 數(shù)已經(jīng)做過檢查或者肯定不會有問題,此時(shí)可以不校驗(yàn)參數(shù)。

(八)注釋規(guī)約

  1. 【強(qiáng)制】類、類屬性、類方法的注釋必須使用 Javadoc 規(guī)范,使用/*內(nèi)容/格式,不得使用
    //xxx 方式。
    說明:在 IDE 編輯窗口中,Javadoc 方式會?示相關(guān)注釋,生成 Javadoc 可以正確輸出相應(yīng)注
    釋;在 IDE 中,工程調(diào)用方法時(shí),不進(jìn)入方法即可懸浮?示方法、參數(shù)、返回值的意義,?高
    閱讀效率。
  2. 【強(qiáng)制】所有的抽象方法(包括接口中的方法)必須要用 Javadoc 注釋、除了返回值、參數(shù)、
    異常說明外,還必須指出該方法做什么事情,實(shí)現(xiàn)什么功能。
    說明:對子類的實(shí)現(xiàn)要求,或者調(diào)用注意事項(xiàng),請一并說明。
  3. 【強(qiáng)制】所有的類都必須添加創(chuàng)建者信息。
  4. 【強(qiáng)制】方法內(nèi)部單行注釋,在被注釋語句上方另起一行,使用//注釋。方法內(nèi)部多行注釋
    使用/* */注釋,注意與代碼對齊。
  5. 【強(qiáng)制】所有的枚舉類型字段必須要有注釋,說明每個(gè)數(shù)據(jù)項(xiàng)的用途。
  6. 【推薦】與其“半吊子”英文來注釋,不如用中文注釋把問題說清楚。專有名詞與關(guān)鍵字保持
    英文原文即可。
    反例:“TCP 連接超時(shí)”解釋成“傳輸控制協(xié)議連接超時(shí)”,理解反而費(fèi)腦筋。
  7. 【推薦】代碼修改的同時(shí),注釋也要進(jìn)行相應(yīng)的修改,尤其是參數(shù)、返回值、異常、核心邏輯
    等的修改。
    說明:代碼與注釋更新不同步,就像路網(wǎng)與導(dǎo)航軟件更新不同步一樣,如果導(dǎo)航軟件嚴(yán)重滯后,
    就失去了導(dǎo)航的意義。
  8. 【參考】注釋掉的代碼盡量要配合說明,而不是簡單的注釋掉。
    說明:代碼被注釋掉有兩種可能性:1)后續(xù)會恢復(fù)此段代碼邏輯。2)永久不用。前者如果沒
    有備注信息,難以知曉注釋動(dòng)機(jī)。后者建議直接刪掉(代碼倉庫保存了歷史代碼)。
  9. 【參考】對于注釋的要求:第一、能夠準(zhǔn)確反應(yīng)設(shè)計(jì)思想和代碼邏輯;第二、能夠?述業(yè)務(wù)含
    義,使別的程序員能夠迅速了解到代碼背后的信息。完全沒有注釋的大段代碼對于閱讀者形同
    天書,注釋是給自己看的,即使隔很長時(shí)間,也能清晰理解當(dāng)時(shí)的思路;注釋也是給繼任者看
    的,使其能夠快速接替自己的工作。
  10. 【參考】好的命名、代碼結(jié)構(gòu)是自解釋的,注釋力求精簡準(zhǔn)確、表達(dá)到位。避免出現(xiàn)注釋的
    一個(gè)極端:過多過濫的注釋,代碼的邏輯一旦修改,修改注釋是相當(dāng)大的負(fù)擔(dān)。
    反例:
    // put elephant into fridge
    put(elephant, fridge);
    方法名 put,加上兩個(gè)有意義的變量名 elephant 和 fridge,已經(jīng)說明了這是在干什么,語
    義清晰的代碼不需要額外的注釋。
  11. 【參考】特殊注釋標(biāo)記,請注明標(biāo)記人與標(biāo)記時(shí)間。注意及時(shí)處理這些標(biāo)記,通過標(biāo)記掃?,
    經(jīng)常清理此類標(biāo)記。線上故障有時(shí)候就是來源于這些標(biāo)記處的代碼。
    1) 待辦事宜(TODO):( 標(biāo)記人,標(biāo)記時(shí)間,[預(yù)計(jì)處理時(shí)間])
    表示需要實(shí)現(xiàn),但目前還未實(shí)現(xiàn)的功能。這實(shí)際上是一個(gè) Javadoc 的標(biāo)簽,目前的 Javadoc
    還沒有實(shí)現(xiàn),但已經(jīng)被廣泛使用。只能應(yīng)用于類,接口和方法(因?yàn)樗且粋€(gè) Javadoc 標(biāo)簽)。
    2) 錯(cuò)誤,不能工作(FIXME):(標(biāo)記人,標(biāo)記時(shí)間,[預(yù)計(jì)處理時(shí)間])
    在注釋中用 FIXME 標(biāo)記某代碼是錯(cuò)誤的,而且不能工作,需要及時(shí)糾正的情況。

(九)其它

  1. 【強(qiáng)制】在使用正則表達(dá)式時(shí),利用好其預(yù)編譯功能,可以有效加快正則匹配速度。
    說明:不要在方法體內(nèi)定義:Pattern pattern = Pattern.compile(規(guī)則);
  2. 【強(qiáng)制】velocity 調(diào)用 POJO 類的屬性時(shí),建議直接使用屬性名取值即可,模板引擎會自動(dòng)按
    規(guī)范調(diào)用 POJO 的 getXxx(),如果是 boolean 基本數(shù)據(jù)類型變量(boolean 命名不需要加 is
    前綴),會自動(dòng)調(diào)用 isXxx()方法。
    說明:注意如果是 Boolean 包裝類對象,優(yōu)先調(diào)用 getXxx()的方法。
  3. 【強(qiáng)制】后臺輸送給頁面的變量必須加$!{var}——中間的感嘆號。
    說明:如果 var=null 或者不存在,那么${var}會直接顯示在頁面上。
  4. 【強(qiáng)制】注意 Math.random() 這個(gè)方法返回是 double 類型,注意取值的范圍 0≤x<1(能夠
    取到零值,注意除零異常),如果想獲取整數(shù)類型的隨機(jī)數(shù),不要將 x 放大 10 的若干倍然后
    取整,直接使用 Random 對象的 nextInt 或者 nextLong 方法。
  5. 【強(qiáng)制】獲取當(dāng)前毫秒數(shù) System.currentTimeMillis(); 而不是 new Date().getTime();
    說明:如果想獲取更加精確的納秒級時(shí)間值,用 System.nanoTime()。在 JDK8 中,針對統(tǒng)計(jì)
    時(shí)間等場景,推薦使用 Instant 類。
  6. 【推薦】盡量不要在 velocity 模板中加入變量聲明、邏輯運(yùn)算符,更不要在模板中加入任何
    復(fù)雜的邏輯。
  7. 【推薦】任何數(shù)據(jù)結(jié)構(gòu)的構(gòu)造或初始化,都應(yīng)指定大小,避免數(shù)據(jù)結(jié)構(gòu)無限增長吃光內(nèi)存。
  8. 【推薦】對于“明確停止使用的代碼和配置”,如方法、變量、類、配置文件、動(dòng)態(tài)配置屬性
    等要堅(jiān)決從程序中清理出去,避免造成過多垃圾。

二、異常日志

(一)異常處理

  1. 【強(qiáng)制】不要捕獲 Java 類庫中定義的繼承自 RuntimeException 的運(yùn)行時(shí)異常類,如:
    IndexOutOfBoundsException / NullPointerException,這類異常由程序員預(yù)檢查
    來規(guī)避,保證程序健壯性。
    正例:if(obj != null) {...}
    反例:try { obj.method() } catch(NullPointerException e){...}
  2. 【強(qiáng)制】異常不要用來做流程控制,條件控制,因?yàn)楫惓5奶幚硇时葪l件分支低。
  3. 【強(qiáng)制】對大段代碼進(jìn)行 try-catch,這是不負(fù)責(zé)任的表現(xiàn)。catch 時(shí)請分清穩(wěn)定代碼和非穩(wěn)
    定代碼,穩(wěn)定代碼指的是無論如何不會出錯(cuò)的代碼。對于非穩(wěn)定代碼的 catch 盡可能進(jìn)行區(qū)分
    異常類型,再做對應(yīng)的異常處理。
  4. 【強(qiáng)制】捕獲異常是為了處理它,不要捕獲了卻什么都不處理而拋棄之,如果不想處理它,請
    將該異常拋給它的調(diào)用者。最外層的業(yè)務(wù)使用者,必須處理異常,將其轉(zhuǎn)化為用戶可以理解的
    內(nèi)容。
  5. 【強(qiáng)制】有 try 塊放到了事務(wù)代碼中,catch 異常后,如果需要回滾事務(wù),一定要注意手動(dòng)回
    滾事務(wù)。
  6. 【強(qiáng)制】finally 塊必須對資源對象、流對象進(jìn)行關(guān)閉,有異常也要做 try-catch。
    說明:如果 JDK7,可以使用 try-with-resources 方式。
  7. 【強(qiáng)制】不能在 finally 塊中使用 return,finally 塊中的 return 返回后方法結(jié)束執(zhí)行,不
    會再執(zhí)行 try 塊中的 return 語句。
  8. 【強(qiáng)制】捕獲異常與拋異常,必須是完全匹配,或者捕獲異常是拋異常的父類。
    說明:如果預(yù)期對方拋的是繡球,實(shí)際接到的是鉛球,就會產(chǎn)生意外情況。
  9. 【推薦】方法的返回值可以為 null,不強(qiáng)制返回空集合,或者空對象等,必須添加注釋充分
    說明什么情況下會返回 null 值。調(diào)用方需要進(jìn)行 null 判斷防止 NPE 問題。
    說明:本規(guī)約明確防止 NPE 是調(diào)用者的責(zé)任。即使被調(diào)用方法返回空集合或者空對象,對調(diào)用
    者來說,也并非高枕無憂,必須考慮到遠(yuǎn)程調(diào)用失敗,運(yùn)行時(shí)異常等場景返回 null 的情況。
  10. 【推薦】防止 NPE,是程序員的基本修養(yǎng),注意 NPE 產(chǎn)生的場景:
    1) 返回類型為包裝數(shù)據(jù)類型,有可能是 null,返回 int 值時(shí)注意判空。
    反例:public int f(){ return Integer 對象}; 如果為 null,自動(dòng)解箱拋 NPE。
    2) 數(shù)據(jù)庫的查詢結(jié)果可能為 null。
    3) 集合里的元素即使 isNotEmpty,取出的數(shù)據(jù)元素也可能為 null。
    4) 遠(yuǎn)程調(diào)用返回對象,一律要求進(jìn)行 NPE 判斷。
    5) 對于 Session 中獲取的數(shù)據(jù),建議 NPE 檢查,避免空指針。
    6) 級聯(lián)調(diào)用 obj.getA().getB().getC();一連串調(diào)用,易產(chǎn)生 NPE。
  11. 【推薦】在代碼中使用“拋異?!边€是“返回錯(cuò)誤碼”,對于公司外的 http/api 開放接口必須
    使用“錯(cuò)誤碼”;而應(yīng)用內(nèi)部推薦異常拋出;跨應(yīng)用間 RPC 調(diào)用優(yōu)先考慮使用 Result 方式,封
    裝 isSuccess、“錯(cuò)誤碼”、“錯(cuò)誤簡短信息”。
    說明:關(guān)于 RPC 方法返回方式使用 Result 方式的理由:
    1)使用拋異常返回方式,調(diào)用方如果沒有捕獲到就會產(chǎn)生運(yùn)行時(shí)錯(cuò)誤。
    2)如果不加棧信息,只是 new 自定義異常,加入自己的理解的 error message,對于調(diào)用
    端解決問題的幫助不會太多。如果加了棧信息,在頻繁調(diào)用出錯(cuò)的情況下,數(shù)據(jù)序列化和傳輸
    的性能損耗也是問題。
  12. 【推薦】定義時(shí)區(qū)分 unchecked / checked 異常,避免直接使用 RuntimeException 拋出,
    更不允許拋出 Exception 或者 Throwable,應(yīng)使用有業(yè)務(wù)含義的自定義異常。推薦業(yè)界已定義
    過的自定義異常,如:DAOException / ServiceException 等。
  13. 【參考】避免出現(xiàn)重復(fù)的代碼(Don’t Repeat Yourself),即 DRY 原則。
    說明:隨意復(fù)制和粘貼代碼,必然會導(dǎo)致代碼的重復(fù),在以后需要修改時(shí),需要修改所有的副
    本,容易遺漏。必要時(shí)抽取共性方法,或者抽象公共類,甚至是共用模塊。
    正例:一個(gè)類中有多個(gè) public 方法,都需要進(jìn)行數(shù)行相同的參數(shù)校驗(yàn)操作,這個(gè)時(shí)候請抽?。?br> private boolean checkParam(DTO dto){...}

(二)日志規(guī)約

  1. 【強(qiáng)制】應(yīng)用中不可直接使用日志系統(tǒng)(Log4j、Logback)中的 API,而應(yīng)依賴使用日志框架
    SLF4J 中的 API,使用門面模式的日志框架,有利于維護(hù)和各個(gè)類的日志處理方式統(tǒng)一。
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    private static final Logger logger = LoggerFactory.getLogger(Abc.class);
  2. 【強(qiáng)制】日志文件推薦至少保存 15 天,因?yàn)橛行┊惓>邆湟浴爸堋睘轭l次發(fā)生的特點(diǎn)。
  3. 【強(qiáng)制】應(yīng)用中的擴(kuò)展日志(如打點(diǎn)、臨時(shí)監(jiān)控、訪問日志等)命名方式:
    appName_logType_logName.log。logType:日志類型,推薦分類有
    stats/desc/monitor/visit 等;logName:日志?述。這種命名的好處:通過文件名就可知
    道日志文件屬于什么應(yīng)用,什么類型,什么目的,也有利于歸類查找。
    正例:mppserver 應(yīng)用中單獨(dú)監(jiān)控時(shí)區(qū)轉(zhuǎn)換異常,如:
    mppserver_monitor_timeZoneConvert.log
    說明:推薦對日志進(jìn)行分類,錯(cuò)誤日志和業(yè)務(wù)日志盡量分開存放,便于開發(fā)人員查看,也便于
    通過日志對系統(tǒng)進(jìn)行及時(shí)監(jiān)控。
  4. 【強(qiáng)制】對 trace/debug/info 級別的日志輸出,必須使用條件輸出形式或者使用占位符的方
    式。
    說明:logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
    如果日志級別是 warn,上述日志不會打印,但是會執(zhí)行字符串拼接操作,如果 symbol 是對象,
    會執(zhí)行 toString()方法,浪費(fèi)了系統(tǒng)資源,執(zhí)行了上述操作,最終日志卻沒有打印。
    正例:(條件)
    if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
    }
    正例:(占位符)
    logger.debug("Processing trade with id: {} symbol : {} ", id, symbol);
  5. 【強(qiáng)制】避免重復(fù)打印日志,浪費(fèi)磁盤空間,務(wù)必在 log4j.xml 中設(shè)置 additivity=false。
    正例:<logger name="com.taobao.dubbo.config" additivity="false">
  6. 【強(qiáng)制】異常信息應(yīng)該包括兩類信息:案發(fā)現(xiàn)場信息和異常堆棧信息。如果不處理,那么往上
    拋。
    正例:logger.error(各類參數(shù)或者對象 toString + "_" + e.getMessage(), e);
  7. 【推薦】可以使用 warn 日志級別來記錄用戶輸入?yún)?shù)錯(cuò)誤的情況,避免用戶投訴時(shí),無所適
    從。注意日志輸出的級別,error 級別只記錄系統(tǒng)邏輯出錯(cuò)、異常等重要的錯(cuò)誤信息。如非必
    要,請不要在此場景打出 error 級別。
  8. 【推薦】謹(jǐn)慎地記錄日志。生產(chǎn)環(huán)境禁止輸出 debug 日志;有選擇地輸出 info 日志;如果使
    用 warn 來記錄剛上線時(shí)的業(yè)務(wù)行為信息,一定要注意日志輸出量的問題,避免把服務(wù)器磁盤
    撐爆,并記得及時(shí)刪除這些觀察日志。
    說明:大量地輸出無效日志,不利于系統(tǒng)性能?升,也不利于快速定位錯(cuò)誤點(diǎn)。記錄日志時(shí)請
    思考:這些日志真的有人看嗎?看到這條日志你能做什么?能不能給問題排查帶來好處?

三、MySQL 規(guī)約

(一)建表規(guī)約

  1. 【強(qiáng)制】表達(dá)是與否概念的字段,必須使用 is_xxx 的方式命名,數(shù)據(jù)類型是 unsigned tinyint
    ( 1 表示是,0 表示否),此規(guī)則同樣適用于 odps 建表。
    說明:任何字段如果為非負(fù)數(shù),必須是 unsigned。
  2. 【強(qiáng)制】表名、字段名必須使用小寫字母或數(shù)字;禁止出現(xiàn)數(shù)字開頭,禁止兩個(gè)下劃線中間只
    出現(xiàn)數(shù)字。數(shù)據(jù)庫字段名的修改代價(jià)很大,因?yàn)闊o法進(jìn)行預(yù)發(fā)布,所以字段名稱需要慎重考慮。
    正例:getter_admin,task_config,level3_name
    反例:GetterAdmin,taskConfig,level_3_name
  3. 【強(qiáng)制】表名不使用復(fù)數(shù)名詞。
    說明:表名應(yīng)該僅僅表示表里面的實(shí)體內(nèi)容,不應(yīng)該表示實(shí)體數(shù)量,對應(yīng)于 DO 類名也是單數(shù)
    形式,符合表達(dá)習(xí)慣。
  4. 【強(qiáng)制】禁用保留字,如 desc、range、match、delayed 等,請參考 MySQL 官方保留字。
  5. 【強(qiáng)制】唯一索引名為 uk_字段名;普通索引名則為 idx_字段名。
    說明:uk_ 即 unique key;idx_ 即 index 的簡稱。
  6. 【強(qiáng)制】小數(shù)類型為 decimal,禁止使用 float 和 double。
    說明:float 和 double 在存儲的時(shí)候,存在精度損失的問題,很可能在值的比較時(shí),得到不
    正確的結(jié)果。如果存儲的數(shù)據(jù)范圍超過 decimal 的范圍,建議將數(shù)據(jù)拆成整數(shù)和小數(shù)分開存儲。
  7. 【強(qiáng)制】如果存儲的字符串長度幾乎相等,使用 char 定長字符串類型。
  8. 【強(qiáng)制】varchar 是可變長字符串,不預(yù)先分配存儲空間,長度不要超過 5000,如果存儲長
    度大于此值,定義字段類型為 text,獨(dú)立出來一張表,用主鍵來對應(yīng),避免影響其它字段索
    引效率。
  9. 【強(qiáng)制】表必備三字段:id, gmt_create, gmt_modified。
    說明:其中 id 必為主鍵,類型為 unsigned bigint、單表時(shí)自增、步長為 1。gmt_create,
    gmt_modified 的類型均為 date_time 類型。
  10. 【推薦】表的命名最好是加上“業(yè)務(wù)名稱_表的作用”。
    正例:tiger_task / tiger_reader / mpp_config
  11. 【推薦】庫名與應(yīng)用名稱盡量一致。
  12. 【推薦】如果修改字段含義或?qū)ψ侄伪硎镜臓顟B(tài)追加時(shí),需要及時(shí)更新字段注釋。
  13. 【推薦】字段允許適當(dāng)冗余,以?高性能,但是必須考慮數(shù)據(jù)同步的情況。冗余字段應(yīng)遵循:
    1)不是頻繁修改的字段。
    2)不是 varchar 超長字段,更不能是 text 字段。
    正例:商品類目名稱使用頻率高,字段長度短,名稱基本一成不變,可在相關(guān)聯(lián)的表中冗余存
    儲類目名稱,避免關(guān)聯(lián)查詢。
  14. 【推薦】單表行數(shù)超過 500 萬行或者單表容量超過 2GB,才推薦進(jìn)行分庫分表。
    說明:如果預(yù)計(jì)三年后的數(shù)據(jù)量根本達(dá)不到這個(gè)級別,請不要在創(chuàng)建表時(shí)就分庫分表。
  15. 【參考】合適的字符存儲長度,不但節(jié)約數(shù)據(jù)庫表空間、節(jié)約索引存儲,更重要的是?升檢
    索速度。
    正例:人的年齡用 unsigned tinyint(表示范圍 0-255,人的壽命不會超過 255 歲);海龜
    就必須是 smallint,但如果是太陽的年齡,就必須是 int;如果是所有恒星的年齡都加起來,
    那么就必須使用 bigint。

(二)索引規(guī)約

  1. 【強(qiáng)制】業(yè)務(wù)上具有唯一特性的字段,即使是組合字段,也必須建成唯一索引。
    說明:不要以為唯一索引影響了 insert 速度,這個(gè)速度損耗可以忽略,但?高查找速度是明
    顯的;另外,即使在應(yīng)用層做了非常完善的校驗(yàn)和控制,只要沒有唯一索引,根據(jù)墨菲定律,
    必然有臟數(shù)據(jù)產(chǎn)生。
  2. 【強(qiáng)制】 超過三個(gè)表禁止 join。需要 join 的字段,數(shù)據(jù)類型保持絕對一致;多表關(guān)聯(lián)查詢
    時(shí),保證被關(guān)聯(lián)的字段需要有索引。
    說明:即使雙表 join 也要注意表索引、SQL 性能。
  3. 【強(qiáng)制】在 varchar 字段上建立索引時(shí),必須指定索引長度,沒必要對全字段建立索引,根據(jù)
    實(shí)際文本區(qū)分度決定索引長度。
    說明:索引的長度與區(qū)分度是一對矛盾體,一般對字符串類型數(shù)據(jù),長度為 20 的索引,區(qū)分
    度會高達(dá) 90%以上,可以使用 count(distinct left(列名, 索引長度))/count(*)的區(qū)分度
    來確定。
  4. 【強(qiáng)制】頁面搜索嚴(yán)禁左模糊或者全模糊,如果需要請走搜索引擎來解決。
    說明:索引文件具有 B-Tree 的最左前綴匹配特性,如果左邊的值未確定,那么無法使用此索
    引。
  5. 【推薦】如果有 order by 的場景,請注意利用索引的有序性。order by 最后的字段是組合
    索引的一部分,并且放在索引組合順序的最后,避免出現(xiàn) file_sort 的情況,影響查詢性能。
    正例:where a=? and b=? order by c; 索引:a_b_c
    反例:索引中有范圍查找,那么索引有序性無法利用,如:WHERE a>10 ORDER BY b; 索引
    a_b 無法排序。
  6. 【推薦】利用覆蓋索引來進(jìn)行查詢操作,來避免回表操作。
    說明:如果一本書需要知道第 11 章是什么標(biāo)題,會翻開第 11 章對應(yīng)的那一頁嗎?目錄瀏覽
    一下就好,這個(gè)目錄就是起到覆蓋索引的作用。
    正例:能夠建立索引的種類:主鍵索引、唯一索引、普通索引,而覆蓋索引是一種查詢的一種
    效果,用 explain 的結(jié)果,extra 列會出現(xiàn):using index。
  7. 【推薦】利用延遲關(guān)聯(lián)或者子查詢優(yōu)化超多分頁場景。
    說明:MySQL 并不是跳過 offset 行,而是取 offset+N 行,然后返回放棄前 offset 行,返回
    N 行,那當(dāng) offset 特別大的時(shí)候,效率就非常的低下,要么控制返回的總頁數(shù),要么對超過
    特定閾值的頁數(shù)進(jìn)行 SQL 改寫。
    正例:先快速定位需要獲取的 id 段,然后再關(guān)聯(lián):
    SELECT a.* FROM 表 1 a, (select id from 表 1 where 條件 LIMIT 100000,20 ) b where a.id=b.id
  8. 【推薦】SQL 性能優(yōu)化的目標(biāo):至少要達(dá)到 range 級別,要求是 ref 級別,如果可以是 consts
    最好。
    說明:
    1)consts 單表中最多只有一個(gè)匹配行(主鍵或者唯一索引),在優(yōu)化階段即可讀取到數(shù)據(jù)。
    2)ref 指的是使用普通的索引(normal index)。
    3)range 對索引進(jìn)行范圍檢索。
    反例:explain 表的結(jié)果,type=index,索引物理文件全掃?,速度非常慢,這個(gè) index 級
    別比較 range 還低,與全表掃?是小巫見大巫。
  9. 【推薦】建組合索引的時(shí)候,區(qū)分度最高的在最左邊。
    正例:如果 where a=? and b=? ,a 列的幾乎接近于唯一值,那么只需要單建 idx_a 索引即
    可。
    說明:存在非等號和等號混合判斷條件時(shí),在建索引時(shí),請把等號條件的列前置。如:where a>?
    and b=? 那么即使 a 的區(qū)分度更高,也必須把 b 放在索引的最前列。
  10. 【參考】創(chuàng)建索引時(shí)避免有如下極端誤解:
    1)誤認(rèn)為一個(gè)查詢就需要建一個(gè)索引。
    2)誤認(rèn)為索引會消耗空間、嚴(yán)重拖慢更新和新增速度。
    3)誤認(rèn)為唯一索引一律需要在應(yīng)用層通過“先查后插”方式解決。

(三)SQL 規(guī)約

  1. 【強(qiáng)制】不要使用 count(列名)或 count(常量)來替代 count(),count()就是 SQL92 定義
    的標(biāo)準(zhǔn)統(tǒng)計(jì)行數(shù)的語法,跟數(shù)據(jù)庫無關(guān),跟 NULL 和非 NULL 無關(guān)。
    說明:count(*)會統(tǒng)計(jì)值為 NULL 的行,而 count(列名)不會統(tǒng)計(jì)此列為 NULL 值的行。
  2. 【強(qiáng)制】count(distinct col) 計(jì)算該列除 NULL 之外的不重復(fù)數(shù)量。注意 count(distinct
    col1, col2) 如果其中一列全為 NULL,那么即使另一列有不同的值,也返回為 0。
  3. 【強(qiáng)制】當(dāng)某一列的值全是 NULL 時(shí),count(col)的返回結(jié)果為 0,但 sum(col)的返回結(jié)果為
    NULL,因此使用 sum()時(shí)需注意 NPE 問題。
    正例:可以使用如下方式來避免 sum 的 NPE 問題:SELECT IF(ISNULL(SUM(g)),0,SUM(g))
    FROM table;
  4. 【強(qiáng)制】使用 ISNULL()來判斷是否為 NULL 值。注意:NULL 與任何值的直接比較都為 NULL。
    說明:
    1) NULL<>NULL 的返回結(jié)果是 NULL,而不是 false。
    2) NULL=NULL 的返回結(jié)果是 NULL,而不是 true。
    3) NULL<>1 的返回結(jié)果是 NULL,而不是 true。
  5. 【強(qiáng)制】在代碼中寫分頁查詢邏輯時(shí),若 count 為 0 應(yīng)直接返回,避免執(zhí)行后面的分頁語句。
  6. 【強(qiáng)制】不得使用外鍵與級聯(lián),一切外鍵概念必須在應(yīng)用層解決。
    說明:(概念解釋)學(xué)生表中的 student_id 是主鍵,那么成績表中的 student_id 則為外鍵。
    如果更新學(xué)生表中的 student_id,同時(shí)觸發(fā)成績表中的 student_id 更新,則為級聯(lián)更新。
    外鍵與級聯(lián)更新適用于單機(jī)低并發(fā),不適合分布式、高并發(fā)集群;級聯(lián)更新是強(qiáng)阻塞,存在數(shù)
    據(jù)庫更新風(fēng)暴的風(fēng)險(xiǎn);外鍵影響數(shù)據(jù)庫的插入速度。
  7. 【強(qiáng)制】禁止使用存儲過程,存儲過程難以調(diào)試和擴(kuò)展,更沒有移植性。
  8. 【強(qiáng)制】數(shù)據(jù)訂正時(shí),刪除和修改記錄時(shí),要先 select,避免出現(xiàn)誤刪除,確認(rèn)無誤才能執(zhí)
    行更新語句。
  9. 【推薦】in 操作能避免則避免,若實(shí)在避免不了,需要仔細(xì)評估 in 后邊的集合元素?cái)?shù)量,控
    制在 1000 個(gè)之內(nèi)。
  10. 【參考】如果有全球化需要,所有的字符存儲與表示,均以 utf-8 編碼,那么字符計(jì)數(shù)方法
    注意:
    說明:
    SELECT LENGTH("輕松工作"); 返回為 12
    SELECT CHARACTER_LENGTH("輕松工作"); 返回為 4
    如果要使用表情,那么使用 utfmb4 來進(jìn)行存儲,注意它與 utf-8 編碼的區(qū)別。
  11. 【參考】TRUNCATE TABLE 比 DELETE 速度快,且使用的系統(tǒng)和事務(wù)日志資源少,但 TRUNCATE
    無事務(wù)且不觸發(fā) trigger,有可能造成事故,故不建議在開發(fā)代碼中使用此語句。
    說明:TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。
    (四)ORM 規(guī)約
  12. 【強(qiáng)制】在表查詢中,一律不要使用 * 作為查詢的字段列表,需要哪些字段必須明確寫明。
    說明:1)增加查詢分析器解析成本。2)增減字段容易與 resultMap 配置不一致。
  13. 【強(qiáng)制】POJO 類的 boolean 屬性不能加 is,而數(shù)據(jù)庫字段必須加 is_,要求在 resultMap 中
    進(jìn)行字段與屬性之間的映射。
    說明:參見定義 POJO 類以及數(shù)據(jù)庫字段定義規(guī)定,在 sql.xml 增加映射,是必須的。
  14. 【強(qiáng)制】不要用 resultClass 當(dāng)返回參數(shù),即使所有類屬性名與數(shù)據(jù)庫字段一一對應(yīng),也需
    要定義;反過來,每一個(gè)表也必然有一個(gè)與之對應(yīng)。
    說明:配置映射關(guān)系,使字段與 DO 類解耦,方便維護(hù)。
  15. 【強(qiáng)制】xml 配置中參數(shù)注意使用:#{},#param# 不要使用${} 此種方式容易出現(xiàn) SQL 注
    入。
  16. 【強(qiáng)制】iBATIS 自帶的 queryForList(String statementName,int start,int size)不推
    薦使用。
    說明:其實(shí)現(xiàn)方式是在數(shù)據(jù)庫取到statementName對應(yīng)的SQL語句的所有記錄,再通過subList
    取 start,size 的子集合,線上因?yàn)檫@個(gè)原因曾經(jīng)出現(xiàn)過 OOM。
    正例:在 sqlmap.xml 中引入 #start#, #size#
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("start", start);
    map.put("size", size);
  17. 【強(qiáng)制】不允許直接拿 HashMap 與 Hashtable 作為查詢結(jié)果集的輸出。
  18. 【強(qiáng)制】更新數(shù)據(jù)表記錄時(shí),必須同時(shí)更新記錄對應(yīng)的 gmt_modified 字段值為當(dāng)前時(shí)間。
  19. 【推薦】不要寫一個(gè)大而全的數(shù)據(jù)更新接口,傳入為 POJO 類,不管是不是自己的目標(biāo)更新字
    段,都進(jìn)行 update table set c1=value1,c2=value2,c3=value3; 這是不對的。執(zhí)行 SQL
    時(shí),盡量不要更新無改動(dòng)的字段,一是易出錯(cuò);二是效率低;三是 binlog 增加存儲。
  20. 【參考】@Transactional 事務(wù)不要濫用。事務(wù)會影響數(shù)據(jù)庫的 QPS,另外使用事務(wù)的地方需
    要考慮各方面的回滾方案,包括緩存回滾、搜索引擎回滾、消息補(bǔ)償、統(tǒng)計(jì)修正等。
  21. 【參考】<isEqual>中的 compareValue 是與屬性值對比的常量,一般是數(shù)字,表示相等時(shí)帶
    上此條件;<isNotEmpty>表示不為空且不為 null 時(shí)執(zhí)行;<isNotNull>表示不為 null 值時(shí)
    執(zhí)行。

四、工程規(guī)約

(一)應(yīng)用分層

  1. 【推薦】圖中默認(rèn)上層依賴于下層,箭頭關(guān)系表示可直接依賴,如:開放接口層可以依賴于
    Web 層,也可以直接依賴于 Service 層,依此類推:
    x 開放接口層:可直接封裝 Service 接口暴露成 RPC 接口;通過 Web 封裝成 http 接口;網(wǎng)關(guān)控
    制層等。
    x 終端顯示層:各個(gè)端的模板渲染并執(zhí)行顯示層。當(dāng)前主要是 velocity 渲染,JS 渲染,JSP 渲
    染,移動(dòng)端展示層等。
    x Web 層:主要是對訪問控制進(jìn)行轉(zhuǎn)發(fā),各類基本參數(shù)校驗(yàn),或者不復(fù)用的業(yè)務(wù)簡單處理等。
    x Service 層:相對具體的業(yè)務(wù)邏輯服務(wù)層。
    x Manager 層:通用業(yè)務(wù)處理層,它有如下特征:
    1) 對第三方平臺封裝的層,預(yù)處理返回結(jié)果及轉(zhuǎn)化異常信息;
    2) 對 Service 層通用能力的下沉,如緩存方案、中間件通用處理;
    3) 與 DAO 層交互,對 DAO 的業(yè)務(wù)通用能力的封裝。
    x DAO 層:數(shù)據(jù)訪問層,與底層 MySQL、Oracle、Hbase 進(jìn)行數(shù)據(jù)交互。
    x 外部接口或第三方平臺:包括其它部門 RPC 開放接口,基礎(chǔ)平臺,其它公司的 HTTP 接口。
  2. 【參考】 (分層異常處理規(guī)約)在 DAO 層,產(chǎn)生的異常類型有很多,無法用細(xì)粒度異常進(jìn)行
    catch,使用 catch(Exception e)方式,并 throw new DAOException(e),不需要打印日志,
    因?yàn)槿罩驹?Manager/Service 層一定需要捕獲并打到日志文件中去,如果同臺服務(wù)器再打日
    志,浪費(fèi)性能和存儲。在 Service 層出現(xiàn)異常時(shí),必須記錄日志信息到磁盤,盡可能帶上參數(shù)
    信息,相當(dāng)于保護(hù)案發(fā)現(xiàn)場。如果 Manager 層與 Service 同機(jī)部署,日志方式與 DAO 層處理
    一致,如果是單獨(dú)部署,則采用與 Service 一致的處理方式。Web 層絕不應(yīng)該繼續(xù)往上拋異常,
    因?yàn)橐呀?jīng)處于頂層,無繼續(xù)處理異常的方式,如果意識到這個(gè)異常將導(dǎo)致頁面無法正常渲染,
    那么就應(yīng)該直接跳轉(zhuǎn)到友好錯(cuò)誤頁面,盡量加上友好的錯(cuò)誤?示信息。開放接口層要將異常處
    理成錯(cuò)誤碼和錯(cuò)誤信息方式返回。
  3. 【參考】分層領(lǐng)域模型規(guī)約:
    x DO(Data Object):與數(shù)據(jù)庫表結(jié)構(gòu)一一對應(yīng),通過 DAO 層向上傳輸數(shù)據(jù)源對象。
    x DTO(Data Transfer Object):數(shù)據(jù)傳輸對象,Service 和 Manager 向外傳輸?shù)膶ο蟆?br> x BO(Business Object):業(yè)務(wù)對象。可以由 Service 層輸出的封裝業(yè)務(wù)邏輯的對象。
    x QUERY:數(shù)據(jù)查詢對象,各層接收上層的查詢請求。注:超過 2 個(gè)參數(shù)的查詢封裝,禁止
    使用 Map 類來傳輸。
    x VO(View Object):顯示層對象,通常是 Web 向模板渲染引擎層傳輸?shù)膶ο蟆?/li>

(二)二方庫規(guī)約

  1. 【強(qiáng)制】定義 GAV 遵從以下規(guī)則:
    1) GroupID 格式:com.{公司/BU }.業(yè)務(wù)線.[子業(yè)務(wù)線],最多 4 級。
    說明:{公司/BU} 例如:alibaba/taobao/tmall/aliexpress 等 BU 一級;子業(yè)務(wù)線可選。
    正例:com.taobao.jstorm 或 com.alibaba.dubbo.register
    2) ArtifactID 格式:產(chǎn)品線名-模塊名。語義不重復(fù)不遺漏,先到倉庫中心去查證一下。
    正例:dubbo-client / fastjson-api / jstorm-tool
    3) Version:詳細(xì)規(guī)定參考下方。
  2. 【強(qiáng)制】二方庫版本號命名方式:主版本號.次版本號.修訂號
    1) 主版本號:當(dāng)做了不兼容的 API 修改,或者增加了能改變產(chǎn)品方向的新功能。
    2) 次版本號:當(dāng)做了向下兼容的功能性新增(新增類、接口等)。
    3) 修訂號:修復(fù) bug,沒有修改方法簽名的功能加強(qiáng),保持 API 兼容性。
    說明:起始版本號必須為:1.0.0,而不是 0.0.1
  3. 【強(qiáng)制】線上應(yīng)用不要依賴 SNAPSHOT 版本(安全包除外);正式發(fā)布的類庫必須使用 RELEASE
    版本號升級+1 的方式,且版本號不允許覆蓋升級,必須去中央倉庫進(jìn)行查證。
    說明:不依賴 SNAPSHOT 版本是保證應(yīng)用發(fā)布的冪等性。另外,也可以加快編譯時(shí)的打包構(gòu)建。
  4. 【強(qiáng)制】二方庫的新增或升級,保持除功能點(diǎn)之外的其它 jar 包仲裁結(jié)果不變。如果有改變,
    必須明確評估和驗(yàn)證,建議進(jìn)行 dependency:resolve 前后信息比對,如果仲裁結(jié)果完全不一
    致,那么通過 dependency:tree 命令,找出差異點(diǎn),進(jìn)行<excludes>排除 jar 包。
  5. 【強(qiáng)制】二方庫里可以定義枚舉類型,參數(shù)可以使用枚舉類型,但是接口返回值不允許使用枚
    舉類型或者包含枚舉類型的 POJO 對象。
  6. 【強(qiáng)制】依賴于一個(gè)二方庫群時(shí),必須定義一個(gè)統(tǒng)一版本變量,避免版本號不一致。
    說明:依賴 springframework-core,-context,-beans,它們都是同一個(gè)版本,可以定義一
    個(gè)變量來保存版本:${spring.version},定義依賴的時(shí)候,引用該版本。
  7. 【強(qiáng)制】禁止在子項(xiàng)目的 pom 依賴中出現(xiàn)相同的 GroupId,相同的 ArtifactId,但是不同的
    Version。
    說明:在本地調(diào)試時(shí)會使用各子項(xiàng)目指定的版本號,但是合并成一個(gè) war,只能有一個(gè)版本號
    出現(xiàn)在最后的 lib 目錄中。曾經(jīng)出現(xiàn)過線下調(diào)試是正確的,發(fā)布到線上出故障的先例。
  8. 【推薦】所有 pom 文件中的依賴聲明放在<dependencies>語句塊中,所有版本仲裁放在
    <dependencyManagement>語句塊中。
    說明:<dependencyManagement>里只是聲明版本,并不實(shí)現(xiàn)引入,因此子項(xiàng)目需要顯式的聲
    明依賴,version 和 scope 都讀取自父 pom。而<dependencies>所有聲明在主 pom 的
    <dependencies>里的依賴都會自動(dòng)引入,并默認(rèn)被所有的子項(xiàng)目繼承。
  9. 【推薦】二方庫盡量不要有配置項(xiàng),最低限度不要再增加配置項(xiàng)。
  10. 【參考】為避免應(yīng)用二方庫的依賴沖突問題,二方庫發(fā)布者應(yīng)當(dāng)遵循以下原則:
    1)精簡可控原則。移除一切不必要的 API 和依賴,只包含 Service API、必要的領(lǐng)域模型對
    象、Utils 類、常量、枚舉等。如果依賴其它二方庫,盡量是 provided 引入,讓二方庫使用
    者去依賴具體版本號;無 log 具體實(shí)現(xiàn),只依賴日志框架。
    2)穩(wěn)定可追溯原則。每個(gè)版本的變化應(yīng)該被記錄,二方庫由誰維護(hù),源碼在哪里,都需要能
    方便查到。除非用戶主動(dòng)升級版本,否則公共二方庫的行為不應(yīng)該發(fā)生變化。
    (三)服務(wù)器規(guī)約
  11. 【推薦】高并發(fā)服務(wù)器建議調(diào)小 TCP 協(xié)議的 time_wait 超時(shí)時(shí)間。
    說明:操作系統(tǒng)默認(rèn) 240 秒后,才會關(guān)閉處于 time_wait 狀態(tài)的連接,在高并發(fā)訪問下,服
    務(wù)器端會因?yàn)樘幱?time_wait 的連接數(shù)太多,可能無法建立新的連接,所以需要在服務(wù)器上
    調(diào)小此等待值。
    正例:在 linux 服務(wù)器上請通過變更/etc/sysctl.conf 文件去修改該缺省值(秒):
    net.ipv4.tcp_fin_timeout = 30
  12. 【推薦】調(diào)大服務(wù)器所支持的最大文件句柄數(shù)(File Descriptor,簡寫為 fd)。
    說明:主流操作系統(tǒng)的設(shè)計(jì)是將 TCP/UDP 連接采用與文件一樣的方式去管理,即一個(gè)連接對
    應(yīng)于一個(gè) fd。主流的 linux 服務(wù)器默認(rèn)所支持最大 fd 數(shù)量為 1024,當(dāng)并發(fā)連接數(shù)很大時(shí)很
    容易因?yàn)?fd 不足而出現(xiàn)“open too many files”錯(cuò)誤,導(dǎo)致新的連接無法建立。 建議將 linux
    服務(wù)器所支持的最大句柄數(shù)調(diào)高數(shù)倍(與服務(wù)器的內(nèi)存數(shù)量相關(guān))。
  13. 【推薦】給 JVM 設(shè)置-XX:+HeapDumpOnOutOfMemoryError 參數(shù),讓 JVM 碰到 OOM 場景時(shí)輸出
    dump 信息。
    說明:OOM 的發(fā)生是有概率的,甚至有規(guī)律地相隔數(shù)月才出現(xiàn)一例,出現(xiàn)時(shí)的現(xiàn)場信息對查錯(cuò)
    非常有價(jià)值。
  14. 【參考】服務(wù)器內(nèi)部重定向使用 forward;外部重定向地址使用 URL 拼裝工具類來生成,否則
    會帶來 URL 維護(hù)不一致的問題和潛在的安全風(fēng)險(xiǎn)。

五、安全規(guī)約

  1. 【強(qiáng)制】隸屬于用戶個(gè)人的頁面或者功能必須進(jìn)行權(quán)限控制校驗(yàn)。
    說明:防止沒有做水平權(quán)限校驗(yàn)就可隨意訪問、操作別人的數(shù)據(jù),比如查看、修改別人的訂單。
  2. 【強(qiáng)制】用戶敏感數(shù)據(jù)禁止直接展示,必須對展示數(shù)據(jù)脫敏。
    說明:查看個(gè)人手機(jī)號碼會顯示成:158****9119,隱藏中間 4 位,防止隱私泄露。
  3. 【強(qiáng)制】用戶輸入的 SQL 參數(shù)嚴(yán)格使用參數(shù)綁定或者 METADATA 字段值限定,防止 SQL 注入,
    禁止字符串拼接 SQL 訪問數(shù)據(jù)庫。
  4. 【強(qiáng)制】用戶請求傳入的任何參數(shù)必須做有效性驗(yàn)證。
    說明:忽略參數(shù)校驗(yàn)可能導(dǎo)致:
    z page size 過大導(dǎo)致內(nèi)存溢出
    z 惡意 order by 導(dǎo)致數(shù)據(jù)庫慢查詢
    z 任意重定向
    z SQL 注入
    z 反序列化注入
    z 正則輸入源串拒絕服務(wù) ReDoS
    說明:Java 代碼用正則來驗(yàn)證客戶端的輸入,有些正則寫法驗(yàn)證普通用戶輸入沒有問題,
    但是如果攻擊人員使用的是特殊構(gòu)造的字符串來驗(yàn)證,有可能導(dǎo)致死循環(huán)的效果。
  5. 【強(qiáng)制】禁止向 HTML 頁面輸出未經(jīng)安全過濾或未正確轉(zhuǎn)義的用戶數(shù)據(jù)。
  6. 【強(qiáng)制】表單、AJAX ?交必須執(zhí)行 CSRF 安全過濾。
    說明:CSRF(Cross-site request forgery)跨站請求偽造是一類常見編程漏洞。對于存在
    CSRF 漏洞的應(yīng)用/網(wǎng)站,攻擊者可以事先構(gòu)造好 URL,只要受害者用戶一訪問,后臺便在用戶
    不知情情況下對數(shù)據(jù)庫中用戶參數(shù)進(jìn)行相應(yīng)修改。
  7. 【強(qiáng)制】在使用平臺資源,譬如短信、郵件、電話、下單、支付,必須實(shí)現(xiàn)正確的防重放限制,
    如數(shù)量限制、疲勞度控制、驗(yàn)證碼校驗(yàn),避免被濫刷、資損。
    說明:如注冊時(shí)發(fā)送驗(yàn)證碼到手機(jī),如果沒有限制次數(shù)和頻率,那么可以利用此功能騷擾到其
    它用戶,并造成短信平臺資源浪費(fèi)。
  8. 【推薦】發(fā)貼、評論、發(fā)送即時(shí)消息等用戶生成內(nèi)容的場景必須實(shí)現(xiàn)防刷、文本內(nèi)容違禁詞過
    濾等風(fēng)控策略。
    法律聲明:本手冊為阿里巴巴集團(tuán)技術(shù)部的技術(shù)分享,版權(quán)歸阿里巴巴集團(tuán)所有,僅供大家
    交流、學(xué)習(xí)及研究使用,禁止用于商業(yè)用途,違者必究。
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。