Java代碼規範
代碼編碼規範
- 以阿裡巴巴的開發規範文檔基礎。詳情見阿裡巴巴開發規範.java。
- 安裝規範插件
編輯器安裝阿裡巴巴編碼規範插件，idea和 eclipse都有對應的插件。編碼中代碼給出提示對應的修改即可。如圖
- 安裝下載下傳位址：
Eclipse https://blog.csdn.net/qq_32448349/article/details/81744418
Idea https://blog.csdn.net/weixin_39220472/article/details/80077803
代碼格式風格
eclipse 和 idea 使用統一的風格，提供統一的eclipseProfile.xml檔案。
Eclipse直接在preferences->Java->Code Style->Formatter中導入xml檔案。
Idea安裝插件Eclipse Code Formatter插件，導入到xml檔案。如圖
- 代碼編寫完成後對代碼進行格式化, 如果代碼為曆史代碼，格式化後變動較大，則進行局部格式化。
Eclipse 快捷鍵：Ctrl + Shift + F
Idea 快捷鍵：Ctrl + Alt + L
代碼長度
代碼 循環嵌套 （for ,while…）層次不超過3層，如果超過思考一下實作的方式是否有更優的方式。
代碼的行長度設定為120個字元，在上一步導入即可。手動設定自行百度。
一個複雜方法不超過100行，注意統一個邏輯的代碼要重構為一個方法，重構快捷鍵：ctrl+alt+M進行重構。
Idea支援的重構快捷鍵：
代碼注釋風格
-
類注釋
第一行對類的功能進行說明，最少包含字段：
@author 作者
@version 版本
@date 建立日期
-
方法注釋
第一行對方法的功能進行說明。
方法也需要加入author資訊，當此類中的所有方法都是同一人完成可以不加，例如controller，當service有不同人寫入方法時，必須填寫此字段。
如果是Impl層實作類隻需要在 interface層加入注釋即可，不需要在實作層加入注釋。
因為項目是多人合作，修改他人代碼時遇到不懂的業務代碼可以找到作者詢問意圖，如果是代碼是模版生成，在修改方法時需要加入，最少包含字段：
@param 字段
@return 傳回對象
@author 作者
-
字段注釋
不用使用 雙斜杠 //注釋，使用如圖注釋：
異常處理
- 捕捉異常的目的是為了處理它
- 多個異常應分别捕捉并處理，避免使用一個單一的catch來處理。
- 異常資訊必須列印到日志中，不允許日志資訊不抛出
- 日志記錄代碼： log.error("查詢異常：", e); 前面的提示資訊要明确，定位錯誤
工作經驗-Java代碼規範Java代碼規範
Redis緩存
Key值的定義：項目名稱_子產品名稱_用途_使用方式，全大寫，例如：
public static final String EMC_USER_SMS_PREFIX = “EMC_USER_SMS_PREFIX_”;
String key = EMC_USER_SMS_PREFIX + mobile;
Git使用
- 由于本機環境修改的配置不需要送出
- 送出前檢查确認是否有不要送出的檔案
- 送出寫入注釋
Continue...