J2EE項目代碼編寫規範分享

碼編寫規範目的:能夠在編碼過程中實現規範化,爲以後的程序開發中養成良好的行爲習慣。
代碼編寫規範使用範圍:J2EE項目開發。

包命名規範:
目的:包的命名規範應當體現出項目資源良好的劃分

servlet類所在包命名規範:公司名稱.開發組名稱.項目名稱.web.servlet
例如:net.linkcn.web.servlet

自定義標籤類所在包命名規範:公司名稱.開發組名稱.項目名稱.web.tags
例如:net.linkcn.web.tags

過濾器類所在包命名規範:公司名稱.開發組名稱.項目名稱.web.filter
例如:net.linkcn.web.filter

Action類所在包命名規範:公司名稱.開發組名稱.項目名稱.web.struts.action
例如:net.linkcn.web.struts.action

ActionForm類所在包命名規範:公司名稱.開發組名稱.項目名稱.web.struts.form
例如:net.linkcn.web.struts.form

Javabean所在包命名規範:公司名稱.開發組名稱.項目名稱.web.struts.service.impl
例如:net.linkcn.web.service.impl

Javabean實現接口命名規範:公司名稱.開發組名稱.項目名稱.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框架命名規範

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

J2EE項目提交規範
項目完成時要將項目作爲一個產品交付用戶,良好的項目組織規範可以使用戶可以方便的找尋項目中需要的資源,同時也是一個公司專業性的體現。項目提交時,要按照下列文件格式進行提交。

項目主文件夾:
作用:存放項目其他資源文件。
命名規範:時間_班級編號_第X小組。
例如:070706_GS2T18_第四小組。

項目主文件夾下面包括以下文件夾和文件:
|--src:保存.java文件。
|--database:保存數據庫的腳本文件或者數據庫備份文件。
|--source:保存eclipse工程中WebRoot目錄下的所有文件。
|--depend:保存編譯該程序必須依賴的其他jar文件。
|--javadoc:保存所有類生成的javadoc api文檔。
|--war:保存程序的歸檔文件
|--xx.war:已經打包好的工程文件,可以直接運行。
|--project:保存開發項目原工程代碼及文件。
|--產品說明書.doc:圖文方式展現該產品使用方法。
|--build.xml:ant腳本,用於生成運行的war文件。
|--項目解說.ppt:進行項目講解的ppt(ppt僅供在校模擬項目使用,不用於其他商業用途)

注:一個完整的項目中,數據庫必須有一定量的有效的測試數據來支持該程序的運行

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章