編程規(guī)約：
（一）命名規(guī)約
【強(qiáng)制】 代碼中的命名均不能以下劃線或美元符號開始贞岭，也不能以下劃線或美元符號結(jié)束。
反例：_name / _name / $Object / name / name$ / Object$【強(qiáng)制】類名使用 UpperCamelCase 風(fēng)格饱狂，必須遵從駝峰形式曹步，但以下情形例外：（領(lǐng)域模型 的相關(guān)命名）DO / BO / DTO / VO 等。
正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion
反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion【強(qiáng)制】方法名休讳、參數(shù)名讲婚、成員變量、局部變量都統(tǒng)一使用 lowerCamelCase 風(fēng)格俊柔，必須遵從 駝峰形式筹麸。
正例： localValue / getHttpMessage() / inputUserId【強(qiáng)制】常量命名全部大寫，單詞間用下劃線隔開雏婶，力求語義表達(dá)完整清楚物赶，不要嫌名字長。
正例： MAX_STOCK_COUNT 反例： MAX_COUNT【強(qiáng)制】中括號是數(shù)組類型的一部分留晚，數(shù)組定義如下：String[] args;
反例：使用 String args[]的方式來定義酵紫。【強(qiáng)制】POJO 類中布爾類型的變量，都不要加 is错维，否則部分框架解析會引起序列化錯誤奖地。
反例：定義為基本數(shù)據(jù)類型 Boolean isSuccess；的屬性赋焕，它的方法也是 isSuccess()参歹，RPC 框架在反向解析的時候，“以為”對應(yīng)的屬性名稱是 success隆判，導(dǎo)致屬性獲取不到犬庇，進(jìn)而拋出異常。【強(qiáng)制】包名統(tǒng)一使用小寫侨嘀，點(diǎn)分隔符之間有且僅有一個自然語義的英語單詞臭挽。包名統(tǒng)一使用 單數(shù)形式，但是類名如果有復(fù)數(shù)含義咬腕，類名可以使用復(fù)數(shù)形式欢峰。
正例： 應(yīng)用工具類包名為 com.alibaba.open.util、類名為 MessageUtils（此規(guī)則參考 spring 的框架結(jié)構(gòu)）【推薦】接口類中的方法和屬性不要加任何修飾符號（public 也不要加），保持代碼的簡潔 性赤赊，并加上有效的 Javadoc 注釋。盡量不要在接口里定義變量煞赢，如果一定要定義變量抛计，肯定是 與接口方法相關(guān)，并且是整個應(yīng)用的基礎(chǔ)常量照筑。
正例：接口方法簽名：void f(); 接口基礎(chǔ)常量表示：String COMPANY = "alibaba";
反例：接口方法定義：public abstract void f();
說明：JDK8 中接口允許有默認(rèn)實現(xiàn)吹截，那么這個 default 方法，是對所有實現(xiàn)類都有價值的默 認(rèn)實現(xiàn)凝危。【參考】枚舉類名建議帶上 Enum 后綴波俄，枚舉成員名稱需要全大寫，單詞間用下劃線隔開蛾默。
說明：枚舉其實就是特殊的常量類懦铺，且構(gòu)造方法被默認(rèn)強(qiáng)制是私有。
正例：枚舉名字：DealStatusEnum支鸡，成員名稱：SUCCESS / UNKOWN_REASON冬念。
（二）格式規(guī)約
【強(qiáng)制】大括號的使用約定。如果是大括號內(nèi)為空牧挣，則簡潔地寫成{}即可急前，不需要換行；如果 是非空代碼塊則：
1） 左大括號前不換行瀑构。
2） 左大括號后換行裆针。
3） 右大括號前換行。
4） 右大括號后還有 else 等代碼則不換行寺晌；表示終止的右大括號后必須換行世吨。【強(qiáng)制】 左小括號和右邊相鄰字符之間不出現(xiàn)空格；同樣折剃，右小括號和左邊相鄰字符之間也 不出現(xiàn)空格另假。詳見第 5 條下方正例提示。
【強(qiáng)制】if/for/while/switch/do 等保留字與小括號之間都必須加空格怕犁。
【強(qiáng)制】任何運(yùn)算符左右必須加一個空格边篮。 說明：運(yùn)算符包括賦值運(yùn)算符=、邏輯運(yùn)算符&&奏甫、加減乘除符號戈轿、三目運(yùn)算符等。
【強(qiáng)制】縮進(jìn)采用 4 個空格阵子，禁止使用 tab 字符思杯。
說明：如果使用 tab 縮進(jìn)，必須設(shè)置 1 個 tab 為 4 個空格。IDEA 設(shè)置 tab 為 4 個空格時色乾， 請勿勾選 Use tab character誊册；而在 eclipse 中，必須勾選 insert spaces for tabs暖璧。 設(shè)置方法請見本文附錄案怯。
正例： （涉及 1-5 點(diǎn)）
public static void main(String[] args) {
// 縮進(jìn) 4 個空格
String say = "hello";
// 運(yùn)算符的左右必須有一個空格
int flag = 0;
// 關(guān)鍵詞 if 與括號之間必須有一個空格，括號內(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é)束麦锯，則必須換行
}
}
- 【強(qiáng)制】單行字符數(shù)限制不超過 120 個，超出需要換行琅绅，換行時遵循如下原則：
1） 第二行相對第一行縮進(jìn) 4 個空格扶欣，從第三行開始，不再繼續(xù)縮進(jìn)千扶，參考示例宵蛀。
2） 運(yùn)算符與下文一起換行。
3） 方法調(diào)用的點(diǎn)符號與下文一起換行县貌。
4） 在多個參數(shù)超長术陶，逗號后進(jìn)行換行。
5） 在括號前不要換行煤痕，見反例梧宫。
正例：
StringBuffer sb = new StringBuffer();
//超過 120 個字符的情況下，換行縮進(jìn) 4 個空格摆碉，并且方法前的點(diǎn)符號一起換行
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...
.append("huang");
反例：
StringBuffer sb = new StringBuffer();
//超過 120 個字符的情況下塘匣，不要在括號前換行
sb.append("zi").append("xin")...append
("huang");
//參數(shù)很多的方法調(diào)用可能超過 120 個字符，不要在逗號前換行
method(args1, args2, args3, ...
, argsX);
- 【強(qiáng)制】方法參數(shù)在定義和傳入時巷帝，多個參數(shù)逗號后邊必須加空格忌卤。
正例：下例中實參的"a",后邊必須要有一個空格。
method("a", "b", "c");
- 【強(qiáng)制】IDE 的 text file encoding 設(shè)置為 UTF-8; IDE 中文件的換行符使用 Unix 格式楞泼， 不要使用 windows 格式驰徊。 設(shè)置方法請見本文附錄
- 【推薦】方法體內(nèi)的執(zhí)行語句組、變量的定義語句組堕阔、不同的業(yè)務(wù)邏輯之間或者不同的語義 之間插入一個空行棍厂。相同業(yè)務(wù)邏輯和語義之間不需要插入空行。
附錄
eclipse把Tab設(shè)置為4個空格
-
點(diǎn)擊 window->preference-,依次選擇 General->Editors->Text Editors,選中右側(cè)的 insert space for tabs;如下圖所示超陆，保存牺弹。
<div align = center>
圖1-1
</div>
-
點(diǎn)擊 window->preference-,依次選擇 Java->code style ->formatter,點(diǎn)擊右側(cè)的editor，選則左側(cè) tab policy的值為spaces only,確定，應(yīng)用保存即可张漂，如下圖所示：
<div align = center>
圖1-2
</div>
若出現(xiàn)應(yīng)用Apply按鈕為灰色的情況晶默，需要回到上一步，點(diǎn)擊new按鈕航攒，根據(jù)當(dāng)前的樣式重新生成一個新的樣式并保存荤胁，重復(fù)第2步，編輯該樣式即可屎债，如下圖：
<div align = center>
圖1-3
</div>
IDE 的 text file encoding設(shè)置
Window -> Preferences -> General -> Workspace : Text file encoding
<div align = center>
</div>
本文摘抄自阿里巴巴Java開發(fā)手冊
