JAVA开发工作规范

Java开发工作规范

目录

1文档介绍 (4)

1.1文档目的与背景 (4)

1.2文档范围 (4)

1.3参考文献 (4)

1.4术语与缩写解释 (4)

2命名及通用约定规范 (4)

2.1源文件结构规范 (4)

2.1.1Web项目主要目录结构 (4)

2.2J AV A包命名规范 (5)

2.2.1web层 (5)

2.2.2manager层 (6)

2.2.3dao层 (6)

2.2.4单元测试包 (7)

2.3J AV A类及接口命名规范 (7)

2.3.1web层 (7)

2.3.2manager层 (7)

2.3.3dao层 (8)

2.3.4单元测试类 (8)

2.4J AV A方法命名规范 (8)

2.4.1web层 (8)

2.4.2manager层 (9)

2.4.3dao层 (11)

2.4.4单元测试 (11)

2.5J AV A方法返回值规范 (11)

2.6J AV A变量命名规范 (12)

2.7J AV A常量命名规范 (12)

2.8URL映射注解规范 (12)

2.9JSP文件命名规范 (13)

2.9.1JSP文件夹 (13)

2.9.2JSP文件 (14)

3JAVA代码风格规范 (14)

3.1代码格式 (14)

3.2注释 (15)

3.2.1注释类型 (15)

3.2.2注释的格式 (17)

3.2.3注释的内容 (18)

3.3变量声明及初始化 (19)

3.3.1每行声明变量的数量 (19)

3.3.2初始化 (20)

3.4语句 (20)

3.4.1简单语句 (20)

3.4.2复合语句 (20)

3.4.3返回语句 (21)

3.4.4if，if-else，if else-if else语句 (21)

3.4.5for语句 (22)

3.4.6while语句 (22)

3.4.7do-while语句 (23)

3.4.8switch语句 (23)

3.4.9try-catch语句 (24)

3.5空白 (24)

3.5.1空行 (25)

3.5.2空格 (25)

4单元测试规范 (26)

1文档介绍

1.1文档目的与背景

规范对于程序员而言尤为重要，有以下几个原因：

一个软件的生命周期中，80%的花费在于维护

几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护

规范可以改善软件的可读性，可以让程序员尽快而彻底地理解新的设计和代码

如果你将源码作为产品发布，就需要确任它是否被很好的打包并且清晰无误，一如你已构建的其它任何产品。

为了执行规范，每个软件开发人员必须一致遵守编码规范

1.2文档范围

Java开发人员。

1.3参考文献

《java编码规范》

《Effective Java》

1.4术语与缩写解释

2命名及通用约定规范

2.1源文件结构规范

2.1.1Web项目主要目录结构

主要目录分为：src,test,dist,resources,war;其中src按功能分为3层，分别为web、manager、

dao.

2.2Java包命名规范

Java包命名的规则:.taiji+项目简写名+分层(web或manager或dao)+模块简写名。

2.2.1web层

web层命名的规则:.taiji+项目简写名+web+模块简写名。

示例(广告系统-web层-编校处理模块)：

示例(广告系统-web层-过滤器模块)：

2.2.2manager层

manager层命名的规则如下：

1.如果是业务逻辑，使用.taiji+项目简写名+manager+模块简写名

示例(广告系统-manager层业务逻辑-编校处理模块)

2.如果是模型类的包，使用.taiji+项目简写名+model+模块简写名

示例(广告系统-manager层模型类-编校处理模块

2.2.3dao层

dao层命名的规则如下：

1.如果是实体类的包，使用.taiji+项目简写名+entity

示例(广告系统-dao层实体类包)

注意：如果实体类太多，也可以使用在entity后加模块名的方式来进行分包。

2.如果是dao接口的包，使用.taiji+项目简写名+dao

示例(广告系统-dao接口包)

3.如果是dao的实现包，根据实现方式来区分

示例1：广告系统-dao-hibernate实现

示例2：民航-dao-xstream实现

2.2.4单元测试包

在源码包前面增加tests包名。

示例：广告系统-manager层有源码包

对应的测试包则为：

2.3Java类及接口命名规范

JAV A类、接口名称以英文单词组成，每个单词的第一个字母都大写，其他字母小写。

2.3.1web层

web层命名的规则:操作对象名词+Controller。

示例(部门管理)：

示例(栏目管理)：

2.3.2manager层

manager层命名的规则如下：

业务逻辑接口，使用操作对象名词+Manager;业务逻辑实现类，使用操作对象名词+ManagerImpl

示例(广告系统-manager层业务逻辑-部门管理业务逻辑接口及实现类)

模型类，使用操作对象名词+Model

示例(广告系统-manager层模型类-部门查询模型类)