您现在的位置：程式碼之家 >> 編程語言 > >> Java 程式設計 >> J2EE

J2EE 專案代碼編寫規範全書：包命名、類設計、註釋、目錄結構與交付標準

編輯：J2EE

一、包命名規範：模塊化分層的基石

格式：公司名.開發組.項目名.功能層.模塊，全部小寫，單詞間無分隔符。

功能層	包後綴	示例 (net.linkcn 專案)
Servlet	.web.servlet	net.linkcn.web.servlet
自定義標籤	.web.tags	net.linkcn.web.tags
過濾器	.web.filter	net.linkcn.web.filter
Struts Action	.web.struts.action	net.linkcn.web.struts.action
Struts ActionForm	.web.struts.form	net.linkcn.web.struts.form
Service 實現	.web.struts.service.impl	net.linkcn.web.service.impl
Service 接口	.web.service	net.linkcn.web.service
DAO 實現	.dao.impl	net.linkcn.dao.impl
DAO 接口	.dao	net.linkcn.dao
POJO/HBM	.dao.hbm	net.linkcn.dao.hbm
全局公共類	.global	net.linkcn.global
工具類	.util	net.linkcn.util

二、類與接口命名規範

通用原則

類/接口：帕斯卡命名法 (大寫開頭，單詞首字母大寫)，如 StudentInfo。
接口：以 I 開頭，如 IStudentInfo。
實現類：去掉接口 I，尾綴 Impl，如 StudentInfoImpl。

J2EE/SSH 專用命名

角色	規則	示例 (POJO=Diary)
Servlet	以 Servlet 結尾	LoginServlet
POJO/DAO	Hibernate 自動生成	Diary / DiaryDao
Action	POJO名 + Action	DiaryAction
ActionForm	POJO名 + Form	DiaryForm
Service 接口	I + POJO名 + Service	IDiaryService
Service 實現	POJO名 + ServiceImpl	DiaryServiceImpl

三、變量、常量、方法命名

實例變量： 駝峰命名，首字母小寫，私有 + getter/setter。private int studentAge;
常量： 全大寫，單詞下劃線分隔，public static final。USER_NAME
方法： 駝峰命名，首字母小寫，動詞開頭，無下劃線。checkLogin(String name, String pwd)

四、註釋規範：代碼可維護性的生命線

類註釋 (Javadoc 標準)

/**
 * Title: 模塊名稱
 * Description: 功能描述
 * Copyright: Copyright (c) 2007
 * Company: 公司名
 * @author 作者
 * @version $Revision: 1.7 $ $Date: 2007/07/08$
 * @see 父類/引用類
 * 相關數據說明
 */

變量/常量註釋

/** 定義年齡變量 */
private int age;

方法註釋 (強制)

/**
 * 修改管理員密碼
 * @param adminId 管理員編號
 * @param oldPassWord 舊密碼
 * @param passWord 新密碼
 * @return boolean 是否成功
 * @throws UserException
 * @throws ServiceException
 */
public boolean editAdminPassWord(int adminId, String oldPassWord, String passWord)
    throws UserException, ServiceException;

五、JSP 頁面命名與目錄結構

JSP 命名

駝峰命名，首字母小寫，語義化關聯模塊：login.jsp, register.jsp, messageList.jsp。

Eclipse 專案標準目錄結構

src/                          -- Java 源碼
WebRoot/
├── images/                   -- 全局圖片
├── css/                      -- 全局樣式
├── js/                       -- 全局腳本
├── commons/                  -- 通用片段
├── [模塊名]/                 -- 功能模塊目錄
│   ├── images/
│   ├── css/
│   ├── js/
│   └── *.jsp/*.html
└── WEB-INF/
    ├── classes/
    ├── lib/
    └── *.tld

六、專案交付打包規範

主目錄命名：時間_班級編號_第X小組 (如 070706_GS2T18_第四小組)

子目錄/文件	內容
src/	所有 .java 源碼
database/	SQL 腳本或數據庫備份
source/	WebRoot 完整內容
depend/	編譯依賴的第三方 JAR
javadoc/	所有類生成的 Javadoc API 文檔
war/	打包後的 .war 文件 (可直接部署運行)
project/	原始 Eclipse 工程完整代碼
產品說明書.doc	圖文操作手冊
build.xml	Ant 構建腳本 (生成 war)
項目解說.ppt	答辯演示文稿 (教學專用)