Java项目代码编码规范

项目代码编写规范

代码编写规范目的：能够在编码过程中实现规范化，为以后的程序开发中养成良好的行为习惯。

• 包命名规范

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

自定义标签类所在包命名规范：com.项目名称(小写).tags

例如：com.xxxxx.web.tags

过滤器类所在包命名规范：com.项目名称(小写).web.filter

例如：com.xxxxx.web.filter

Action类所在包命名规范：com.项目名称(小写).web.action

例如：com.xxxxx.web.action

Controller类所在包命名规范：com.项目名称(小写).controller

例如：com.xxxxx.controller

Javabean所在包命名规范：com.项目名称(小写).entity

例如：com.xxxxx.entity

DAO类所在包命名规范：com.项目名称(小写).dao.impl

例如：com.xxxxx.dao.impl

DAO类所实现的接口在包中命名规范：com.项目名称(小写).dao

例如：com.xxxxx.dao

业务逻辑实现接口命名规范：com.项目名称(小写).service.impl

例如：com.xxxxx.service.impl

业务逻辑实现接口命名规范：com.项目名称(小写).service

例如：com.xxxxx.service

全局工具类所在包命名规范：com.项目名称(小写).util

例如：com.xxxxx.util

• 类命名规范

1.基本命名规范

类

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

例如：StudentInfo

接口命名

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

例如：IStudentInfo

接口实现类命名

命名规范：将实现的接口名称的首字母"I"去掉，以"Impl作为结尾"，如果有多个单词，每个单词头字母大写。

例如：StudentInfoImpl

J2EE+SSM框架命名规范

Mapper.xml命名

命名规范：Mapper.xml的命名以POJO名称来制定，POJO名称Mapper.xml

例如：

一个POJO名称为Diary，其对应的Mapper.xml为DiaryMapper.xml

Controller类命名

命名规范：Controller的命名以POJO名称来制定，POJO名称Controller

例如：

一个POJO名称为Diary，其对应的action为DiaryController

业务逻辑接口命名

命名规范：业务逻辑接口的命名以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）{...}

2.注释规范

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

类的注释

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

书写规范：类的注释必须写在该类的声明语法之前。在注释中要描述该类的基本作用，作者，日期，版本，com，版权声明

格式：

/* *

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

* @author：编写者名称

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

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

*/

类的声明语法

例如：

/**

* Title:管理员模块数据处理类

* Description: 两个数相加

* Copyright: Copyright (c) 2007

* Company:XX软件公司

* @author XXX

* @version $Revision: 1.7 $ $Date: 2016/03/01

*/

public class AdminDAO

变量、常量注释

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

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

格式：

/**

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

*/

例如：

/**

*定义年龄变量

*/

public int age;

方法注释

作用：对该方法功能简单描述，其参数、返回值意义的注解。

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

格式：

/**

   * 方法功能说明

   * @param args (参数类型可以写在参数后，也可以省略。每个参数占一行)

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

*/

例如：

/**

* 修改管理员密码

    * @param adminId 管理员编号

* @param oldPassword 旧密码

* @param password 新密码

* @return boolean 是否编辑成功

*/

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文件

|--WEB-INF

|--jsp、html页面

|--classes

|--lib

|--tld文件