Java Web开发编程规范v1.0

JavaWeb开发编程规范vi.o

ByAway@2023.11.13

代码编写规范目的J：可以在编码过程中实现规范化，为后来日勺程序开发中养成良好的行

为习惯。

代码编写规范使用范围：J2EE项目开发。

1包命名规范：

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

1.servlet类所在包命名规范：企业名称.开发组名称.项目名称.web.servlet

2.自定义标签类所在包命名规范：企业名称.开发组名称.项目名称.web.tags

例如：com.whut.web.tags

3.过滤器类所在包命名规范：企业名称.开发组名称项目名称.web.filter

例如：com.whut.web.filter

4.

例如：com.whut

5.

例如:com.whut

6.

例如:com.whut

7.Javabean实现接口命名规范：企业名称.开发组名称,项目名称.web.service

例如：com.whut.wcb.service

8.DAO类所在包命名规范：企业名称.开发组名称.项目名称.dao.impl

例如：.dao.impl

9.DAO类所实现的接口在包中命名规范：企业名称.开发组名称.项目名称.dao

例如：.dao

10.POJO类与hbm文献所在包命名规范：企业名称.开发组名称.项目名称.dao.hbm

例如：.dao.hbm

11.全局公共类、接口类所在包命名规范：企业名称.开发组名称.项目名称.global

例如：.global

12.全局工具类所在包命名规范：企业名称.开发组名称.项目名称.util

例如：curn.whul.web..ulil

2类命名规范

基本命名规范：

1.类、接口命名

命名规范：以大写字母开头，假如有多种单词，每个单词头字母大写

例如：Studentinfo

2.接口命名

命名规范；以大写字母丫开头，假如有多种单词，每个单词头字母大写

例如：IStudentlnfo

3.接口实现类命名：

命名规范：将实现的接口名称的首字母叩去掉，以"lmpl作为结尾”，假如有多种单词，每个

单词头字母大写。

例如：Studentlnfolmpl

3J2EE+SSH框架命名规范

1.servlet类命名：

命名规范：以Servlet单词结尾

例如：LoginServlet

2.POJO命名：

使用hibernate自动生成的类即可

3.DAO类命名：

使用hibernate自动生成日勺类即可

4.Action类命名：

命名规范：ActionH勺命名以POJO名称来制定，POJO名称Action

例如：

一种POJO名称为Diary,其对应R勺action为DiaryAction

5.ActionForm类命名：

命名规范：ActionForm日勺命名以POJO名称来制定，POJO名称Form

例如：

一种POJO名称为Diary,其对应H'、JactioForm为DiaryForm

6.业务逻辑接口命名：

命名规范：业务逻辑接口的命名以POJO名称来制定，IPOJO名称Service

例如：

一种POJO名称为Diary,其对应日勺业务逻辑接口为IDiar/Service

7.业务逻辑实现类命名：

命名规范：业务逻辑接口实现类的命名以POJO名称来制定

例如：

一种POJO名称为Diary,对应口勺业务逻辑接口实现类名为DiaryServicelmpI

4类变量命名：

命名规范：变量名首字母必须小写，假如该变量名有多种单词构成，背面”勺单词首字母大写,

单词与单词之间不要使用;”做连接，变量名访问控制必须为私有，可以对其增Ksetter与

getter措施。

例如：

privateintstudentAge;

publicintgetStudentAge(){

returnstudentAge;

)

publicvoidsetStudentAge(intstudentAge){

this.studentAge=studentAge;

5常量命名：

命名规范：所有字母大写，假如有多种单词构成，单词与单词之间以隔开。升且该变星

必须是公共、静态、final类型

例如：publicstaticfinalStringUSER_NAME="userName";

6措施命名

命名规范：首字母必须小写，假如该变量名有多种单词枸成，背面的I单词首字母大写，单词

与单词之间不要使用1'做连接。单词不要使用名词。

例如：publicintcheckLogin(Stringname,Stringpwd){}

7注释规范

注释规范是整个开发规范中最为重要的构成部分，必须严格执行。

1.类日勺注释：

作用：注释整个类，简朴概述该类作用。

书写规范：类日勺注释必须写在该类的申明语法之前。在注释中要描述该类的基本作用，作

者，日期，版本，企业名称，版权申明。

格式:

*类功能描述：（大体描述类的功能）

*@author：编写者名称

♦

*@version：类文献的版本号从1.0开始（自己确定版本号的增改

*状况），修改状况（修改时间、作者、改动状况）

♦

*@see包名.参照类名（列出父类，引入类，每个类占一行），假如有

*可省略

*有关数据如：（便于•理解本类日勺某些常显数据及某些数据的格式

*或认为比较重要的数据，假如没有可省略）

*/

2.类的申明语法

例如：

*<p>Title:管理员模块数据处理类</p>

♦<p>Description:两个数相加</p>

*<p>Copyright:Copyright(c)2023</p>

*<p>Company:华腾软件企业</p>

♦

*@author童金虎

*

*(Aversion$Revision:1.7$$Date:202乂)加8$

*/

publicclassAdminDAO

3.变量、常量注释：

作用：简朴描述该变量的意义。

书写规范：变量注释必须写在变量定义之前，简朴描述其代表的意义。

格式:

/**

*变量功能描述：（大体指述变量的功能）

*/

例如:

/**

*定义年龄变最

*/

publicintage;

4.措施注释:

作用：对该措施功能简朴描述，其参数、返回值意义H勺注解。

书写规范：措施注释必须写在措施定义之前。该注释包括：措施其功能的简朴描述，措施

的参数、返向值类型、返回值意义简朴的描述。

格式:

/**

*措施功能阐明

*@paramargs（参数类型可以写在参数后，也可以省

*略。每个参数占一行）

*@return输出参数（多种状况写在同一行）

*@see类#参照措施（与此措施有调用关系U勺措施供参

*考，不必每个措施都完整列出，要选择故意义欧I，每个

*措施占一行）

*（©exception异常处理类（措施中可以引起的I异常，每

*个异常占一行）

*/

例如:

/**

*修改管理员密码

*@paramadminld管理员编号

*@paramoldPassword旧密码

*@parampassword新密码

*@returnboolean与否编辑成功

*@throwsUserException

*@throwsServiceException

*/

publicbooleaneditAdminPassword(intadminld,StringoldPassword,

Stringpassword)throwsUserException,ServiceException;

5.Javadoc注释

Java除了可以采用我们常见口勺注释方式之外，Java语言规范还定义了一种特殊的注释，也就

是我们所说的Javadoc注释，它是用来记录我们代码中的API叽Javadoc注释是一种多行注

释，以/**开头，而以*/结束，注释可以包括某些HTML标识符和专门的关键词。使用Javadoc

注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。

例如：

/**

*Thisisanexampleof

*Javadoc

*

*@authordarchon

*(©version0.1,10/11/2023

*/

在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在

主程序中可认为每个类、接口、措施、字段添加Javadoc注群，每个注释的开头部分先用一

句话概括该类、接口、措施、字段所完毕的功能，这句话应单独占据一行以突出其概括作用，

在这句话背面可以跟随愈加详细U勺描述段落。在描述性段落之后还可以跟随某此以Javadoc

注释标签开头H勺特殊段落，例如上面例子中的@autherD@version,这些段落将在生成文档

中以特定方式显示。

8Jsp页面命名

命名规范：jsp页面名称要以小写字母开头，假如有多种单词构成，背面的单词以大写字母

开头。名称要体现出该页面的意义，最佳可以与模块名称联络在一起。

例如：

login.jsp--登录页面

register.jsp一注册页面

message.jsp一客户留言页面

9J2EE项目工程文献夹组织规范：

目依J：规范学员web应用程序的资源组织形式，形成良好的文献组织习惯。文献日勺组织形

式应当体现模块H勺划分。

根据eclipse工具的特性，项目的目录构造为：

src

—寄存java文献

WebRoot

I-images--寄存web程序所需的公共图片

l-css-寄存web程序所需的公共样式表

ITs-寄存web程序所需的公共js文献

|-commons-寄存web程序所需H勺公共文献

I--功能模块文献夹（寄存与某个功能模块有关H勺资源）

I-images--寄存与该功能模块有关H勺图片

|--css-寄存与该模块有关的样式表文献

|-js-寄存与该模块有关W、Jjs义献

l-jsp、html页面

I-WEB-INF

|-classes

|-lib

|-tld文献

10J2EE项目提交规范

项目完毕时要将项目作为一种产品交付顾客，良好的项E组织规范可以使顾客可以以便H勺找

寻项目中需要H勺资源，同步也是一种企业专业性的体现。项目提交时，要按照下列文献格式

进行提交。

1.项目主文献夹：

作用：寄存项目其他资源文献。

命名规范：时间—项目名字—版本号。

例如：131010」IAOAN_V1.0°

2.项H主文献夹下面包括如下文献夹和文献:

-src：保留.java文献。

-database：保留数据库的脚本文献或者数据库备份文献。

-source：保留eclipse工程中WebRoot目录下的所有文献。

-depend：保留编译该程序必须依赖的I其他jar文献。

--javadoc：保留所有类生成於Jjavadocapi文档。

-war：保留程序的归档文献

-xx.war：已经打包好的工程文献，可以直接运行。

-project：保留开发项目原工程代码及文献。

•一产品阐明书.doc：图文方式展现该产品使用措施。

-build.xml：ant脚本，用于生成运行U勺war文献。

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

11Java命名规范

1.包的命名

Java包的名字都是由小写单词构成。不过由于Java面向对象编程的特性，每一名Java程序

员都可以编写属于自己的Java包，为了保障每个Java包命名的唯一性，在最新日勺Java编程

规范中，规定程序员在自己定义的包的名称之前加上唯一的J前缀。由于互联网上的域名称是

不会反复的，因此程序员一般采用自己在互联网上口勺域名称作为自己程序包口勺唯一前缀。

例如：.

2.类的命名

类的名字必须由大写字母开头而单词中的其他字母均为小写；假如类名称由多种单词构成，

则每个单词日勺首字母均应为大写例如TestPage：假如类名称中包括单词缩写，则这个所写词

日勺每个字母均应大写，如：XMLExample,尚有一点命名技巧就是由丁类是设计用来代表对象

日勺，因此在命名类时应尽量选择名词。

例如：Circle

3.措施的命名

措施的名字日勺第一种单词应以小写字母作为开头，背面的单词则用大写字母开头。

例如：sendMessge

4.常量的命名

常量的名字应当都使用大写字母，并且指出该常量完整含义。假如一种常量名称由多种单词

构成，则应当用下划线来分割这些单词。

例如：MAX_VALUE

5.参数丛J命名

参数的命名规范和措施的命名规范相似，并且为了防止阅读程序时导致困惑，请在尽量保证

参数名称为一种单词的状况下使参数H勺命名尽量明确。

6.变量和常最命名

变量命名日勺措施采用驼峰标识命名法，参照上文O

在变量命名时要注意如下几点：

•选择故意义的名字，注意每个单词首字母要大写。

•在一段函数中不使用同一种变量体现前后意义不同样的两个数值。

・i、j、k等只作为小型循环的循环索引变量。

•防止用Flag来命名状态变量。

•用Is来命名逻辑变量，如：blnFilelsFoundo通过这种给布尔变量肯定形式的命名方式，

使得其他开发人员可以更为清晰日勺理解布尔变量所代表的意义。

•假如需要的话，在变量最终附加计算限定词，如：curSalesSum。

,命名不相包括,curSales和curSalesSum。

•StaticFinal变量的名字应当都大写，并且指出完整含义。

•假如需要对变量名进行缩写时，一定要注意整个代码中缩写规则的一致性。例如，假如

在代码的某些区域中使用ent,而在另某些区域中又使用count,就会给代码增长不必要日勺

复杂性。提议变量名中尽量不要出现缩写。

•通过在结尾处放置一种量词，就可创立愈加统一的变量，它们更轻易理解，也更轻易搜

索。例如，请使用和而不要使用和

customerFirs