程式師世界 >> 編程語言 >> JAVA編程 >> 關於JAVA >> J2EE項目代碼編寫標准分享

J2EE項目代碼編寫標准分享

編輯：關於JAVA

J2EE項目代碼編寫標准分享。本站提示廣大學習愛好者：（J2EE項目代碼編寫標准分享）文章只能為提供參考，不一定能成為您想要的結果。以下是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;