JavaWeb 命名規則

時間 2019-11-17

標籤 javaweb 命名規則欄目 Java 简体版

原文原文鏈接

命名規範
命名規範命名規範
命名規範css

本規範主要針對java開發制定的規範項目命名
項目命名項目命名
項目命名html

項目建立，名稱全部字母均小寫，組合方式爲：
com.company.projectName.component.hiberarchy。
1. projectName：項目名稱
2. component：模塊名稱
3. hiberarchy：開發層次名稱
例如：
com.company.tims.exchange.dao 類文件夾命名java

------------------------------------------
類命名規範程序員

基本命名規範：
類命名
命名規範：以大寫字母開頭，若是有多個單詞，每一個單詞頭字母大寫
例如：UserInfoweb

接口命名
命名規範：以大寫字母"I"開頭，若是有多個單詞，每一個單詞頭字母大寫
例如：IStudentInfo數據庫

接口實現類命名：
命名規範：將實現的接口名稱的首字母"I"去掉，以"Impl做爲結尾"，若是有多個單詞，每一個單編程

詞頭字母大寫。
例如：StudentInfoImplapi

------------------------------------------
J2EE+SSH框架命名規範數組

servlet類命名：
命名規範：以Servlet單詞結尾
例如：LoginServlet框架

POJO命名：
使用hibernate自動生成的類便可

DAO類命名：
使用hibernate自動生成的類便可

Action類命名：
命名規範：Action的命名以POJO名稱來制定，POJO名稱Action
例如：
一個POJO名稱爲Diary，其對應的action爲DiaryAction

ActionForm類命名：
命名規範：ActionForm的命名以POJO名稱來制定，POJO名稱Form
例如：
一個POJO名稱爲Diary，其對應的actioForm爲DiaryForm

業務邏輯接口命名:
命名規範：業務邏輯接口的命名以POJO名稱來制定，IPOJO名稱Service
例如：
一個POJO名稱爲Diary，其對應的業務邏輯接口爲IDiaryService

業務邏輯實現類命名:
命名規範：業務邏輯接口實現類的命名以POJO名稱來制定
例如：
一個POJO名稱爲Diary，對應的業務邏輯接口實現類名爲DiaryServiceImpl

------------------------------------------------

類變量命名：
命名規範：變量名首字母必須小寫，若是該變量名有多個單詞組成，後面的單詞首字母大寫，

單詞與單詞之間不要使用"_"作鏈接，變量名訪問控制必須爲私有，能夠對其增長setter與

getter方法。
例如：
private int studentAge;
public int getStudentAge(){
return studentAge;
}
public void setStudentAge(int studentAge) {
this.studentAge=studentAge;
}

常量命名：
命名規範：全部字母大寫，若是有多個單詞組成，單詞與單詞之間以」 _「隔開。並且該變量

必須是公共、靜態、final類型
例如：public static final String USER_NAME=」userName「;

方法命名：
命名規範：首字母必須小寫，若是該變量名有多個單詞組成，後面的單詞首字母大寫，單詞與

單詞之間不要使用"_"作鏈接。單詞不要使用名詞。
例如：public int checkLogin（String name,String pwd）{}

--------------------------------------------------------
註釋規範：註釋規範是整個開發規範中最爲重要的組成部分，必須嚴格執行。
類的註釋：
做用：註釋整個類，簡單概述該類做用。
書寫規範：類的註釋必須寫在該類的聲明語法以前。在註釋中要描述該類的基本做用，做者，

日期，版本，公司名稱，版權聲明。
格式：
/* *
* 類功能描述：（大體描述類的功能）
* @author：編寫者名稱
*
* @version：類文件的版本號從1.0開始（本身肯定版本號的增改
* 狀況），修改狀況（修改時間、做者、改動狀況）
*
* @see 包名.參考類名（列出父類，引入類，每一個類佔一行），若是有
* 可省略
* 相關數據如：（便於理解本類的一些常量數據及某些數據的格式
* 或認爲比較重要的數據，若是沒有可省略）
*/
類的聲明語法

例如：
/**
* Title:管理員模塊數據處理類 
* Description: 兩個數相加
* Copyright: Copyright (c) 2007
* Company:華騰軟件公司
*
* @author 童金虎
*
* @version $Revision: 1.7 $ $Date: 2007/07/08$
*/
public class AdminDAO

變量、常量註釋：
做用：簡單描述該變量的意義。
書寫規範：變量註釋必須寫在變量定義以前，簡單描述其表明的意義。
格式：
/**
* 變量功能描述：（大體描述變量的功能）
*/

例如：

/**
*定義年齡變量
*/
public int age;
方法註釋：
做用：對該方法功能簡單描述，其參數、返回值意義的註解。
書寫規範：方法註釋必須寫在方法定義以前。該註釋包括：方法其功能的簡單描述，方法的參

數、返回值類型、返回值意義簡單的描述。
格式：
/**
* 方法功能說明
* @param args (參數類型能夠寫在參數後，也能夠省
* 略。每一個參數佔一行)
* @return 輸出參數（多種狀況寫在同一行）
* @see 類#參考方法（與此方法有調用關係的方法供參
* 考，沒必要每一個方法都完整列出，要選擇有意義的，每一個
* 方法佔一行）
* @exception 異常處理類（方法中可以引起的異常，每
* 個異常佔一行）
*/

例如：
/**
* 修改管理員密碼
* @param adminId 管理員編號
* @param oldPassword 舊密碼
* @param password 新密碼
* @return boolean 是否編輯成功
* @throws UserException
* @throws ServiceException
*/
public booleaneditAdminPassword(int adminId,String oldPassword,
String password) throws UserException,ServiceException;

-----------------------------------------------------------
Jsp頁面命名：
命名規範：jsp頁面名稱要以小寫字母開頭，若是有多個單詞組成，後面的單詞以大寫字母開

頭。名稱要體現出該頁面的意義，最好可以與模塊名稱聯繫在一塊兒。
例如：
login.jsp --登陸頁面
register.jsp --註冊頁面
message.jsp --客戶留言頁面

------------------------------------------------------------
J2EE項目工程文件夾組織規範：
目的：規範學員web應用程序的資源組織形式，造成良好的文件組織習慣。文件的組織形式應當

體現模塊的劃分。
根據eclipse工具的特徵，項目的目錄結構爲：
src
----存放java文件

Java代碼

WebRoot
|--images --存放web程序所需的公共圖片
|--css --存放web程序所需的公共樣式表
|--js --存放web程序所需的公共js文件
|--commons --存放web程序所需的公共文件
|--功能模塊文件夾(存放與某個功能模塊相關的資源)
|--images --存放與該功能模塊相關的圖片
|--css --存放與該模塊相關的樣式表文件
|--js --存放與該模塊相關的js文件
|--jsp、html頁面
|--WEB-INF
|--classes
|--lib
|--tld文件

---------------------------------------------------------------
J2EE項目提交規範
項目完成時要將項目做爲一個產品交付用戶，良好的項目組織規範可使用戶能夠方便的找尋

項目中須要的資源，同時也是一個公司專業性的體現。項目提交時，要按照下列文件格式進行

------------------------------------------------------
包的命名　
Java包的名字都是由小寫單詞組成。可是因爲Java面向對象編程的特性，每一名Java程序員都

能夠編寫屬於本身的Java包，爲了保障每一個 Java包命名的惟一性，在最新的Java編程規範中，

要求程序員在本身定義的包的名稱以前加上惟一的前綴。因爲互聯網上的域名稱是不會重複的

，因此程序員通常採用本身在互聯網上的域名稱做爲本身程序包的惟一前綴。
例如： net.frontfree.javagroup

類的命名
類的名字必須由大寫字母開頭而單詞中的其餘字母均爲小寫；若是類名稱由多個單詞組成，則

每一個單詞的首字母均應爲大寫例如TestPage；若是類名稱中包含單詞縮寫，則這個所寫詞的每

個字母均應大寫，如：XMLExample,還有一點命名技巧就是因爲類是設計用來表明對象的，因此

在命名類時應儘可能選擇名詞。　　
例如： Circle

方法的命名
方法的名字的第一個單詞應以小寫字母做爲開頭，後面的單詞則用大寫字母開頭。
例如： sendMessge

常量的命名
常量的名字應該都使用大寫字母，而且指出該常量完整含義。若是一個常量名稱由多個單詞組

成，則應該用下劃線來分割這些單詞。
例如： MAX_VALUE

參數的命名
參數的命名規範和方法的命名規範相同，並且爲了不閱讀程序時形成迷惑，請在儘可能保證參

數名稱爲一個單詞的狀況下使參數的命名儘量明確。

Javadoc註釋
Java除了能夠採用咱們常見的註釋方式以外，Java語言規範還定義了一種特殊的註釋，也就是

咱們所說的Javadoc註釋，它是用來記錄咱們代碼中的API的。Javadoc註釋是一種多行註釋，以

/**開頭，而以*/結束，註釋能夠包含一些HTML標記符和專門的關鍵詞。使用Javadoc 註釋的好

處是編寫的註釋能夠被自動轉爲在線文檔，省去了單獨編寫程序文檔的麻煩。
例如：
/**
* This is an example of
* Javadoc
*
* @author darchon
* @version 0.1, 10/11/2002
*/
在每一個程序的最開始部分，通常都用Javadoc註釋對程序的整體描述以及版權信息，以後在主程

序中能夠爲每一個類、接口、方法、字段添加 Javadoc註釋，每一個註釋的開頭部分先用一句話概

括該類、接口、方法、字段所完成的功能，這句話應單獨佔據一行以突出其歸納做用，在這句

話後面能夠跟隨更加詳細的描述段落。在描述性段落以後還能夠跟隨一些以Javadoc註釋標籤開

頭的特殊段落，例如上面例子中的@auther和@version，這些段落將在生成文檔中以特定方式顯

示。

變量和常量命名
變量命名的方法採用匈牙利命名法，基本結構爲scope_typeVariableName，它使用3字符前綴來

表示數據類型，3個字符的前綴必須小寫，前綴後面是由表意性強的一個單詞或多個單詞組成的

名字，並且每一個單詞的首寫字母大寫，其它字母小寫，這樣保證了對變量名可以進行正確的斷

句。例如，定義一個整形變量，用來記錄文檔數量：intDocCount，其中int代表數據類型，後

面爲表意的英文名，每一個單詞首字母大寫。這樣，在一個變量名就能夠反映出變量類型和變量

所存儲的值的意義兩方面內容，這使得代碼語句可讀性強、更加容易理解。byte、int、char、

long、float、 double、boolean和short。
變量類型和首字母對照關係以下表：
數據類型/對象類型 / 變量前綴 / 備註
byte bye
char chr
float flt
boolean bln 作布爾變量時，使用bln
Integer/int int
String str
Single sng
short sht
Long/long lng
Double/double dbl
Currency cur
Variant bln astr obj vnt 作布爾變量用時，用bln，作字符串數組用時，用astr，作爲對象

使用時，用obj，不肯定時，用vnt。
對於數組，在數據類型的前綴前再增長一個a，例如字符串數組爲astr。對於在多個函數內都要

使用的全局變量，在前面再增長「g_」。例如一個全局的字符串變量：g_strUserInfo。

在變量命名時要注意如下幾點：
· 選擇有意義的名字，注意每一個單詞首字母要大寫。

· 在一段函數中不使用同一個變量表示先後意義不一樣的兩個數值。

· i、j、k等只做爲小型循環的循環索引變量。
· 避免用Flag來命名狀態變量。
· 用Is來命名邏輯變量，如：blnFileIsFound。經過這種給布爾變量確定形式的命名方式，使

得其它開發人員可以更爲清楚的理解布爾變量所表明的意義。
· 若是須要的話，在變量最後附加計算限定詞，如：curSalesSum。
· 命名不相包含，curSales和curSalesSum。
· Static Final 變量的名字應該都大寫，而且指出完整含義。
· 若是須要對變量名進行縮寫時，必定要注意整個代碼中縮寫規則的一致性。例如，若是在代

碼的某些區域中使用intCnt，而在另外一些區域中又使用intCount，就會給代碼增長沒必要要的復

雜性。建議變量名中儘可能不要出現縮寫。
· 經過在結尾處放置一個量詞，就可建立更加統一的變量，它們更容易理解，也更容易搜索。

例如，請使用 strCustomerFirst和strCustomerLast，而不要使用strFirstCustomer和

strLastCustomer。經常使用的量詞後綴有：First（一組變量中的第一個）、Last（一組變量中的

最後一個）、Next（一組變量中的下一個變量）、Prev（一組變量中的上一個）、Cur（一組變

量中的當前變量）。
· 爲每一個變量選擇最佳的數據類型，這樣即能減小對內存的需求量，加快代碼的執行速度，又

會下降出錯的可能性。用於變量的數據類型可能會影響該變量進行計算所產生的結果。在這種

狀況下，編譯器不會產生運行期錯誤，它只是迫使該值符合數據類型的要求。這類問題極難查

找。
· 儘可能縮小變量的做用域。若是變量的做用域大於它應有的範圍，變量可繼續存在，而且在不

再須要該變量後的很長時間內仍然佔用資源。它們的主要問題是，任何類中的任何方法都能對

它們進行修改，而且很難跟蹤到底是何處進行修改的。佔用資源是做用域涉及的一個重要問題

。對變量來講，儘可能縮小做用域將會對應用程序的可靠性產生巨大的影響。
關於常量的命名方法，在JAVA代碼中，不管何時，均提倡應用常量取代數字、固定字符串

。也就是說，程序中除0，1之外，儘可能不該該出現其餘數字。常量能夠集中在程序開始部分定

義或者更寬的做用域內，名字應該都使用大寫字母，而且指出該常量完整含義。若是一個常量

名稱由多個單詞組成，則應該用下劃線「_」來分割這些單詞如：NUM_DAYS_IN_WEEK、

MAX_VALUE。

source代碼模塊 config配置文件模塊 test 測試模塊包命名
包命名包命名
包命名

規則o 所有小寫。o 標識符用點號分隔開來。爲了使包的名字更易讀。如
com.leadal.shanty
經常使用幾個包名o dao:數據層o service:邏輯層o model:持久類定義包 實現Serializable接

口，建立serialVersionUID 主鍵統一用id標識，Long類型o web:表示層及控制層o enums:枚

舉類型o config:配置文件類包o resource:資源文件包類文件命名
類文件命名類文件命名
類文件命名

儘可能以英文進行類定義全部類都以大寫字母開頭組合詞每一個詞以大寫字母開頭，不用下劃線

或其餘符號避免使用單詞的縮寫，除非它的縮寫已經廣爲人知，如HTTP變量命名
變量命名變量命名
變量命名

第一個字母小寫，中間單詞的第一個字母大寫不用_或&做爲第一個字母。儘可能使用短並且具

有意義的單詞單字符的變量名通常只用於生命期很是短暫的變量。i,j,k,m,n通常用於
integers；c,d,e通常用於characters
若是變量是集合，則變量名應用複數。
String myName;

int[] students;

int i;

int n;

char c;

btNew;

(bt是Button的縮寫)

常量命名
常量命名常量命名
常量命名