在企業開發中，代碼規範是非常重要的，部落客在日常開發中，以阿裡規範設計了一套基礎的開發規範。本文将詳細介紹。
1.idea設定注釋與格式規範
1.安裝插件
- 安裝idea插件–eclipse code formatter
- 按住ctrl + alt + S 然後點選 plugins —marketplace —installed— ok
java開發的格式與書寫規範
2添加配置檔案
下載下傳好eclipse格式化檔案 按住ctrl + alt + S，重新開機後會發現出現eclipse code formatter 選項，點選進入 按照圖檔進行配置，路徑選擇檔案夾内eclipse-codestyle檔案。
注意：每次儲存需要 ctrl+alt +l。
2.注釋規範
ctrl + alt + S — file and code templates – includes —file header，然後填寫下面代碼。
/**
* 應用子產品名稱:
* 代碼描述:
* Copyright: Copyright (C) ${YEAR}, Inc. All rights reserved.
* Company:
* @author
* @since ${DATE} ${TIME}
*/ 2.代碼書寫規範
- 入參必須使用對象或者List,非特殊情況下不允許使用jsonobject。
- service與dao層也盡量使用對象封裝，減少參數羅列。
- 參數傳遞非必要情況不要使用map傳遞。
- 出參使用封裝好的Result對象。
- 接口文檔書寫需要詳細 。
- 在使用系統統一異常處理時 不需要使用try catch。
- 在特别需要時 需要向統一異常處理方法維護異常類别。
java開發的格式與書寫規範 - 需要加入類注釋與方法注釋 詳細請參考新人項目搭建文檔。
- 非特殊情況方式不允許使用@requstmapping。
- 實體類需要繼承 BaseEntity。
- 盡量将同一業務的接口寫到一個類中，通用方法抽取出來，并送出給組長，維護到文檔中。
- 服務間調用請參考ribbon與feign。
- 使用格式化文檔對代碼格式化。
- 類上與接口路徑都需要書寫，且不要省略“/”。
- 類命名規範 分别為xxController，xxService，xxServiceImpl,xxDao,xxMapper。
- 方法命名規範：
java開發的格式與書寫規範 - 事務書寫方式。
java開發的格式與書寫規範 - 失效代碼盡量删除掉，而不是注釋。
- 是否等可複用魔法值需要放入枚舉類中 不要在代碼中寫死。
- 實體類需要寫明各字段注釋，可使用代碼生成器生成 。
- 實體中除了設計到計算字段，其他一律使用封裝類類型。
- 接口類型不需要public等關鍵字。
- mapper中需要寫全jdbcType，可以使用代碼生成器生成。
其他詳細可以參考 阿裡巴巴Java開發手冊（華山版）.pdf。