【Java】命名规范
一、Java總體命名規(guī)范
類一般采用大駝峰命名，方法和局部變量使用小駝峰命名，而大寫下劃線命名通常是常量和枚舉中使用。
創(chuàng)建一個項目之后，子類中的東西命名規(guī)范如下：
- 項目名全部小寫，多個單詞中間用-連接
- 包名全部小寫
- 類名首字母大寫，其余組成詞首字母依次大寫（大駝峰命名）
- 變量名、方法名首字母小寫，其余組成詞的首字母都要大寫（小駝峰命名）
- 常量名全部大寫，多個單詞中間用_連接
所有命名規(guī)則必須遵循Java本身的規(guī)則：
- 名稱只能由字母、數(shù)字、下劃線、$符號組成
- 不能以數(shù)字開頭
- 名稱不能使用Java中的關(guān)鍵字
- 堅決不允許出現(xiàn)中文及拼音命名
| 項目名 | 全部小寫，多個單詞用中劃線【-】分隔 | spring-cloud |
| 包名 | 全部小寫 | com.company |
| 類名 | 單詞首字母大寫，其余組成詞首字母依次大寫（大駝峰命名） | PaintFigure |
| 變量名 | 首字母小寫，多個單詞組成時，除首個單詞，其他單詞首字母都要大寫 | password、userName |
| 常量名 | 全部大寫，多個單詞，用【_】分隔 | EXAM_TIME |
| 方法名 | 首字母小寫，其余組成詞的首字母都要大寫（小駝峰命名） | createExam |
二、Java包名命名規(guī)范
包名統(tǒng)一使用小寫，點分隔符之間有且僅有一個自然語義的英文單詞或者多個單詞自然連接到一塊（如 springframework，deepspace不需要使用任何分割）。
包名統(tǒng)一使用單數(shù)形式，如果類命有復(fù)數(shù)含義，則可以使用復(fù)數(shù)形式。
包名的構(gòu)成可以分為以下幾四部分【前綴】【發(fā)起者名】【項目名】【模塊名】。常見的前綴可以分為以下幾種：
| indi（或onem ） | indi.發(fā)起者名.項目名.模塊名.…… | 個體項目，指個人發(fā)起，但非自己獨自完成的項目，可公開或私有項目，copyright主要屬于發(fā)起者。 |
| pers | pers.個人名.項目名.模塊名.…… | 個人項目，指個人發(fā)起，獨自完成，可分享的項目，copyright主要屬于個人 |
| priv | priv.個人名.項目名.模塊名.…… | 私有項目，指個人發(fā)起，獨自完成，非公開的私人使用的項目，copyright屬于個人。 |
| team | team.團(tuán)隊名.項目名.模塊名.…… | 團(tuán)隊項目，指由團(tuán)隊發(fā)起，并由該團(tuán)隊開發(fā)的項目，copyright屬于該團(tuán)隊所有 |
| 頂級域名 | com.公司名.項目名.模塊名.…… | 公司項目，copyright由項目發(fā)起的公司所有 |
三、Java類命名
類名使用大駝峰命名形式，類命通常時名詞或名詞短語，接口名除了用名詞和名詞短語以外，還可以使用形容詞或形容詞短語，如Cloneable，Callable等，表示實現(xiàn)該接口的類有某種功能或能力。對于測試類則以它要測試的類開頭，以Test結(jié)尾，如HashMapTest。
對于一些特殊特有名詞縮寫也可以使用全大寫命名，比如XMLHttpRequest，不過筆者認(rèn)為縮寫三個字母以內(nèi)都大寫，超過三個字母則按照要給單詞算。這個沒有標(biāo)準(zhǔn)，如阿里巴巴中fastjson用JSONObject作為類命，而google則使用JsonObjectRequest命名，對于這種特殊的縮寫，原則是統(tǒng)一就好。
| 抽象類 | Abstract 或者 Base 開頭 | BaseUserService |
| 枚舉類 | Enum 作為后綴 | GenderEnum |
| 工具類 | Utils作為后綴 | StringUtils |
| 異常類 | Exception結(jié)尾 | RuntimeException |
| 接口實現(xiàn)類 | 接口名+ Impl | UserServiceImpl |
| 領(lǐng)域模型相關(guān) | /DO/DTO/VO/DAO | 正例：UserDAO 反例： UserDo， UserDao |
| 設(shè)計模式相關(guān)類 | Builder，Factory等 | 當(dāng)使用到設(shè)計模式時，需要使用對應(yīng)的設(shè)計模式作為后綴，如ThreadFactory |
| 處理特定功能的 | Handler，Predicate, Validator | 表示處理器，校驗器，斷言，這些類工廠還有配套的方法名如handle，predicate，validate |
| 測試類 | Test結(jié)尾 | UserServiceTest， 表示用來測試UserService類的 |
| MVC分層 | Controller，Service，ServiceImpl，DAO后綴 | UserManageController，UserManageDAO |
四、Java方法命名規(guī)范
方法命名采用小駝峰的形式，首字小寫，往后的每個單詞首字母都要大寫。 和類名不同的是，方法命名一般為動詞或動詞短語，與參數(shù)或參數(shù)名共同組成動賓短語，即動詞 + 名詞。一個好的函數(shù)名一般能通過名字直接獲知該函數(shù)實現(xiàn)什么樣的功能。
4.1 返回真?zhèn)沃档姆椒?/strong>
注：Prefix-前綴，Suffix-后綴，Alone-單獨使用
| Prefix | is | 對象是否符合期待的狀態(tài) | isValid |
| Prefix | can | 對象能否執(zhí)行所期待的動作 | canRemove |
| Prefix | should | 調(diào)用方執(zhí)行某個命令或方法是好還是不好,應(yīng)不應(yīng)該，或者說推薦還是不推薦 | shouldMigrate |
| Prefix | has | 對象是否持有所期待的數(shù)據(jù)和屬性 | hasObservers |
| Prefix | needs | 調(diào)用方是否需要執(zhí)行某個命令或方法 | needsMigrate |
4.2 用來檢查的方法
| ensure | 檢查是否為期待的狀態(tài)，不是則拋出異常或返回error code | ensureCapacity |
| validate | 檢查是否為正確的狀態(tài)，不是則拋出異?；蚍祷豦rror code | validateInputs |
4.3 按需求才執(zhí)行的方法
| Suffix | IfNeeded | 需要的時候執(zhí)行，不需要的時候什么都不做 | drawIfNeeded |
| Prefix | might | 同上 | mightCreate |
| Prefix | try | 嘗試執(zhí)行，失敗時拋出異常或是返回errorcode | tryCreate |
| Suffix | OrDefault | 嘗試執(zhí)行，失敗時返回默認(rèn)值 | getOrDefault |
| Suffix | OrElse | 嘗試執(zhí)行、失敗時返回實際參數(shù)中指定的值 | getOrElse |
| Prefix | force | 強(qiáng)制嘗試執(zhí)行。error拋出異常或是返回值 | forceCreate, forceStop |
4.4 異步相關(guān)方法
| Prefix | blocking | 線程阻塞方法 | blockingGetUser |
| Suffix | InBackground | 執(zhí)行在后臺的線程 | doInBackground |
| Suffix | Async | 異步方法 | sendAsync |
| Suffix | Sync | 對應(yīng)已有異步方法的同步方法 | sendSync |
| refix or Alone | schedule | Job和Task放入隊列 | schedule, scheduleJob |
| Prefix or Alone | post | 同上 | postJob |
| Prefix or Alone | execute | 執(zhí)行異步方法（注：我一般拿這個做同步方法名） | execute, executeTask |
| Prefix or Alone | start | 同上 | start, startJob |
| Prefix or Alone | cancel | 停止異步方法 | cancel, cancelJob |
| Prefix or Alone | stop | 同上 | stop, stopJob |
4.5 回調(diào)方法
| contains | 是否持有與指定對象相同的對象 | contains |
| add | 添加 | addJob |
| append | 添加 | appendJob |
| insert | 插入到下標(biāo)n | insertJob |
| put | 添加與key對應(yīng)的元素 | putJob |
| remove | 移除元素 | removeJob |
| enqueue | 添加到隊列的最末位 | enqueueJob |
| dequeue | 從隊列中頭部取出并移除 | dequeueJob |
| push | 添加到棧頭 | pushJob |
| pop | 從棧頭取出并移除 | popJob |
| peek | 從棧頭取出但不移除 | peekJob |
| find | 尋找符合條件的某物 | findById |
4.6 與數(shù)據(jù)相關(guān)的方法
| create | 新創(chuàng)建 | createAccount |
| new | 新創(chuàng)建 | newAccount |
| from | 從既有的某物新建，或是從其他的數(shù)據(jù)新建 | fromConfig |
| to | 轉(zhuǎn)換 | toString |
| update | 更新既有某物 | updateAccount |
| load | 讀取 | loadAccount |
| fetch | 遠(yuǎn)程讀取 | fetchAccount |
| delete | 刪除 | deleteAccount |
| remove | 刪除 | removeAccount |
| save | 保存 | saveAccount |
| store | 保存 | storeAccount |
| commit | 保存 | commitChange |
| apply | 保存或應(yīng)用 | applyChange |
| clear | 清除數(shù)據(jù)或是恢復(fù)到初始狀態(tài) | clearAll |
| reset | 清除數(shù)據(jù)或是恢復(fù)到初始狀態(tài) | resetAll |
4.7 成對出現(xiàn)的動詞
| get獲取 | set 設(shè)置 |
| add 增加 | remove 刪除 |
| create 創(chuàng)建 | destory 移除 |
| start 啟動 | stop 停止 |
| open 打開 | close 關(guān)閉 |
| read 讀取 | write 寫入 |
| load 載入 | save 保存 |
| create 創(chuàng)建 | destroy 銷毀 |
| begin 開始 | end 結(jié)束 |
| backup 備份 | restore 恢復(fù) |
| import 導(dǎo)入 | export 導(dǎo)出 |
| split 分割 | merge 合并 |
| inject 注入 | extract 提取 |
| attach 附著 | detach 脫離 |
| bind 綁定 | separate 分離 |
| view 查看 | browse 瀏覽 |
| edit 編輯 | modify 修改 |
| select 選取 | mark 標(biāo)記 |
| copy 復(fù)制 | paste 粘貼 |
| undo 撤銷 | redo 重做 |
| insert 插入 | delete 移除 |
| add 加入 | append 添加 |
| clean 清理 | clear 清除 |
| index 索引 | sort 排序 |
| find 查找 | search 搜索 |
| increase 增加 | decrease 減少 |
| play 播放 | pause 暫停 |
| launch 啟動 | run 運行 |
| compile 編譯 | execute 執(zhí)行 |
| debug 調(diào)試 | trace 跟蹤 |
| observe 觀察 | listen 監(jiān)聽 |
| build 構(gòu)建 | publish 發(fā)布 |
| input 輸入 | output 輸出 |
| encode 編碼 | decode 解碼 |
| encrypt 加密 | decrypt 解密 |
| compress 壓縮 | decompress 解壓縮 |
| pack 打包 | unpack 解包 |
| parse 解析 | emit 生成 |
| connect 連接 | disconnect 斷開 |
| send 發(fā)送 | receive 接收 |
| download 下載 | upload 上傳 |
| refresh 刷新 | synchronize 同步 |
| update 更新 | revert 復(fù)原 |
| lock 鎖定 | unlock 解鎖 |
| check out 簽出 | check in 簽入 |
| submit 提交 | commit 交付 |
| push 推 | pull 拉 |
| expand 展開 | collapse 折疊 |
| begin 起始 | end 結(jié)束 |
| start 開始 | finish 完成 |
| enter 進(jìn)入 | exit 退出 |
| abort 放棄 | quit 離開 |
| obsolete 廢棄 | depreciate 廢舊 |
| collect 收集 | aggregate 聚集 |
五、Java變量名和常量名命名規(guī)范
5.1 變量命名
變量是指在程序運行中可以改變其值的量，包括成員變量和局部變量。變量名由多單詞組成時，第一個單詞的首字母小寫，其后單詞的首字母大寫，俗稱駱駝式命名法（也稱駝峰命名法），如 computedValues，index、變量命名時，盡量簡短且能清楚的表達(dá)變量的作用，命名體現(xiàn)具體的業(yè)務(wù)含義即可。
變量名不應(yīng)以下劃線或美元符號開頭，盡管這在語法上是允許的。變量名應(yīng)簡短且富于描述。變量名的選用應(yīng)該易于記憶，即，能夠指出其用途。盡量避免單個字符的變量名，除非是一次性的臨時變量。pojo中的布爾變量，都不要加is(數(shù)據(jù)庫中的布爾字段全都要加 is_ 前綴)。
5.2 常量命名
常量命名CONSTANT_CASE，一般采用全部大寫（作為方法參數(shù)時除外），單詞間用下劃線分割。
常量是在作用域內(nèi)保持不變的值，一般使用final進(jìn)行修飾。一般分為三種，全局常量（public static final修飾），類內(nèi)常量（private static final 修飾）以及局部常量（方法內(nèi)，或者參數(shù)中的常量），局部常量比較特殊，通常采用小駝峰命名即可。
常量一般都有自己的業(yè)務(wù)含義,不要害怕長度過長而進(jìn)行省略或者縮寫。如，用戶消息緩存過期時間的表示，那種方式更佳清晰，交給你來評判。
5.3 通用命名規(guī)則
正例： BeiJing， HangZhou
反例： validateCanShu
如類名采用User4RedisDO，方法名getUserInfoFromRedis，convertJson2Map等。
六、Java代碼注解
6.1 注解的原則
好的命名增加代碼閱讀性，代碼的命名往往有嚴(yán)格的限制。而注解不同，程序員往往可以自由發(fā)揮，單并不意味著可以為所欲為之胡作非為。優(yōu)雅的注解通常要滿足三要素。
沒有注解的代碼對于閱讀者非常不友好，哪怕代碼寫的在清除，閱讀者至少從心理上會有抵觸，更何況代碼中往往有許多復(fù)雜的邏輯，所以一定要寫注解，不僅要記錄代碼的邏輯，還有說清楚修改的邏輯。
從代碼維護(hù)角度來講，代碼中的注解一定是精華中的精華。合理清晰的命名能讓代碼易于理解，對于邏輯簡單且命名規(guī)范，能夠清楚表達(dá)代碼功能的代碼不需要注解。濫用注解會增加額外的負(fù)擔(dān)，更何況大部分都是廢話。
注解應(yīng)該隨著代碼的變動而改變，注解表達(dá)的信息要與代碼中完全一致。通常情況下修改代碼后一定要修改注解。
6.2 注解格式
注解大體上可以分為兩種，一種是javadoc注解，另一種是簡單注解。javadoc注解可以生成JavaAPI為外部用戶提供有效的支持javadoc注解通常在使用IDEA，或者Eclipse等開發(fā)工具時都可以自動生成，也支持自定義的注解模板，僅需要對對應(yīng)的字段進(jìn)行解釋。參與同一項目開發(fā)的同學(xué)，盡量設(shè)置成相同的注解模板。
-
包注解
包注解在工作中往往比較特殊，通過包注解可以快速知悉當(dāng)前包下代碼是用來實現(xiàn)哪些功能，強(qiáng)烈建議工作中加上，尤其是對于一些比較復(fù)雜的包，包注解一般在包的根目錄下，名稱統(tǒng)一為package-info.java。
/*** 落地也質(zhì)量檢測* 1. 用來解決什么問題* 對廣告主投放的廣告落地頁進(jìn)行性能檢測，模擬不同的系統(tǒng)，如Android，IOS等; 模擬不同的網(wǎng)絡(luò)：2G，3G，4G，wifi等** 2. 如何實現(xiàn)* 基于chrome瀏覽器，用chromedriver驅(qū)動瀏覽器，設(shè)置對應(yīng)的網(wǎng)絡(luò)，OS參數(shù)，獲取到瀏覽器返回結(jié)果。** 注意： 網(wǎng)絡(luò)環(huán)境配置信息{@link cn.mycookies.landingpagecheck.meta.NetWorkSpeedEnum}目前使用是常規(guī)速度，可以根據(jù)實際情況進(jìn)行調(diào)整* * @author 作者* @time 2019/12/7 20:3 下午*/ package cn.mycookies.landingpagecheck; -
類注接
javadoc注解中，每個類都必須有注解
/** * Copyright (C), 2019-2020, Jann balabala... * * 類的介紹：這是一個用來做什么事情的類，有哪些功能，用到的技術(shù)..... * * @author 類創(chuàng)建者姓名 保持對齊 * @date 創(chuàng)建日期 保持對齊 * @version 版本號 保持對齊 */ -
屬性注解
在每個屬性前面必須加上屬性注釋，通常有一下兩種形式，至于怎么選擇，你高興就好，不過一個項目中要保持統(tǒng)一。
/** 提示信息 */ private String userName; /*** 密碼*/ private String password; -
方法注釋
在每個方法前面必須加上方法注釋，對于方法中的每個參數(shù)，以及返回值都要有說明。
/*** 方法的詳細(xì)說明，能干嘛，怎么實現(xiàn)的，注意事項...** @param xxx 參數(shù)1的使用說明， 能否為null* @return 返回結(jié)果的說明， 不同情況下會返回怎樣的結(jié)果* @throws 異常類型 注明從此類方法中拋出異常的說明*/ -
構(gòu)造方法注釋
在每個構(gòu)造方法前面必須加上注釋，注釋模板如下：
/*** 構(gòu)造方法的詳細(xì)說明** @param xxx 參數(shù)1的使用說明， 能否為null* @throws 異常類型 注明從此類方法中拋出異常的說明*/
簡單注解往往是需要工程師自己定義，在使用注解時應(yīng)該注意一下幾點：
七、總結(jié)
無論是命名和注解，他們的目的都是為了讓代碼和工程師進(jìn)行對話，增強(qiáng)代碼的可讀性，可維護(hù)性。優(yōu)秀的代碼往往能夠見名知意，注解往往是對命名的補(bǔ)充和完善。命名太南了！
轉(zhuǎn)載自 ：
作者：浪人~
鏈接：https://www.cnblogs.com/liqiangchn/p/12000361.html
來源：博客園
總結(jié)
以上是生活随笔為你收集整理的【Java】命名规范的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： 如何导入QQ空间迁移助手备份的json
- 下一篇： 20155314 2016-2017-2