Java開發規範

命名

【規範】類名使用UpperCamelCase 風格，必須遵從駝峰形式，但以下情形例外： （ 領域模型的相關命名 ）DO / BO / DTO / VO 等。 正例： MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例： macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion 【規範】方法名、引數名、成員變數、區域性變數都統一使用lowerCamelCase 風格，必須遵從駝峰形式。 正例： localValue / getHttpMessage() / inputUserId 【規範】

常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。 【規範】抽象類命名使用 Abstract 或 Base 開頭 ； 異常類命名使用 Exception 結尾 ； 測試類命名以它要測試的類的名稱開始，以 Test 結尾。列舉類名建議帶上 Enum 字尾，列舉成員名稱需要全大寫，單詞間用下劃線隔開。 【規範】POJO 類中布林型別的變數，都不要加 is ，否則部分框架解析會引起序列化錯誤。 【規範】各層命名規約： A) Service / DAO 層方法命名規約 1 ） 獲取單個物件的方法用 get 做字首。 2 ） 獲取多個物件的方法用 list 做字首（習慣：getXXXList）。 3 ） 獲取統計值的方法用 count 做字首。 4 ） 插入的方法用 save（ 推薦 ） 或 insert 做字首。 5 ） 刪除的方法用 remove（ 推薦 ） 或 delete 做字首。 6 ） 修改的方法用 update 做字首(或modify)。 B) 領域模型命名規約 1 ） 資料物件： xxxDO ， xxx 即為資料表名。 2 ） 資料傳輸物件： xxxDTO ， xxx 為業務領域相關的名稱。 3 ） 展示物件： xxxVO ， xxx 一般為網頁名稱。 4 ） POJO 是 DO / DTO / BO / VO 的統稱，禁止命名成 xxxPOJO 。

常量

【規範】不允許任何魔法值（ 即未經定義的常量 ） 直接出現在程式碼中。 反例： String key =” Id # taobao _”+ tradeId； cache . put(key , value);

格式規約

【風格】單行太長需換行 【風格】方法體內的執行語句組、變數的定義語句組、不同的業務邏輯之間或者不同的語義之間插入一個空行。相同業務邏輯和語義之間不需要插入空行。

OOP規約

【效率】避免通過一個類的物件引用訪問此類的靜態變數或靜態方法，無謂增加編譯器解析成本，直接用類名來訪問即可。 【規範】所有的覆寫方法，必須加@ Override 註解。 【規範】

對外暴露的介面簽名，原則上不允許修改方法簽名，避免對介面呼叫方產生影響。介面過時必須加@Deprecated 註解，並清晰地說明採用的新介面或者新服務是什麼。 【規範】Object 的 equals 方法容易拋空指標異常，應使用常量或確定有值的物件來呼叫equals。 正例： ” test ” .equals(object); 反例： object.equals( ” test ” ); 【規範】所有的相同型別的包裝類物件之間值的比較，全部使用 equals 方法比較。(注意空指標) 說明：對於 Integer var =?在-128 至 127 之間的賦值， Integer 物件是在IntegerCache . cache 產生，會複用已有物件，這個區間內的 Integer 值可以直接使用==進行判斷，但是這個區間之外的所有資料，都會在堆上產生，並不會複用已有物件，這是一個大坑，推薦使用 equals 方法進行判斷。 【規範】關於基本資料型別與包裝資料型別的使用標準如下： 1 ） 所有的 POJO 類屬性必須使用包裝資料型別。 2 ） RPC 方法的返回值和引數必須使用包裝資料型別。 3 ） 所有的區域性變數【推薦】使用基本資料型別。 【強制】序列化類新增屬性時，請不要修改 serialVersionUID 欄位，避免反序列失敗 ； 如果完全不相容升級，避免反序列化混亂，那麼請修改 serialVersionUID 值。 【規範】構造方法裡面禁止加入任何業務邏輯，如果有初始化邏輯，請放在 init 方法中。 【規範】使用索引訪問用 String 的 split 方法得到的陣列時，需做最後一個分隔符後有無內容的檢查，否則會有拋 IndexOutOfBoundsException 的風險。 說明： String str = “a,b,c,,”; String[] ary = str.split(“,”); //預期大於 3，結果是 3 System.out.println(ary.length); 【規範】當一個類有多個構造方法，或者多個同名方法，這些方法應該按順序放置在一起，便於閱讀。 【風格】類內方法定義順序依次是：公有方法或保護方法 > 私有方法 > getter / setter方法。 【效率】final 可提高程式響應效率，宣告成 final 的情況： 1 ） 不需要重新賦值的變數，包括類屬性、區域性變數。 2 ） 物件引數前加 final ，表示不允許修改引用的指向。 3 ） 類方法確定不允許被重寫。 4 ）例子：final boolean existed = (file.open(fileName, “w”) != null) && (…) || (…);

集合處理

【強制】關於 hashCode 和 equals 的處理，遵循如下規則： 1） 只要重寫 equals ，就必須重寫 hashCode 。 2） 因為 Set 儲存的是不重複的物件，依據 hashCode 和 equals 進行判斷，所以 Set 儲存的物件必須重寫這兩個方法。 3） 如果自定義物件做為 Map 的鍵，那麼必須重寫 hashCode 和 equals 。 【強制】不要在 foreach 迴圈裡進行元素的 remove / add 操作。 remove 元素請使用 Iterator方式，如果併發操作，需要對 Iterator 物件加鎖。 反例： List<String> a = new ArrayList<String>(); a.add(“1”); a.add(“2”); for (String temp : a) { if(“1”.equals(temp)){ a.remove(temp); } } 說明：以上程式碼的執行結果肯定會出乎大家的意料，那麼試一下把“1”換成“2”，會是同樣的結果嗎？(java.util.ConcurrentModificationException) 正例： Iterator<String> it = a.iterator(); while(it.hasNext()){ String temp = it.next(); if(刪除元素的條件){ it.remove(); } } 【規範】集合初始化時，儘量指定集合初始值大小。 說明： ArrayList 儘量使用 ArrayList(int initialCapacity) 初始化。 【規範】使用 entrySet 遍歷 Map 類集合 KV，而不是 keySet 方式進行遍歷。 說明:keySet 其實是遍歷了 2 次，一次是轉為 Iterator 物件，另一次是從 hashMap 中取出 key 所對應的 value。而 entrySet 只是遍歷了一次就把 key 和 value 都放到了 entry 中，效 率更高。如果是 JDK8，使用 Map.foreach 方法。 Map<String, String> map = new HashMap<String, String>(); map.put(“1”, “@@”); map.put(“2”, “##”); /** * JDK8推薦使用 */ map.forEach((K, V) -> { System.out.println(“Key : ” + K); System.out.println(“Value : ” + V); }); /** * foreach推薦使用 */ for (Map.Entry<String, String> entry : map.entrySet()) { System.out.println(“Key : ” + entry.getKey()); System.out.println(“Value : ” + entry.getValue()); } /** * 不推薦使用 */ for (String key : map.keySet()) { System.out.println(“Key : ” + key); System.out.println(“Value : ” + map.get(key)); } 【強制】高度注意 Map 類集合 K/V 能不能儲存 null 值的情況，如下表格:

集合類	Key	Value	Super	說明
Hashtable	不允許為 null	不允許為 null	Dictionary	執行緒安全
ConcurrentHashMap	不允許為 null	不允許為 null	AbstractMap	分段鎖技術
TreeMap	不允許為 null	允許為 null	AbstractMap	執行緒不安全
HashMap	允許為 null	允許為 null	AbstractMap	執行緒不安全

併發處理

【規範】獲取單例物件需要保證執行緒安全，其中的方法也要保證執行緒安全。 說明:資源驅動類、工具類、單例工廠類都需要注意。 【規範】建立執行緒或執行緒池時請指定有意義的執行緒名稱，方便出錯時回溯。 正例: public class TimerTaskThread extends Thread { public TimerTaskThread(){ super.setName(“TimerTaskThread”); … } 【規範】執行緒資源必須通過執行緒池提供，不允許在應用中自行顯式建立執行緒。 說明:使用執行緒池的好處是減少在建立和銷燬執行緒上所花的時間以及系統資源的開銷，解決資 源不足的問題。如果不使用執行緒池，有可能造成系統建立大量同類執行緒而導致消耗完記憶體或者 “過度切換”的問題。 【規範】執行緒池不允許使用 Executors 去建立，而是通過 ThreadPoolExecutor 的方式，這樣 的處理方式讓寫的同學更加明確執行緒池的執行規則，規避資源耗盡的風險。 說明:Executors 返回的執行緒池物件的弊端如下: 1)FixedThreadPool 和 SingleThreadPool: 允許的請求佇列長度為 Integer.MAX_VALUE，可能會堆積大量的請求，從而導致 OOM。 2)CachedThreadPool 和 ScheduledThreadPool: 允許的建立執行緒數量為 Integer.MAX_VALUE，可能會建立大量的執行緒，從而導致 OOM。 【效率】高併發時，同步呼叫應該去考量鎖的效能損耗。能用無鎖資料結構，就不要用鎖;能 鎖區塊，就不要鎖整個方法體;能用物件鎖，就不要用類鎖。 【強制】對多個資源、資料庫表、物件同時加鎖時，需要保持一致的加鎖順序，否則可能會造 成死鎖。 說明:執行緒一需要對錶 A、B、C 依次全部加鎖後才可以進行更新操作，那麼執行緒二的加鎖順序 也必須是 A、B、C，否則可能出現死鎖。 【規範】併發修改同一記錄時，避免更新丟失，要麼在應用層加鎖，要麼在快取加鎖，要麼在 資料庫層使用樂觀鎖，使用 version 作為更新依據。 說明:如果每次訪問衝突概率小於 20%，推薦使用樂觀鎖，否則使用悲觀鎖。樂觀鎖的重試次 數不得小於 3 次。 【規範】多執行緒並行處理定時任務時，Timer 執行多個 TimeTask 時，只要其中之一沒有捕獲 丟擲的異常，其它任務便會自動終止執行，使用ScheduledExecutorService 則沒有這個問題。 【規範】HashMap 在容量不夠進行 resize 時由於高併發可能出現死鏈，導致 CPU 飆升，在 開發過程中注意規避此風險。

控制語句

【規範】在一個 switch 塊內，每個 case 要麼通過 break/return 等來終止，要麼註釋說明程 序將繼續執行到哪一個 case 為止;在一個 switch 塊內，都必須包含一個 default 語句並且 放在最後，即使它什麼程式碼也沒有。 【規範】在 if/else/for/while/do 語句中必須使用大括號，即使只有一行程式碼，避免使用 下面的形式:if (condition) statements; 【規範】推薦儘量少用 else， if-else 的方式可以改寫成: if(condition){ … return obj; } // 接著寫 else 的業務邏輯程式碼; 說明:如果非得使用if()…else if()…else…方式表達邏輯，【強制】請勿超過3層， 超過請使用狀態設計模式 或者 衛語句。 衛語句示例： [java] view plain copy print?

1. publicvoid today() { if (isBusy()) {  
2. System.out.println(“change time.”); return;  
3. }  
4. if (isFree()) {  
5. System.out.println(“go to travel.”);  
6. return;   
7. }  
8. System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);  
9. return;   
10. }  

public void today() { if (isBusy()) {
System.out.println(“change time.”); return;
}
if (isFree()) {
System.out.println(“go to travel.”);
return; 
}
System.out.println(“stay at home to learn Alibaba Java Coding Guidelines.”);
return; 
}

【規範】除常用方法(如 getXxx/isXxx)等外，不要在條件判斷中執行其它複雜的語句，將復 雜邏輯判斷的結果賦值給一個有意義的布林變數名，以提高可讀性。 說明:很多 if 語句內的邏輯相當複雜，閱讀者需要分析條件表示式的最終結果，才能明確什麼 樣的條件執行什麼樣的語句，那麼，如果閱讀者分析邏輯表示式錯誤呢? 正例: //虛擬碼如下 boolean existed = (file.open(fileName, “w”) != null) && (…) || (…); if (existed) { … } 反例: if ((file.open(fileName, “w”) != null) && (…) || (…)) { … } 【規範】方法中需要進行引數校驗的場景: 1) 呼叫頻次低的方法。 2) 執行時間開銷很大的方法，引數校驗時間幾乎可以忽略不計，但如果因為引數錯誤導致 中間執行回退，或者錯誤，那得不償失。 3) 需要極高穩定性和可用性的方法。 4) 對外提供的開放介面，不管是RPC/API/HTTP介面。 5) 敏感許可權入口。 【規範】方法中不需要引數校驗的場景: 1) 極有可能被迴圈呼叫的方法，不建議對引數進行校驗。但在方法說明裡必須註明外部參 數檢查。 2) 底層的方法呼叫頻度都比較高，一般不校驗。畢竟是像純淨水過濾的最後一道，引數錯誤不太可能到底層才會暴露問題。一般 DAO 層與 Service 層都在同一個應用中，部署在同一 臺伺服器中，所以 DAO 的引數校驗，可以省略。 3) 被宣告成private只會被自己程式碼所呼叫的方法，如果能夠確定呼叫方法的程式碼傳入參 數已經做過檢查或者肯定不會有問題，此時可以不校驗引數。

註釋規約

【規範】類、類屬性、類方法的註釋必須使用 Javadoc 規範，使用/**內容*/格式，不得使用 //xxx 方式。 【規範】所有的抽象方法(包括介面中的方法)必須要用 Javadoc 註釋、除了返回值、引數、 異常說明外，還必須指出該方法做什麼事情，實現什麼功能。 說明:對子類的實現要求，或者呼叫注意事項，請一併說明。 【風格】方法內部單行註釋，在被註釋語句上方另起一行，使用//註釋。方法內部多行註釋使用/* */註釋，注意與程式碼對齊。 【規範】所有的列舉型別欄位必須要有註釋，說明每個資料項的用途。 【規範】程式碼修改的同時，註釋也要進行相應的修改，尤其是引數、返回值、異常、核心邏輯 等的修改。 【規範】註釋掉的程式碼儘量要配合說明，而不是簡單的註釋掉。 說明:程式碼被註釋掉有兩種可能性: 1)後續會恢復此段程式碼邏輯。 2)永久不用。前者如果沒 有備註資訊，難以知曉註釋動機。 後者建議直接刪掉(程式碼倉庫儲存了歷史程式碼)。 【風格】特殊註釋標記，請註明標記人與標記時間。注意及時處理這些標記，通過標記掃描， 經常清理此類標記。線上故障有時候就是來源於這些標記處的程式碼。 1) 待辦事宜(TODO):( 標記人，標記時間，[預計處理時間]) 表示需要實現，但目前還未實現的功能。這實際上是一個 Javadoc 的標籤，目前的 Javadoc 還沒有實現，但已經被廣泛使用。只能應用於類，介面和方法(因為它是一個 Javadoc 標籤)。 2) 錯誤，不能工作(FIXME):(標記人，標記時間，[預計處理時間]) 在註釋中用 FIXME 標記某程式碼是錯誤的，而且不能工作，需要及時糾正的情況。

異常

【規範】異常不要用來做流程控制，條件控制，因為異常的處理效率比條件分支低。 【規範】對大段程式碼進行 try-catch，這是不負責任的表現。catch 時請分清穩定程式碼和非穩 定程式碼，穩定程式碼指的是無論如何不會出錯的程式碼。對於非穩定程式碼的 catch 儘可能進行區分 異常型別，再做對應的異常處理。 【規範】捕獲異常是為了處理它，不要捕獲了卻什麼都不處理而拋棄之，如果不想處理它，請 將該異常拋給它的呼叫者。最外層的業務使用者，必須處理異常，將其轉化為使用者可以理解的 內容。 【強制】有 try 塊放到了事務程式碼中，catch 異常後，如果需要回滾事務，一定要注意手動回 滾事務。 【規範】不能在 finally 塊中使用 return，finally 塊中的 return 返回後方法結束執行，不 會再執行 try 塊中的 return 語句。 【規範】方法的返回值可以為 null，不強制返回空集合，或者空物件等，必須添加註釋充分 說明什麼情況下會返回 null 值。呼叫方需要進行 null 判斷防止 NPE 問題。 【規範】防止 NPE，是程式設計師的基本修養，注意 NPE 產生的場景: 1) 返回型別為包裝資料型別，有可能是null，返回int值時注意判空。 反例:public int f(){ return Integer 物件}; 如果為 null，自動解箱拋 NPE。 2) 資料庫的查詢結果可能為null。 3) 集合裡的元素即使isNotEmpty，取出的資料元素也可能為null。 4) 遠端呼叫返回物件，一律要求進行NPE判斷。 5) 對於Session中獲取的資料，建議NPE檢查，避免空指標。 6) 級聯呼叫obj.getA().getB().getC();一連串呼叫，易產生NPE。 【規範】在程式碼中使用“拋異常”還是“返回錯誤碼”，對於公司外的 http/api 開放介面必須 使用“錯誤碼”;而應用內部推薦異常丟擲;跨應用間 RPC 呼叫優先考慮使用 Result 方式，封 裝 isSuccess、“錯誤碼”、“錯誤簡簡訊息”。 說明:關於 RPC 方法返回方式使用 Result 方式的理由: 1)使用拋異常返回方式，呼叫方如果沒有捕獲到就會產生執行時錯誤。 2)如果不加棧資訊，只是new自定義異常，加入自己的理解的error message，對於呼叫 端解決問題的幫助不會太多。如果加了棧資訊，在頻繁調用出錯的情況下，資料序列化和傳輸 的效能損耗也是問題。 【規範】避免出現重複的程式碼(Don’t Repeat Yourself)，即DRY原則。

日誌

【規範】應用中不可直接使用日誌系統(Log4j、Logback)中的 API，而應依賴使用日誌框架 SLF4J 中的 API，使用門面模式的日誌框架，有利於維護和各個類的日誌處理方式統一。 import org.slf4j.Logger; import org.slf4j.LoggerFactory; private static final Logger logger = LoggerFactory.getLogger(Abc.class); 【規範】日誌檔案推薦至少儲存 15 天，因為有些異常具備以“周”為頻次發生的特點。 【規範】應用中的擴充套件日誌(如打點、臨時監控、訪問日誌等)命名方式: appName_logType_logName.log。 logType:日誌型別，推薦分類有 stats/desc/monitor/visit 等; logName:日誌描述。這種命名的好處:通過檔名就可知 道日誌檔案屬於什麼應用，什麼型別，什麼目的，也有利於歸類查詢。 正例:mppserver 應用中單獨監控時區轉換異常，如: mppserver_monitor_timeZoneConvert.log 說明:推薦對日誌進行分類，錯誤日誌和業務日誌儘量分開存放，便於開發人員檢視，也便於 通過日誌對系統進行及時監控。 【規範】對 trace/debug/info 級別的日誌輸出，必須使用條件輸出形式或者使用佔位符的方式。 說明:logger.debug(“Processing trade with id: ” + id + ” symbol: ” + symbol); 如果日誌級別是 warn，上述日誌不會列印，但是會執行字串拼接操作，如果 symbol 是物件， 會執行 toString()方法，浪費了系統資源，執行了上述操作，最終日誌卻沒有列印。 正例:(條件) if (logger.isDebugEnabled()) { logger.debug(“Processing trade with id: ” + id + ” symbol: ” + symbol); } 正例:(佔位符) logger.debug(“Processing trade with id: {} symbol : {} “, id, symbol); * 避免重複列印日誌，浪費磁碟空間，務必在 log4j.xml 中設定 additivity=false。 正例:<logger name=”com.taobao.dubbo.config” additivity=”false”> 【規範】可以使用warn 日誌級別來記錄使用者輸入引數錯誤的情況，避免使用者投訴時，無所適 從。注意日誌輸出的級別，error 級別只記錄系統邏輯出錯、異常等重要的錯誤資訊。如非必 要，請不要在此場景打出 error 級別。 【規範】謹慎地記錄日誌。生產環境禁止輸出 debug 日誌;有選擇地輸出 info 日誌;如果使 用 warn 來記錄剛上線時的業務行為資訊，一定要注意日誌輸出量的問題，避免把伺服器磁碟 撐爆，並記得及時刪除這些觀察日誌。 說明:大量地輸出無效日誌，不利於系統性能提升，也不利於快速定位錯誤點。記錄日誌時請 思考:這些日誌真的有人看嗎?看到這條日誌你能做什麼?能不能給問題排查帶來好處?

其它

【效率】在使用正則表示式時，利用好其預編譯功能，可以有效加快正則匹配速度。 說明:不要在方法體內定義:Pattern pattern = Pattern.compile(規則); 【規範】獲取當前毫秒數 System.currentTimeMillis(); 而不是 new Date().getTime(); 說明:如果想獲取更加精確的納秒級時間值，用 System.nanoTime()。在 JDK8 中，針對統計 時間等場景，推薦使用Instant 類。 【規範】對於“明確停止使用的程式碼和配置”，如方法、變數、類、配置檔案、動態配置屬性等要堅決從程式中清理出去，避免造成過多垃圾。

單元測試

【強制】好的單元測試必須遵守 AIR 原則。

說明:單元測試在線上執行時，感覺像空氣(AIR)一樣並不存在，但在測試質量的保障上，卻是非常關鍵的。好的單元測試巨集觀上來說，具有自動化、獨立性、可重複執行的特點。
 A:Automatic(自動化)
 I:Independent(獨立性)

 R:Repeatable(可重複) 

【強制】單元測試應該是全自動執行的，並且非互動式的。測試框架通常是定期執行的，執行過程必須完全自動化才有意義。輸出結果需要人工檢查的測試不是一個好的單元測試。單元測 試中不準使用 System.out 來進行人肉驗證，必須使用 assert 來驗證。
【強制】保持單元測試的獨立性。為了保證單元測試穩定可靠且便於維護，單元測試用例之間 決不能互相呼叫，也不能依賴執行的先後次序。
反例:method2 需要依賴 method1 的執行，將執行結果做為 method2 的輸入。
【強制】對於單元測試，要保證測試粒度足夠小，有助於精確定位問題。單測粒度至多是類級別，一般是方法級別。  說明:只有測試粒度小才能在出錯時儘快定位到出錯位置。單測不負責檢查跨類或者跨系統的 互動邏輯，那是整合測試的領域。
【強制】核心業務、核心應用、核心模組的增量程式碼確保單元測試通過。  說明:新增程式碼及時補充單元測試，如果新增程式碼影響了原有單元測試，請及時修正。
【推薦】單元測試的基本目標:語句覆蓋率達到 70%;核心模組的語句覆蓋率和分支覆蓋率都 要達到 100%
說明:在工程規約的應用分層中提到的 DAO 層，Manager 層，可重用度高的 Service，都應該 進行單元測試。
【推薦】編寫單元測試程式碼遵守 BCDE 原則，以保證被測試模組的交付質量。
 B:Border，邊界值測試，包括迴圈邊界、特殊取值、特殊時間點、資料順序等。 C:Correct，正確的輸入，並得到預期的結果。  D:Design，與設計文件相結合，來編寫單元測試。
 E:Error，強制錯誤資訊輸入(如:非法資料、異常流程、非業務允許輸入等)，並得 到預期的結果。
【推薦】和資料庫相關的單元測試，可以設定自動回滾機制，不給資料庫造成髒資料。或者 對單元測試產生的資料有明確的前後綴標識。
正例:在 RDC 內部單元測試中，使用 RDC_UNIT_TEST_的字首標識資料。
【推薦】在設計評審階段，開發人員需要和測試人員一起確定單元測試範圍，單元測試最好 覆蓋所有測試用例(UC)。
【推薦】單元測試作為一種質量保障手段，不建議專案釋出後補充單元測試用例，建議在項 目提測前完成單元測試。
【參考】不要對單元測試存在如下誤解:
 那是測試同學乾的事情。本文是開發手冊，凡是本文內容都是與開發同學強相關的。 單元測試程式碼是多餘的。汽車的整體功能與各單元部件的測試正常與否是強相關的。  單元測試程式碼不需要維護。一年半載後，那麼單元測試幾乎處於廢棄狀態。
 單元測試與線上故障沒有辯證關係。好的單元測試能夠最大限度地規避線上故障。

MySQL開發規範

建表規約

【規範】表達是與否概念的欄位，必須使用 is_xxx 的方式命名，資料型別是 unsigned tinyint ( 1表示是，0表示否)，此規則同樣適用於odps建表。 說明:任何欄位如果為非負數，必須是 unsigned。 【規範】表名、欄位名必須使用小寫字母或數字;禁止出現數字開頭，禁止兩個下劃線中間只 出現數字。資料庫欄位名的修改代價很大，因為無法進行預釋出，所以欄位名稱需要慎重考慮。 正例:getter_admin，task_config，level3_name 反例:GetterAdmin，taskConfig，level_3_name 【規範】唯一索引名為 uk_欄位名;普通索引名則為 idx_欄位名。 【規範】小數型別為 decimal，禁止使用 float 和 double。 說明:float 和 double 在儲存的時候，存在精度損失的問題，很可能在值的比較時，得到不 正確的結果。如果儲存的資料範圍超過 decimal 的範圍，建議將資料拆成整數和小數分開儲存。 【規範】如果儲存的字串長度幾乎相等，使用 char 定長字串型別。 【效率】varchar 是可變長字串，不預先分配儲存空間，長度不要超過 5000，如果儲存長 度大於此值，定義欄位型別為 text，獨立出來一張表，用主鍵來對應，避免影響其它欄位索 引效率。 【規範】表的命名最好是加上“業務名稱_表的作用”。 正例:tiger_task / tiger_reader / mpp_config 【規範】庫名與應用名稱儘量一致。 【規範】如果修改欄位含義或對欄位表示的狀態追加時，需要及時更新欄位註釋。 【效率】欄位允許適當冗餘，以提高效能，但是必須考慮資料同步的情況。冗餘欄位應遵循: 1)不是頻繁修改的欄位。 2)不是 varchar 超長欄位，更不能是 text 欄位。 正例:商品類目名稱使用頻率高，欄位長度短，名稱基本一成不變，可在相關聯的表中冗餘存 儲類目名稱，避免關聯查詢。 【效率】單錶行數超過 500 萬行或者單表容量超過 2GB，才推薦進行分庫分表。 說明:如果預計三年後的資料量根本達不到這個級別，請不要在建立表時就分庫分表。 【效率】合適的字元儲存長度，不但節約資料庫表空間、節約索引儲存，更重要的是提升檢 索速度。 正例:人的年齡用 unsigned tinyint(表示範圍 0-255，人的壽命不會超過 255 歲);海龜 就必須是 smallint，但如果是太陽的年齡，就必須是 int;如果是所有恆星的年齡都加起來， 那麼就必須使用 bigint。

索引規約

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

SQL規約

【規範】不要使用 count(列名)或 count(常量)來替代 count(*)，count(*)就是 SQL92 定義 的標準統計行數的語法，跟資料庫無關，跟 NULL 和非 NULL 無關。 說明:count(*)會統計值為 NULL 的行，而 count(列名)不會統計此列為 NULL 值的行。 【說明】count(distinct col) 計算該列除 NULL 之外的不重複數量。注意 count(distinct col1, col2) 如果其中一列全為NULL，那麼即使另一列有不同的值，也返回為0。 【說明】當某一列的值全是 NULL 時，count(col)的返回結果為 0，但 sum(col)的返回結果為 NULL，因此使用 sum()時需注意 NPE 問題。 正例:可以使用如下方式來避免sum的NPE問題:SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table; 【說明】使用 ISNULL()來判斷是否為 NULL 值。注意:NULL 與任何值的直接比較都為 NULL。 說明: 1) NULL<>NULL的返回結果是NULL，而不是false。 2) NULL=NULL的返回結果是NULL，而不是true。 3) NULL<>1的返回結果是NULL，而不是true。 【規範】不得使用外來鍵與級聯，一切外來鍵概念必須在應用層解決。 說明:(概念解釋)學生表中的 student_id 是主鍵，那麼成績表中的 student_id 則為外來鍵。 如果更新學生表中的 student_id，同時觸發成績表中的 student_id 更新，則為級聯更新。外來鍵與級聯更新適用於單機低併發，不適合分散式、高併發叢集;級聯更新是強阻塞，存在數 據庫更新風暴的風險;外來鍵影響資料庫的插入速度。 【規範】資料訂正時，刪除和修改記錄時，要先 select，避免出現誤刪除，確認無誤才能執行更新語句。 【效率】in 操作能避免則避免，若實在避免不了，需要仔細評估 in 後邊的集合元素數量，控制在 1000 個之內。（可以用用 EXISTS ，NOT EXISTS 或 JOIN代替） 【規範】如果有全球化需要，所有的字元儲存與表示，均以 utf-8 編碼，那麼字元計數方法 注意: 說明: SELECT LENGTH(“輕鬆工作”); 返回為12 SELECT CHARACTER_LENGTH(“輕鬆工作”); 返回為4 如果要使用表情，那麼使用 utfmb4 來進行儲存，注意它與 utf-8 編碼的區別。 【規範】TRUNCATE TABLE 比 DELETE 速度快，且使用的系統和事務日誌資源少，但 TRUNCATE無事務且不觸發 trigger，有可能造成事故，故不建議在開發程式碼中使用此語句。 說明:TRUNCATE TABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。

ORM規約

【規範】POJO 類的 boolean 屬性不能加 is，而資料庫欄位必須加 is_，要求在 resultMap 中 進行欄位與屬性之間的對映。 說明:參見定義 POJO 類以及資料庫欄位定義規定，在 sql.xml 增加對映，是必須的。 【安全】配置XML檔案時注意SQL注入問題。 【規範】不允許直接拿 HashMap 與 Hashtable 作為查詢結果集的輸出。 【強制】更新資料表記錄時，必須同時更新記錄對應的 gmt_modified 欄位值為當前時間。 【規範】不要寫一個大而全的資料更新介面，傳入為 POJO 類，不管是不是自己的目標更新字 段，都進行 update table set c1=value1,c2=value2,c3=value3; 這是不對的。執行 SQL 時，儘量不要更新無改動的欄位，一是易出錯;二是效率低;三是 binlog 增加儲存。 【規範】@Transactional 事務不要濫用。事務會影響資料庫的 QPS，另外使用事務的地方需 要考慮各方面的回滾方案，包括快取回滾、搜尋引擎回滾、訊息補償、統計修正等。

工程規約

【說明】圖中預設上層依賴於下層，箭頭關係表示可直接依賴，如:開放介面層可以依賴於Web 層，也可以直接依賴於 Service 層，依此類推。  開放介面層:可直接封裝 Service介面暴露成 RPC 介面;通過 Web 封裝成 http 介面;閘道器控 制層等。  終端顯示層:各個端的模板渲染並執行顯示層。當前主要是 velocity 渲染，JS 渲染，JSP 渲 染，移動端展示層等。  Web 層:主要是對訪問控制進行轉發，各類基本引數校驗，或者不復用的業務簡單處理等。(Controller)  Service 層:相對具體的業務邏輯服務層。  Manager 層:通用業務處理層，它有如下特徵: 1) 對第三方平臺封裝的層，預處理返回結果及轉化異常資訊; 2) 對Service層通用能力的下沉，如快取方案、中介軟體通用處理; 3) 與DAO層互動，對DAO的業務通用能力的封裝。  DAO 層:資料訪問層，與底層 MySQL、Oracle、Hbase 進行資料互動。  外部介面或第三方平臺:包括其它部門 RPC 開放介面，基礎平臺，其它公司的 HTTP 介面。 【規範】(分層異常處理規約)在 DAO 層，產生的異常型別有很多，無法用細粒度的異常進 行catch，使用catch(Exception e)方式，並throw new DAOException(e)，不需要列印日誌，因為日誌在 Manager/Service 層一定需要捕獲並打到日誌檔案中去，如果同臺伺服器 再打日誌，浪費效能和儲存。在 Service 層出現異常時，必須記錄出錯日誌到磁碟，儘可能帶 上引數資訊，相當於保護案發現場。如果 Manager 層與 Service 同機部署，日誌方式與 DAO 層處理一致，如果是單獨部署，則採用與 Service 一致的處理方式。Web 層絕不應該繼續往上拋異常，因為已經處於頂層，如果意識到這個異常將導致頁面無法正常渲染，那麼就應該直接跳轉到友好錯誤頁面，加上使用者容易理解的錯誤提示資訊。開放介面層要將異常處理成錯誤碼 和錯誤資訊方式返回。 【規範】分層領域模型規約:  DO(Data Object):與資料庫表結構一一對應，通過 DAO 層向上傳輸資料來源物件。(Entity)  DTO(Data Transfer Object):資料傳輸物件，Service 和 Manager 向外傳輸的物件。  BO(Business Object):業務物件。可以由 Service 層輸出的封裝業務邏輯的物件。  QUERY:資料查詢物件，各層接收上層的查詢請求。注:超過 2 個引數的查詢封裝，禁止 使用 Map 類來傳輸。  VO(View Object):顯示層物件，通常是 Web 向模板渲染引擎層傳輸的物件。

伺服器規約

【效率】高併發伺服器建議調小 TCP 協議的 time_wait 超時時間。 說明:作業系統預設 240 秒後，才會關閉處於 time_wait 狀態的連線，在高併發訪問下，伺服器端會因為處於 time_wait 的連線數太多，可能無法建立新的連線，所以需要在伺服器上 調小此等待值。 正例:在 linux 伺服器上請通過變更/etc/sysctl.conf 檔案去修改該預設值(秒): net.ipv4.tcp_fin_timeout = 30 【效率】調大伺服器所支援的最大檔案控制代碼數(File Descriptor，簡寫為fd)。 說明:主流作業系統的設計是將 TCP/UDP 連線採用與檔案一樣的方式去管理，即一個連線對 應於一個 fd。主流的 linux 伺服器預設所支援最大 fd 數量為 1024，當併發連線數很大時很 容易因為 fd 不足而出現“open too many files”錯誤，導致新的連線無法建立。 建議將 linux 伺服器所支援的最大控制代碼數調高數倍(與伺服器的記憶體數量相關)。 【規範】給 JVM 設定-XX:+HeapDumpOnOutOfMemoryError 引數，讓 JVM 碰到 OOM 場景時輸出 dump 資訊。 說明:OOM 的發生是有概率的，甚至有規律地相隔數月才出現一例，出現時的現場資訊對查錯 非常有價值。 【規範】伺服器內部重定向使用 forward;外部重定向地址使用 URL 拼裝工具類來生成，否則 會帶來 URL 維護不一致的問題和潛在的安全風險。

安全規約

【安全】隸屬於使用者個人的頁面或者功能必須進行許可權控制校驗。 說明:防止沒有做水平許可權校驗就可隨意訪問、操作別人的資料，比如檢視、修改別人的訂單。 【安全】使用者敏感資料禁止直接展示，必須對展示資料脫敏。 說明:檢視個人手機號碼會顯示成:158****9119，隱藏中間 4 位，防止隱私洩露。 【安全】使用者輸入的 SQL 引數嚴格使用引數繫結或者 METADATA 欄位值限定，防止 SQL 注入， 禁止字串拼接 SQL 訪問資料庫。 【安全】使用者請求傳入的任何引數必須做有效性驗證。 說明:忽略引數校驗可能導致:  page size 過大導致記憶體溢位  惡意 order by 導致資料庫慢查詢  任意重定向  SQL 注入  反序列化注入  正則輸入源串拒絕服務 ReDoS 說明:Java 程式碼用正則來驗證客戶端的輸入，有些正則寫法驗證普通使用者輸入沒有問題， 但是如果攻擊人員使用的是特殊構造的字串來驗證，有可能導致死迴圈的效果。 【安全】禁止向 HTML 頁面輸出未經安全過濾或未正確轉義的使用者資料。 【安全】表單、AJAX 提交必須執行 CSRF 安全過濾。 說明:CSRF(Cross-site request forgery)跨站請求偽造是一類常見程式設計漏洞。對於存在 CSRF 漏洞的應用/網站，攻擊者可以事先構造好 URL，只要受害者使用者一訪問，後臺便在使用者 不知情情況下對資料庫中使用者引數進行相應修改。 【安全】在使用平臺資源，譬如簡訊、郵件、電話、下單、支付，必須實現正確的防重放限制， 如數量限制、疲勞度控制、驗證碼校驗，避免被濫刷、資損。 說明:如註冊時傳送驗證碼到手機，如果沒有限制次數和頻率，那麼可以利用此功能騷擾到其 它使用者，並造成簡訊平臺資源浪費。 【安全】發貼、評論、傳送即時訊息等使用者生成內容的場景必須實現防刷、文字內容違禁詞過 濾等風控策略。

            </div>
                </div>