白盒测试 [代码规范] [J2EE]

　http://img.tongji.linezing.com/2051467/tongji.gif

    包命名规范：
　　目的：包的命名规范应当体现出项目资源良好的划分

　　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）{}

　　注释规范：注释规范是整个开发规范中最为重要的组成部分，必须严格执行。
　　类的注释：
　　作用：注释整个类，简单概述该类作用。
　　书写规范：类的注释必须写在该类的声明语法之前。在注释中要描述该类的基  本作用，作者，日期，版本，公司名称，版权声明。
格式：
 
　　类的声明语法
　　例如：

public class AdminDAO

　　变量、常量注释：
　　作用：简单描述该变量的意义。
　　书写规范：变量注释必须写在变量定义之前，简单描述其代表的意义。
　　格式：

例如：
   
public int age;

　　方法注释：
　　作用：对该方法功能简单描述，其参数、返回值意义的注解。
　　书写规范：方法注释必须写在方法定义之前。该注释包括：方法其功能的简单  描述，方法的参数、返回值类型、返回值意义简单的描述。
格式：
       
　　例如：

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仅供在校模拟项目使用，不用于其他商业用途）

　　注：一个完整的项目中，数据库必须有一定量的有效的测试数据来支持该程序的运行