Java后臺(tái)開(kāi)發(fā)規(guī)范

1.Java編程規(guī)范

1.1.命名風(fēng)格

• 代碼中的命名均不能以下劃線或美元符號(hào)開(kāi)始臭觉，也不能以下劃線或美元符號(hào)結(jié)束女淑。

• 類名使用 UpperCamelCase 風(fēng)格尚辑，必須遵從駝峰形式贱勃，但以下情形例外：DO / BO / DTO / VO / AO

• 接口類中的方法和屬性不要加任何修飾符號(hào)刚操，保持代碼的簡(jiǎn)潔性恬汁，并加上有效的 Javadoc 注釋伶椿。盡量不要在接口里定義變量，如果一定要定義變量氓侧，肯定是與接口方法相關(guān)脊另，并且是整個(gè)應(yīng)用的基礎(chǔ)常量。

• Service/DAO 層方法命名規(guī)約

  • 1） 獲取單個(gè)對(duì)象的方法用 get 做前綴约巷。
  • 2） 獲取多個(gè)對(duì)象的方法 list 命名偎痛。
  • 3） 獲取統(tǒng)計(jì)值的方法用 count 做前綴。
  • 3） 分頁(yè)的方法用 page 做后綴载庭。
  • 4） 插入的方法用 save 做前綴看彼。
  • 5） 刪除的方法用 delete 做前綴。
  • 6） 修改的方法用 update 做前綴囚聚。

• 領(lǐng)域模型命名規(guī)約

  • 1） 數(shù)據(jù)傳輸對(duì)象：xxxDTO靖榕，xxx 為業(yè)務(wù)領(lǐng)域相關(guān)的名稱。
  • 2） 展示對(duì)象：xxxVO顽铸，xxx 一般為實(shí)體名稱茁计。
  • 3） POJO 是 DO/DTO/BO/VO 的統(tǒng)稱，禁止命名成 xxxPOJO

• 分層領(lǐng)域模型規(guī)約

  • DO(Data Object):與數(shù)據(jù)庫(kù)表結(jié)構(gòu)一一對(duì)應(yīng)谓松，通過(guò) DAO 層向上傳輸數(shù)據(jù)源對(duì)象星压。
  • DTO(Data Transfer Object):數(shù)據(jù)傳輸對(duì)象，Service 或 Manager 向外傳輸?shù)膶?duì)象鬼譬。
  • BO(Business Object):業(yè)務(wù)對(duì)象娜膘。由 Service 層輸出的封裝業(yè)務(wù)邏輯的對(duì)象。
  • AO(ApplicationObject):應(yīng)用對(duì)象优质。在Web層與Service層之間抽象的復(fù)用對(duì)象模型竣贪，極為貼近展示層，復(fù)用度不高巩螃。
  • VO(View Object):顯示層對(duì)象演怎，通常是 Web 向模板渲染引擎層傳輸?shù)膶?duì)象。
  • Query:數(shù)據(jù)查詢對(duì)象避乏，各層接收上層的查詢請(qǐng)求爷耀。注意超過(guò) 2 個(gè)參數(shù)的查詢封裝，禁止使用 Map 類來(lái)傳輸拍皮。

1.2.代碼格式化規(guī)范

每次編輯完一個(gè)類后使用idea的格式化功能歹叮，格式化代碼和去掉無(wú)用導(dǎo)入的包跑杭，win快捷鍵為 Ctrl+Alt+l 和 Ctrl+Alt+o，Mac為ctrl+option+o 和 option+command+l盗胀。

項(xiàng)目的代碼格式統(tǒng)一為UTF-8艘蹋。

1.3.API命名規(guī)范

GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）。

POST（CREATE）：在服務(wù)器新建一個(gè)資源票灰。

PUT（UPDATE）：在服務(wù)器更新完整的資源（客戶端提供改變后的完整資源）女阀。

DELETE（DELETE）：從服務(wù)器刪除資源。

基本規(guī)范

• 使用'/'表示層級(jí)關(guān)系
• url 不能以'/'結(jié)尾
• url 中不能包含空格
• url 中不能以文件后綴結(jié)尾
• url 中字母小寫(xiě)屑迂，單詞間加下劃線
• 不要再u(mài)rl中添加CRUD

1.4.異常處理規(guī)范

• 異常不要用來(lái)做流程控制浸策，條件控制，因?yàn)楫惓５奶幚硇时葪l件分支低惹盼。

• 對(duì)大段代碼進(jìn)行 try-catch庸汗，這是不負(fù)責(zé)任的表現(xiàn)。catch 時(shí)請(qǐng)分清穩(wěn)定代碼和非穩(wěn) 定代碼手报，穩(wěn)定代碼指的是無(wú)論如何不會(huì)出錯(cuò)的代碼蚯舱。對(duì)于非穩(wěn)定代碼的 catch 盡可能進(jìn)行區(qū)分 異常類型，再做對(duì)應(yīng)的異常處理掩蛤。

• 捕獲異常是為了處理它枉昏，不要捕獲了卻什么都不處理而拋棄之，如果不想處理它揍鸟，請(qǐng) 將該異常拋給它的調(diào)用者兄裂。最外層的業(yè)務(wù)使用者，必須處理異常阳藻，將其轉(zhuǎn)化為用戶可以理解的 內(nèi)容晰奖。

• 有 try 塊放到了事務(wù)代碼中，catch 異常后腥泥，如果需要回滾事務(wù)匾南，一定要注意手動(dòng)回 滾事務(wù)。

• finally 塊必須對(duì)資源對(duì)象蛔外、流對(duì)象進(jìn)行關(guān)閉蛆楞，有異常也要做 try-catch。

• 不能在 finally 塊中使用 return冒萄，finally 塊中的 return 返回后方法結(jié)束執(zhí)行，不 會(huì)再執(zhí)行 try 塊中的 return 語(yǔ)句橙数。

• 方法的返回值可以為 null尊流，不強(qiáng)制返回空集合，或者空對(duì)象等灯帮，必須添加注釋充分 說(shuō)明什么情況下會(huì)返回 null 值崖技。調(diào)用方需要進(jìn)行 null 判斷防止 NPE 問(wèn)題逻住。

1.5.模塊化開(kāi)發(fā)規(guī)范

模塊化開(kāi)發(fā)是指公司共有的基礎(chǔ)模塊的開(kāi)發(fā)如：短信、權(quán)限迎献、支付瞎访、公共工具、郵件等吁恍。

模塊化開(kāi)發(fā)的pom模版

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.domain.module</groupId>
    <artifactId>domain-module</artifactId>
    <version>1.0.0.RELEASE</version>

    <dependencies>
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-spring</artifactId>
            <version>1.4.0</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <version>3.7.0</version>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>UTF-8</encoding>
                </configuration>
            </plugin>
        </plugins>
    </build>

    <distributionManagement>
        <repository>
            <id>releases</id>
            <name>Nexus release Repository</name>
            <url>http://192.168.0.110:8081/repository/maven-releases/</url>
        </repository>

        <snapshotRepository>
            <id>snapshots</id>
            <name>Nexus snapshots Repository</name>
            <url>http://192.168.0.110:8081/repository/maven-snapshots/</url>
        </snapshotRepository>
    </distributionManagement>

</project>

• 模塊化定義 GAV 遵從以下規(guī)則:

  • GroupID格式:com.{域名}.業(yè)務(wù)線.[子業(yè)務(wù)線]扒秸，最多4級(jí)。
  • ArtifactID格式:產(chǎn)品線名-模塊名冀瓦。語(yǔ)義不重復(fù)不遺漏伴奥，先到中央倉(cāng)庫(kù)去查證一下。

• 模塊化命名方式:主版本號(hào).次版本號(hào).修訂號(hào)

  • 主版本號(hào):產(chǎn)品方向改變翼闽，或者大規(guī)模API不兼容拾徙，或者架構(gòu)不兼容升級(jí)。
  • 次版本號(hào):保持相對(duì)兼容性感局，增加主要功能特性尼啡，影響范圍極小的API不兼容修改。 3) 修訂號(hào):保持完全兼容性询微，修復(fù)BUG崖瞭、新增次要功能特性等。

2.前后端對(duì)接規(guī)范

• 后端返回格式統(tǒng)一為json格式數(shù)據(jù)拓提。

{"code":20000,"message":"success","data":null}

• 后端返回的code字段读恃，以4開(kāi)頭則為前端請(qǐng)求有誤，以5開(kāi)頭則是后端接口問(wèn)題代态。2開(kāi)頭則表示成功寺惫。

• 后端返回的message字段表示請(qǐng)求的信息，成功是success蹦疑，錯(cuò)誤則會(huì)提示相應(yīng)的異常信息或返回error西雀。

• 后端返回的data字段則是本次請(qǐng)求的數(shù)據(jù)，無(wú)數(shù)據(jù)則返回null歉摧。

• 后端返回的時(shí)間格式統(tǒng)一為時(shí)間戳

3.數(shù)據(jù)庫(kù)設(shè)計(jì)規(guī)范

3.1.建表規(guī)約

• 表名艇肴、字段名必須使用小寫(xiě)字母或數(shù)字，禁止出現(xiàn)數(shù)字開(kāi)頭叁温，禁止兩個(gè)下劃線中間只出現(xiàn)數(shù)字再悼。數(shù)據(jù)庫(kù)字段名的修改代價(jià)很大，因?yàn)闊o(wú)法進(jìn)行預(yù)發(fā)布膝但，所以字段名稱需要慎重考慮冲九。

• 表達(dá)是與否概念的字段，必須使用 is_xxx 的方式命名跟束，數(shù)據(jù)類型是 tinyint (1表示是莺奸，0表示否)丑孩。

• 表名不使用復(fù)數(shù)名詞。

• 禁用保留字灭贷，如 desc温学、range、match甚疟、delayed 等仗岖，請(qǐng)參考 MySQL 官方保留字。

• 主鍵索引名為 pk_字段名;唯一索引名為 uk_字段名;普通索引名則為 idx_字段名古拴。

• 小數(shù)類型為 decimal箩帚，禁止使用 float 和 double。

• 如果存儲(chǔ)的字符串長(zhǎng)度幾乎相等黄痪，使用 char 定長(zhǎng)字符串類型紧帕。

• varchar 是可變長(zhǎng)字符串，不預(yù)先分配存儲(chǔ)空間桅打，長(zhǎng)度不要超過(guò) 5000是嗜，如果存儲(chǔ)長(zhǎng) 度大于此值，定義字段類型為 text挺尾，獨(dú)立出來(lái)一張表鹅搪，用主鍵來(lái)對(duì)應(yīng)，避免影響其它字段索 引效率遭铺。

• 表必備三字段:id, gmt_create, gmt_modified丽柿。

• 表的命名最好是加上"業(yè)務(wù)名稱_表的作用"。

• 庫(kù)名與應(yīng)用名稱盡量一致魂挂。

• 單表行數(shù)超過(guò) 500 萬(wàn)行或者單表容量超過(guò) 2GB甫题，才推薦進(jìn)行分庫(kù)分表。

3.2.索引規(guī)約

• 業(yè)務(wù)上具有唯一特性的字段涂召，即使是多個(gè)字段的組合坠非，也必須建成唯一索引。

• 超過(guò)三個(gè)表禁止 join果正。需要 join 的字段炎码，數(shù)據(jù)類型必須絕對(duì)一致;多表關(guān)聯(lián)查詢時(shí)，保證被關(guān)聯(lián)的字段需要有索引秋泳。

• 在 varchar 字段上建立索引時(shí)潦闲，必須指定索引長(zhǎng)度，沒(méi)必要對(duì)全字段建立索引迫皱，根據(jù)實(shí)際文本區(qū)分度決定索引長(zhǎng)度即可歉闰。

• 如果有 order by 的場(chǎng)景，請(qǐng)注意利用索引的有序性。order by 最后的字段是組合索引的一部分新娜，并且放在索引組合順序的最后，避免出現(xiàn) file_sort 的情況既绩，影響查詢性能概龄。

• 利用覆蓋索引來(lái)進(jìn)行查詢操作，避免回表饲握。

• SQL 性能優(yōu)化的目標(biāo):至少要達(dá)到 range 級(jí)別私杜，要求是 ref 級(jí)別，如果可以是 consts 最好救欧。

• 建組合索引的時(shí)候衰粹，區(qū)分度最高的在最左邊。

3.3.SQL 語(yǔ)句

• 不要使用 count(列名)或 count(常量)來(lái)替代 count()笆怠，count()是 SQL92 定義的 標(biāo)準(zhǔn)統(tǒng)計(jì)行數(shù)的語(yǔ)法铝耻，跟數(shù)據(jù)庫(kù)無(wú)關(guān)，跟 NULL 和非 NULL 無(wú)關(guān)蹬刷。

• count(distinct col) 計(jì)算該列除 NULL 之外的不重復(fù)行數(shù)瓢捉，注意 count(distinct col1, col2) 如果其中一列全為NULL，那么即使另一列有不同的值办成，也返回為0泡态。

• 當(dāng)某一列的值全是 NULL 時(shí)，count(col)的返回結(jié)果為 0迂卢，但 sum(col)的返回結(jié)果為 NULL某弦，因此使用 sum()時(shí)需注意 NPE 問(wèn)題。

• 使用 ISNULL()來(lái)判斷是否為 NULL 值而克。

• 在代碼中寫(xiě)分頁(yè)查詢邏輯時(shí)靶壮，若 count 為 0 應(yīng)直接返回，避免執(zhí)行后面的分頁(yè)語(yǔ)句拍摇。

• 不得使用外鍵與級(jí)聯(lián)亮钦，一切外鍵概念必須在應(yīng)用層解決。

• 禁止使用存儲(chǔ)過(guò)程充活，存儲(chǔ)過(guò)程難以調(diào)試和擴(kuò)展蜂莉，更沒(méi)有移植性。

• 數(shù)據(jù)訂正時(shí)混卵，刪除和修改記錄時(shí)映穗，要先 select，避免出現(xiàn)誤刪除幕随，確認(rèn)無(wú)誤才能執(zhí)行更新語(yǔ)句蚁滋。

• in 操作能避免則避免，若實(shí)在避免不了，需要仔細(xì)評(píng)估 in 后邊的集合元素?cái)?shù)量辕录，控制在 1000 個(gè)之內(nèi)

• 如果有全球化需要睦霎，所有的字符存儲(chǔ)與表示，均以 utf-8 編碼走诞，注意字符統(tǒng)計(jì)函數(shù)的區(qū)別副女。

• TRUNCATE TABLE 比 DELETE 速度快，且使用的系統(tǒng)和事務(wù)日志資源少蚣旱，但 TRUNCATE 無(wú)事務(wù)且不觸發(fā) trigger碑幅，有可能造成事故，故不建議在開(kāi)發(fā)代碼中使用此語(yǔ)句塞绿。

3.4.ORM 映射

• 在表查詢中沟涨，一律不要使用 * 作為查詢的字段列表，需要哪些字段必須明確寫(xiě)明异吻。

• POJO 類的布爾屬性不能加 is裹赴，而數(shù)據(jù)庫(kù)字段必須加 is_，要求在 resultMap 中進(jìn)行 字段與屬性之間的映射诀浪。

• 不要用 resultClass 當(dāng)返回參數(shù)篮昧，即使所有類屬性名與數(shù)據(jù)庫(kù)字段一一對(duì)應(yīng)，也需 要定義;反過(guò)來(lái)笋妥，每一個(gè)表也必然有一個(gè)與之對(duì)應(yīng)懊昨。

• sql.xml 配置參數(shù)使用:#{}，#param# 不要使用${} 此種方式容易出現(xiàn) SQL 注入春宣。

• 不允許直接拿 HashMap 與 Hashtable 作為查詢結(jié)果集的輸出酵颁。

• 更新數(shù)據(jù)表記錄時(shí)，必須同時(shí)更新記錄對(duì)應(yīng)的 gmt_modified 字段值為當(dāng)前時(shí)間月帝。

• 不要寫(xiě)一個(gè)大而全的數(shù)據(jù)更新接口躏惋。傳入為 POJO 類，不管是不是自己的目標(biāo)更新字 段嚷辅，都進(jìn)行 update table set c1=value1,c2=value2,c3=value3; 這是不對(duì)的簿姨。執(zhí)行 SQL 時(shí)，不要更新無(wú)改動(dòng)的字段簸搞，一是易出錯(cuò);二是效率低;三是增加 binlog 存儲(chǔ)扁位。

• @Transactional 事務(wù)不要濫用。事務(wù)會(huì)影響數(shù)據(jù)庫(kù)的 QPS趁俊，另外使用事務(wù)的地方需 要考慮各方面的回滾方案域仇，包括緩存回滾、搜索引擎回滾寺擂、消息補(bǔ)償暇务、統(tǒng)計(jì)修正等泼掠。

4.服務(wù)部署規(guī)范

• 在線上生產(chǎn)環(huán)境，JVM的Xms和Xmx設(shè)置一樣大小的內(nèi)存容量垦细，避免在GC 后調(diào)整堆 大小帶來(lái)的壓力择镇。

• 給 JVM 設(shè)置-XX:+HeapDumpOnOutOfMemoryError 參數(shù)，讓 JVM 碰到 OOM 場(chǎng)景時(shí)輸出 dump 信息括改。

參考：阿里巴巴Java開(kāi)發(fā)手冊(cè)