Java開發相關命名規範

来源:http://www.cnblogs.com/caixueliang/archive/2017/09/03/7469638.html
-Advertisement-
Play Games

JAVA文件命名規範 1.類命名 抽象類以 Abstract 或者 Base 開頭。異常類以 Exception 作為尾碼。枚舉類以 Enum 作為尾碼。工具類以 Utils 作為尾碼(相應的包名最後以 .util 結尾)。常量類以 Consts 作為尾碼(相應的包名最後以 .constant 結尾 ...


JAVA文件命名規範

1.類命名

抽象類以 Abstract 或者 Base 開頭。
異常類以 Exception 作為尾碼。
枚舉類以 Enum 作為尾碼。
工具類以 Utils 作為尾碼(相應的包名最後以 .util 結尾)。
常量類以 Consts 作為尾碼(相應的包名最後以 .constant 結尾)。
形容能力的介面使用 able 作為尾碼。
實現類與介面用尾碼 Impl 區別。
數據類:表名(首字母大寫) + DO。
傳輸類:領域相關名 + DTO。
展示類:頁面名稱 + VO。

2.service/dao層方法命名

獲取單個對象的方法用 get 做首碼。
獲取多個對象的方法用 list 做首碼。
獲取統計值的方法用 count 做首碼。
插入的方法用 save 做首碼。
刪除的方法用 remove 做首碼。
修改的方法用 update 做首碼。

3.變數的命名規範

第一個單詞的首字母小寫,其後單詞的首字母大寫 例如:maxValue。
變數名不應以下劃線或美元符號開頭,儘管這在語法上是允許的。變數名應簡短且富於描述。變數名的選用應該易於記憶,即,能夠指出其用途。儘量避免單個字元的變數名,除非是一次性的臨時變數。
pojo中的布爾變數,都不要加is(資料庫中的布爾欄位全都要加 is_ 首碼)。

4.常量/枚舉值的命名規範

常量名/枚舉值應該都使用大寫字母,下劃線分割單詞。
例如:MAX_VALUE

資料庫命名規範

表名和欄位名字必須用小寫字母或數字,數字不可開頭,兩個下劃線中間不能只有數字。
庫名與應用名儘量一致。
表名:業務名稱_表的作用(單數形式)。
主鍵索引:pk_欄位名。
唯一索引:uk_欄位名。
普通索引:idx_欄位名。
表示是否欄位:is_xxxx unsigned tinyint(1.表示是,0表示否)。
觸發器:trg_表名_[insert | update | delete]

JUnit單元測試命名規範

1.測試類的命名規範

類的命名規則是:被測試的業務 + Test、被測試的介面 + Test、被測試的類 + Test。
類的名字必須由大寫字母開頭而其他字母均為小寫;如果類名稱由多個單片語成,則每個單詞的首字母均應為大寫,如MobileBindTest。如果類名稱中包含單詞縮寫,則這個所寫詞的每個字母均應大寫,如:XMLExample。

2.被測方法的命名規範

test + 被測方法_測試時所處狀態 或者 test + 被測方法_具體測試方法。
比如要測試的用例是“資料庫用戶信息不存在時,獲取Mobile綁定消息”,那麼它的測試用例名稱就是testSetMobileBind_NoSkyid。
​比如要測試的方法是findParam,採用的是邊界值方法,那麼它的測試用例名稱可以是testFindParam_Boundaries。

3.測試包命名規範

被測試類的包名前加上“test.” 。被測試類的包名是com.wistrons.util,那麼測試類的包名就是test.com.wistrons.util。
(通過maven構建項目,預設情況家已經建好了test文件夾,不需要再包前面加上test首碼了。)

註釋規範

註釋不是必須的,語義清晰的代碼不需要註釋。
類、類屬性、類方法必須使用 Javadoc 註釋。
類註釋至少標明作用、創建者和創建日期。
抽象方法必須使用 Javadoc 註釋,至少標明功能(參數、返回值、異常、子類的實現要求等可斟酌加上)。
枚舉值必須有註釋,建議用段落註釋(使用/*內容*/格式)。
修改代碼同時,註釋也要做相應的修改。

版本控制工具提交信息規範

第1行:提交修改內容的摘要(少於25個漢字,或英文大寫字母開始,不加句號,使用祈使句。)
第2行:空行
第3行及以後:修改的理由(36個漢字左右換行,正文解釋是什麼和為什麼,而不是如何做。)

備註

部分參考自《阿裡巴巴Java開發手冊v1.2.0》。
不同公司的命名規範還應該根據各自公司內部要求來制定。以上只是提供一個參考。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 類 大多數R對象都是基於S3類(來源於第三代S語言),例如直方圖函數hist()輸出是一個包含多個組件的列表,它還有一個屬性(attribute),用來指定列表的類,即histogram類。 泛型函數 類用在泛型函數中,泛型函數是一個函數族,其中的每個函數都有相似的功能,但是適用於某個特定的類。比如 ...
  • 註釋:就是對程式內容的解釋 單行註釋: // 多行註釋 : /** *** **/ 一下語句強制記憶: public static void main(String[] args){ //java語句用“;” 結尾 //java中所有的字元串都使用雙引號括起來 //一下的雙引號必須是半形的雙引號 S ...
  • 重載與重寫的區別 java中的重載就是在類中創建多個同名方法,但是方法簽名(參數列表)不同,返回值可以相同也可以不相同(不能使用返回值區分方法的重載),方法體也不同。 1)發生在同一個類中,方法名稱相同,參數列表不同 2)編譯器在編譯時會根據方法的簽名自動綁定方法 重寫: 1)發生在父子類中,方法名 ...
  • Python包含6種內建的序列:列表,元組,字元串,Unicode,buffer對象,xrange對象。 通用序列操作包括:索引,分片,加,乘,成員資格。 另外還有長度(len),最小值(min),最大值(mix)內建函數 列表 列表 基本的列表操作 列表方法 元組 元組 ...
  • 還看到有說這樣做的,不過使用第一次加進來了,clean一次後又不打包hbm.xml文件。 如果是 jar 包,在 Plugin 中配置: 如果是 war 包,在 Plugin 中配置: ...
  • 一:讀程式寫結果 二:根據題意寫出相應代碼 ...
  • Java程式員有許多應遵循的守則或最佳實踐方式。本文概述了每個開發者最應該遵循的10條守則或戒律,如果不遵循它們,將會導致災難性後果。 1. 為代碼添加註釋(Add comments to your code). – 每個人都知道這一點,但不是每個人都會這麼做。你有多少次“忘記”添加註釋了?確實,註 ...
  • 最近在做一個手機移動端的項目,Andrio手機和部分iphone手機上點擊事件都是好的,只有在老的型號上的iphone手機上點擊事件無效果。 後來在網上查了很多資料,發現有加樣式cursor:pointer的,有將click事件和touchstart事件並存的,結果嘗試了這兩個方法,都沒有效果。準備 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...