1. 程式人生 > >java程式碼命名規範

java程式碼命名規範

【強制】程式碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。

反例:_name / __name / Object/name/name / Object$

【強制】程式碼中的命名嚴禁使用拼音與英文混合的方式,更不允許直接使用中文的方式。 說明:正確的英文拼寫和語法可以讓閱讀者易於理解,避免歧義。注意,即使純拼音命名方式 也要避免採用。
正例:alibaba / taobao / youku / hangzhou 等國際通用的名稱,可視同英文。 反例:DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變數 = 3

【強制】類名使用 UpperCamelCase 風格,必須遵從駝峰形式,但以下情形例外:DO / BO / DTO / VO / AO
正例:MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion 反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

【強制】方法名、引數名、成員變數、區域性變數都統一使用 lowerCamelCase 風格,必須遵從 駝峰形式。

正例: localValue / getHttpMessage() / inputUserId

【強制】常量命名全部大寫,單詞間用下劃線隔開,力求語義表達完整清楚,不要嫌名字長。

 正例: MAX_STOCK_COUNT     反例:MAX_COUNT

6.【強制】抽象類命名使用 Abstract 或 Base 開頭
7.【強制】異常類命名使用 Exception 結尾;
8.【強制】測試類 命名以它要測試的類的名稱開始,以 Test 結尾。
9.【強制】中括號是陣列型別的一部分,陣列定義如下:String[] args;
反例:使用String args[]的方式來定義。

  1. 【強制】POJO 類中布林型別的變數,都不要加 is,否則部分框架解析會引起序列化錯誤。
    反例:定義為基本資料型別Boolean isDeleted;的屬性,它的方法也是isDeleted(),RPC 框架在反向解析的時候,“以為”對應的屬性名稱是 deleted,導致屬性獲取不到,進而丟擲異常。

  2. 【強制】包名統一使用小寫,點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用 單數形式,但是類名如果有複數含義,類名可以使用複數形式。
    正例: 應用工具類包名為com.doctorwok.open.util、類名為MessageUtils(此規則參考 spring 的框架結構)

  3. 【強制】杜絕完全不規範的縮寫,避免望文不知義。
    反例: AbstractClass“縮寫”命名成 AbsClass;condition“縮寫”命名成 condi,此類隨 意縮寫嚴重降低了程式碼的可閱讀性。

  4. 【推薦】為了達到程式碼自解釋的目標,任何自定義程式設計元素在命名時,使用盡量完整的單詞 組合來表達其意。
    正例:從遠端倉庫拉取程式碼的類命名為 PullCodeFromRemoteRepository。 反例:變數 int a; 的隨意命名方式。

  5. 【推薦】如果模組、介面、類、方法使用了設計模式,在命名時體現出具體模式。 說明:將設計模式體現在名字中,有利於閱讀者快速理解架構設計理念。
    正例:public class OrderFactory;public class LoginProxy; public class ResourceObserver;

    15.【推薦】介面類中的方法和屬性不要加任何修飾符號(public 也不要加),保持程式碼的簡潔性,並加上有效的 Javadoc 註釋。儘量不要在接口裡定義變數,如果一定要定義變數,肯定是 與介面方法相關,並且是整個應用的基礎常量。
    正例:介面方法簽名:void f();介面基礎常量表示:String COMPANY = “alibaba”; 反例:介面方法定義:public abstract void f();
    說明:JDK8 中介面允許有預設實現,那麼這個 default 方法,是對所有實現類都有價值的默 認實現。

  6. 介面和實現類的命名有兩套規則:
    1)【強制】對於 Service 和 DAO 類,基於 SOA 的理念,暴露出來的服務一定是介面,內部的實現類用 Impl 的字尾與介面區別
    正例:CacheServiceImpl 實現 CacheService 介面。

     2)【推薦】 如果是形容能力的介面名稱,取對應的形容詞做介面名(通常是–able 的形式)。 
             正例:AbstractTranslator 實現 Translatable。
    
    1. 【參考】列舉類名建議帶上 Enum 字尾,列舉成員名稱需要全大寫,單詞間用下劃線隔開。

      說明:列舉其實就是特殊的常量類,且構造方法被預設強制是私有。 正例:列舉名字為ProcessStatusEnum的成員名稱:SUCCESS / UNKOWN_REASON。

    2. 【參考】各層命名規約:
      A) Service/DAO層方法命名規約

         1) 獲取單個物件的方法用get做字首。 
         2) 獲取多個物件的方法用list做字首。 
         3) 獲取統計值的方法用count做字首。 
         4) 插入的方法用save/insert做字首。
         5) 刪除的方法用remove/delete做字首。 
         6) 修改的方法用update做字首。
      

      B) 領域模型命名規約
      1) 資料物件:xxxDO,xxx即為資料表名。
      2) 資料傳輸物件:xxxDTO,xxx為業務領域相關的名稱。
      3) 展示物件:xxxVO,xxx一般為網頁名稱。
      4) POJO是DO/DTO/BO/VO的統稱,禁止命名成xxxPOJO。

相關推薦

java程式碼命名規範

【強制】程式碼中的命名均不能以下劃線或美元符號開始,也不能以下劃線或美元符號結束。 反例:_name / __name / Object/name/nameObject/name/name / Object$ 【強制】程式碼中的命名嚴禁使用拼音與英文混合的方

java學習:Java程式碼編寫規範對開發的重要性

本文從Java程式碼編寫的初期到結尾,做了一次整體的總結,希望對初學者有幫助。 一個錯誤的命名會很誤導人,不良的命名,對於閱讀程式碼的人來說很糾結。一個良好的命名對自己也有很大的幫助。 我個人命名的變數都比較長,一般是單詞的全稱,這樣程式碼讀起來易懂,有些縮寫你根本不知道它代表的單詞是

Idea-Java程式碼註釋規範

  IDEA自帶的註釋模板不是太好用,我本人到網上搜集了很多資料系統的整理了一下製作了一份比較完整的模板來分享給大家(如果嫌配置繁瑣,可以在本頁面最下方下載jar包,匯入idea,就可以了)。 一、首先我們來設定IDEA中類的模板:(IDEA中在建立類時會自動給添加註釋)

IDEAL葵花寶典:java程式碼開發規範外掛 FindBugs-IDEA

 前言: 檢測程式碼中可能的bug及不規範的位置,檢測的模式相比p3c更多,寫完程式碼後檢測下 避免低階bug,強烈建議用一下,一不小心就發現很多老程式碼的bug。 使用步驟: 1):開啟 Settings---->Plugins---> 進行搜尋--->選擇---->"FindBug

IDEAL葵花寶典:java程式碼開發規範外掛 checkstyle、visualVM、PMD 外掛

前言: visualVM: 執行java程式的時候啟動visualvm,方便檢視jvm的情況 比如堆記憶體大小的分配;某個物件佔用了多大的記憶體,jvm調優必備工具。 checkstyle: CheckStyle是SourceForge下的一個專案,提供了一個幫助JAVA開發人員遵守某些編碼規範的工具。   

JAVA 開發命名規範——阿里巴巴Java開發手冊

0)Service/DAO層方法命名規約 1)獲取單個物件的方法用get做字首。 2)獲取多個物件的方法用list做字首。 3)獲取統計值的方法用count做字首。 4)插入的方法用save(推薦)或insert做字首。 5)刪除的方法用remove(推薦)或delete做字

JAVA程式碼編寫規範

Nested “enum”s should not be declared static squid Noncompliant Code Example public class Flower { static enum Color { // Non

JAVA 程式碼安全規範

申明:本文非筆者原創,原文轉載自:https://github.com/SecurityPaper/SecurityPaper-web/blob/master/_posts/2.SDL%E8%A7%84%E8%8C%83%E6%96%87%E6%A1%A3/2018-08-17-SDL-3-java

Java程式碼格式規範個人推薦

個人整理Java編碼格式規範,也是本人在開發中遵守的規範。程式碼格式規範,僅是為了體現一種規範和美觀,大家可根據各自情況和公司要求遵守自己的規範。 /**  * Java編碼格式個人推薦,參考JDK原始碼和Hyperic HQ原始碼(原spring旗下著名開源軟體,現vmw

java程式碼參考規範

字首 字首名 描述 舉例 Abstract 抽象類 AbstractBeanFactory Base 基礎類(提供常用方法) BaseDao Default 預設類(對某介面的預設實現) DefaultAopProxyFactory 字尾 字尾名 描述 舉例 Service 表

java程式碼註釋規範(二)

一、背景  1、當我們第一次接觸某段程式碼,但又被要求在極短的時間內有效地分析這段程式碼,我們需要什麼樣的註釋資訊?  2、怎麼樣避免我們的註釋冗長而且凌亂不堪呢?  3、在多人協同開發、維護的今天,我們需要怎麼樣的註釋來保證高質、高交的進行開發和維護工作呢?  二、意義

程式碼命名規範

詞語選擇避免使用由經常使用的名稱空間複製的型別名。型別名不能使用下列詞語。 System       Collections   Forms       UI避免使用與常用關鍵詞衝突的識別符號。例如,避免使用下列詞語。 AddHandler AddressOf Alias And Ansi As Assem

高質量JAVA程式碼編寫規範

轉自:https://www.douban.com/note/82618786/ 1. Java 命名約定   除了以下幾個特例之外,命名時應始終採用完整的英文描述符。此外,一般應採用小寫字母,但類名、介面名以及任何非初始單詞的第一個字母要大寫。1.1 一般概念  * 儘量

Android程式碼命名規範

前言 Android程式碼規範內容非常多,但對我們最有用& 最有影響的莫過於 Android程式碼的命名規範 可是,有很多人容易忽略Android程式碼的命名規範,從而導致程式碼的可讀性 & 維護性非常差,最終導致開發效率 & 維護效率降低 目

java程式碼書寫規範

一、目的     對於程式碼,首要要求是它必須正確,能夠按照程式設計師的真實思想去執行;第二個的要求是程式碼必須清晰易懂,使別的程式設計師能夠容易理解程式碼所進行的實際工作。在軟體工程領域,源程式的風格統一標誌著可維護性、可讀性,是軟體專案的一個重要組成部分。而目前還沒有成文

JAVA專案命名規範和資料庫設計規範

一、命名規範 1、 專案名全部小寫 2、 包名全部小寫 3、 類名首字母大寫,如果類名由多個單片語成,每個單詞的首字母都要大寫。 如:public class MyFirstClass{} 4、 變數名、方法名首字母小寫,如果名稱由多個單片語成,每個單詞的首字母都要大寫。 如:int inde

Java項目命名規範

lob 標簽 接口 servle 一個數 大寫 命名規範 組成 所在 1、 項目名全部小寫 2、 包名全部小寫 3、 類名首字母大寫,一般都是使用駝峰式命名。 4、變量名、方法名首字母小寫,如果名稱由多個單詞組成,每個單詞的首字母都要大寫。 5、 常量名全

命名規範及部分書寫規範----參照阿裏巴巴java開發手冊

實現類 toc tcpudp size 全部 sla 工具類 apr alibaba 只列一些我能看懂的.... 1類名使用 UpperCamelCase 風格,必須遵從駝峰形式,但以下情形例外:DO / BO / DTO / VO / AO   正例:MarcoPolo

Java命名規範

Ltd. 數字 背景 方法名 類註釋 ava oid 命名 bgcolor 一、命名規範 1、 項目名全部小寫 2、 包名全部小寫 3、 類名首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫。 如:public class MyFirstClass{} 4、 變

Java 命名規範

bgcolor OS str 創建 內部 命名 錯誤 不能 copy 一、命名規範 1、 項目名全部小寫 2、 包名全部小寫 3、 類名首字母大寫,如果類名由多個單詞組成,每個單詞的首字母都要大寫。 如:public class MyFirstClass{} 4、 變量名、