软件开发规范v

开发规范文档版本 <1.0>

修订历史记录

目录

1. 前言5

1.1 目的5

1.2 概述5

2. 命名规范(Naming Conventions) 5

2.1 包命名6

2.2 类命名6

2.3 接口命名6

2.4 方法命名6

2.5 类成员参数7

2.6 局部变量7

2.7 常量7

2.8 集合7

2.9 魔法数字7

2.10 其他8

2.11 项目分层8

3. 代码排版规范9

3.1 空行9

3.2 空格9

3.3 大括号(Braces) 10

3.4 换行(New Lines) 10

3.5 长度(Length) 10

4. 声明10

4.1 类、接口10

4.2 方法10

4.3 字段11

5. 其他约束11

5.1 类成员可见性11

5.2 赋值(Assignment) 11

5.3 12

5.4 条件表达式使用12

5.5 无效语句12

5.6 Import 规范12

5.7 String比较13

5.8 注释要求13

5.9 Try if嵌套层次和分支复杂度14

5.10 Switch 语句14

6. 设计规范15

6.1 类与接口15

6.2 方法15

6.3 表达式与语句16

6.4 控制语句16

6.5 循环语句17

6.6 异常处理18

软件开发规范文档

1.前言

1.1目的

本规范的目的是使本组织能以标准的、规范的方式设计和编码。通过建立编码规范，以使每个开发人员养成良好的编码风格和习惯；并以此形成开发小组编码约定，提高程序的可靠性、可读性、可修改性、可维护性和一致性等，增进团队间的交流，并保证软件产品的质量。

1.2概述

对于代码，首要要求是它必须正确，能够按照设计预定功能去运行；第二是要求代码必须清晰易懂，使自己和其他的程序员能够很容易地理解代码所执行的功能等。然而，在实际开发中，每个程序员所写的代码却经常自成一套，很少统一，导致理解困难，影响团队的开发效率及系统的质量等。因此，一份完整并被严格执行的开发规范是非常必须的，特别是对软件公司的开发团队而言。

最根本的原则：

代码虽然是给机器运行的，但却是给人读的！

2.命名规范(Naming Conventions)

命名规范使程序更易读，从而更易于理解。它们也可以提供一些有关标识符功能的信息，以助于理解代码，例如，不论它是一个常量，包，还是类。大家遵守一定的规范，相互看其他人的代码也会更加方便。

?使用可以准确说明变量/字段/类/接口/包等的完整的英文描述符。例如，采用类似firstName，listAllUsers 或CorporateCustomer 这样的名字，尽量不使用汉语拼音及不相关单词命名，严禁使用汉语拼音首字母组合命名，虽然Java 支持

Unicode

命名，但本规范规定对包、类、接口、方法、变量、字段等不得使用汉字等进行

命名。

?采用该领域的术语。如果用户称他们的“客户” (clients) 为“顾客”(customers)，那么就采用术语Customer 来命名这个类，而不用Client。

?采用大小写混合，提高名字的可读性。一般应该采用小写字母，但是类和接口的名字的首字母，以及任何中间单词的首字母应该大写。包名全部小写。

?避免使用长名字（最好不超过25 个字母）。

?避免使用相似或者仅在大小写上有区别的名字。

?避免使用数字，但可用2 代替to，用4 代替for 等，如：go2Jsp。

2.1包命名

包名一般以项目或模块名命名，少用缩写和长名，一律小写，正则表达式为：

^[a-z]+(\.[a-zA-Z_][a-zA-Z0-9_]*)*$。

包名按如下规则组成：[基本包].[项目名].[模块名].[子模块名]..

OA项目的包命名前三级为：com.well.oa。

不得将类直接定义在基本包下，所有项目中的类、接口等都当定义在各自的项目和模块包中。

2.2类命名

类名采用大小写混合的方式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词，避免缩写词(除非该缩写词被更广泛使用，像URL，HTML)。一般采用名词。

2.3接口命名

大小写规则与类名相似。接口可带I 前缀或able、ible、er 等后缀。

2.4方法命名

方法名是一个动名结构，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。正则表达式为：^[a-z][a-zA-Z0-9]*$

类中常用方法的命名：

1.类的获取方法（一般具有返回值）一般要求在被访问的字段名前加上get，如

getFirstName()，getLastName()。

2.类的设置方法（一般返回类型为void）：被访问字段名的前面加上前缀 set，如

setFirstName(),setLastName().

3.类的布尔型的判断方法一般要求方法名使用单词 is 做前缀，如

isPersistent()isString()。或者使用具有逻辑意义的单词，例如equal 或equals。

4.类的普通方法一般采用完整的英文描述说明成员方法功能，第一个单词尽可能采用动词，

首字母小写，如openFile（），addCount（）。

5.构造方法应该用递增的方式写。（参数多的写在后面）。

6.toString()方法：一般情况下，每个类都应该定义toString(),其格式为：

public String toString(){…}。

2.5类成员参数

和类命名一样，但是首字母小写。参数命名和类成员命名一致。

'^[a-z][a-zA-Z0-9]*$'

2.6局部变量

局部变量名不应以下划线或美元符号开头，这个是java命名的惯例。局部变量建议全部使用小写。除了局部变量名外，所有实例，包括类，类常量，均采用大小写混合的方式。

变量名应简短且富于描述。变量名的选用应该易于记忆，即，能够指出其用途。尽量避免单个字符的变量名，除非是一次性的临时变量（往往用在for循环中），临时变量通常被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。正则表达式为：^[a-z][a-z0-9]*$

2.7常量

类常量和ANSI常量(static , final 字段)的声明，应该全部大写，单词间用下划线隔开。(尽量避免ANSI常量，容易引起错误)。正则表达式为：

^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$

2.8集合

集合，例如数组和列表，命名应采用完整的英文描述符，适当使用集合缩写后缀。如：List productList = new List(); //产品列表

Array userArray = new Array(); //用户列表

2.9魔法数字

不允许使用魔法数字，可以定义为常量使用。

在程序里经常会用到一些量，它是有特定的含义的。例如，现在我们写一个薪金统计程序，公司员工有50 人，我们在程序里就会用50 这个数去进行各种各样的运算。在这里，50 就是"神秘的数"。当别的程序员在程序里看到50 这个数，将很难知道它的含义，造成理解上的困难。

在程序里出现"神秘的数"会降低程序的可读性、可维护性和可扩展性，故规定不得出现此类"魔法数字"。避免的方法是把神秘的数定义为一个常量。注意这个常量的命名应该能表达该数的意义，并且应该全部大写，以与对应于变量的标识符区别开来。例如上面50 这个数，我们可以定义为一个名为NUM_OF_EMPLOYEES 的常量来代替。这样，别的程序员在读程序的时候就可以容易理解了。

2.10其他

命名时应使用复数来表示它们代表多值（数组）。如：orderItems。

2.11项目分层

1、实体类

实体类使用规范

1、表名以所在模块的简写为前缀；

2、实休类只作为一个JavaBean对象

3、类的字段不可使用int、short、long、char、double、float、boolean和byte等基本数据类型，要使用基本数据类型对应的包装类Integer、Short、Long、Character、Double、Float、Boolean和Byte等可用工具类

com.wellsoft.pt.utils.bean.PrimitiveTypeWrapperUtils对其属性赋初始值

2、DAO数据访问

DAO层实现类命名规范

以Dao结束，如UserDao

3、Service服务

Service服务层接口命名规范

以Service结束，如UserService

实现类命名规范

以ServiceImpl结束，如UserServiceImpl

4、Web控制器

web层控件器命名规范

以Controller结束，如UserController

5、JSP页面展示

jsp文件命名规范

统一使用小写字母，若有多个单词用下划线"_"分开，一般以动词结束，如

user_list.jsp 列表

user_view.jsp 查看

user_edit.jsp 编辑

user_maintain.jsp 维护

user_new.jsp 新增

6、值对象

数据从页面收集到后台控制器的值对象命名规范

1、值对象以Bean为结尾，如UserBean，收集后再用工具类

com.wellsoft.pt.utils.bean.BeanUtils转换为实体类User

2、直接使用实体类如User作为值对象收集页面数据

3.代码排版规范

排版主要为了界面规范，一方面为了代码清晰，另外可以方便进行代码合并时减少因排版引起不一致。在eclipse中可以使用固定排版模板，完成一致的排版样式。所有项目

开发人员必须引入统一的排版模板。

主要包括缩进，空格，空行，大括号，换行，长度等方面。

3.1空行

空行往往使用在如下方面。

1)包的声明之后

2)Import声明之前和之后

3)Import组之间

4)类声明之间

5)类成员变量和方法声明之前

6)在同一类型声明之前

7)对于已存在的空行会整理成一行

对于特别需要分开的行也可以添加空行，往往是为了逻辑划分。

3.2空格

1)逗号后面一律加空格

2)类和匿名类的左大括号之前加空格

3)方法和构造函数的左大括号之前加空格

4)可变个数的参数的冒号后面加空格

void format(String s, Object... args) {

}

5)标识符（label）后面的冒号后要加空格,目前不推荐使用标识符:

6)注释类型@前面和左大括号之前加空格。

3.3大括号(Braces)

1)左大括号一律与它所从属的类,接口和关键字处于同一行

2)左大括号一律与它所从属的方法和构造函数处于同一行

3)左大括号一律与它所从属的枚举声明和枚举常量处于同一行

4)左大括号一律与它所从属的注释类型声明处于同一行

5)数组初始化中左大括号一律与声明处于同一行:

6）所有区域都要使用大括号，例如 if语句中只有一条语句也要用大括号括起来。

3.4换行(New Lines)

1)局域变量(local variables)和成员不与其注释在同一行，不许使用与代码同行的

注释，注释往往放在其注释内容上。

2)一行最长为120个字符。

3)同一行不能有多个声明，声明放置到新行中

3.5长度(Length)

1)文件长度不超过1000行，建议。

2)方法长度不超过200行，建议。

4.声明

声明的基本原则是遵守Java 语言规范，并遵从习惯用法。

4.1类、接口

声明定义：

[可见性][('abstract'|'final')] [Class|Interface] class_name

[('extends'|'implements')][父类或接口名]

如：public class LoginAction extends BaseAction implemnets ActionListener 方法

良好的程序设计应该尽可能减小类与类之间耦合，所遵循的经验法则是：尽量限制成

员函数的可见性。如果成员函数没必要公有

(public)，就定义为保护(protected)；没必要保护。

4.2方法

声明定义：

[可见性][('abstract'|'final')] ['synchronized'][返回值类型] method_name(参数

列表)[('throws')][异常列表]

如：public List listAllUsers() throws DAOException

若有toString(),equals(),hashCode(),colone()等重载自Object 的方法，应将其放在类的最后。

声明顺序：构造方法，静态公共方法，公共方法，静态私有方法，受保护方法，私有方法，继承自Object 的方法

4.3字段

字段定义语法规范：

[(‘public’|’private’|’protected’)]

[(‘final’|’volatile’)][‘static’][‘transient’]

data_type field_name [ ‘=’ expression] ‘;’

若没有足够理由，不要把实例或类变量声明为公有。公共和保护的可见性应当尽量避免，所有的字段都建议置为私有，由获取和设置成员函数（Getter、Setter）访问。不允许“隐藏”字段，即给局部变量所取的名字，不可与另一个更大范围内定义的字段的名字相同（或相似）。例如，如果把一个字段叫做firstName ，就不要再生成一个局部变量叫做firstName，或者任何易混肴的名字，如fistName。

数组声明时当将"[]"跟在类型后，而不是字段名后，如：

Integer[] ai = new Integer[2]; //一个整数对象数组，用于...

Integer aj[] = new Integer[3]; //不要用这种数组声明方式

一行代码只声明一个变量，仅将一个变量用于一件事。

声明顺序：常量，类成员变量，实例变量，公有字段，受保护字段，私有字段。

5.其他约束

5.1类成员可见性

说明：检查类成员的可见性。只有static final 成员是public的，其他的类成员都是private的.

5.2赋值(Assignment)

1 不允许内部赋值,如:

String s = Integer.toString(i = 2);

2 不允许更改的循环控制变量

比如，一个for循环的循环数是只应该在最后的 i++ 中更改的，如果出现以下代码：

for (int i = 0; i < 1; i++) {

i++; // 这里是极可能是程序员大意写出来的。

}

3 参数赋值

对方法的参数赋值一般说来，是不好的编程技巧。而强制开发人员声明一个final

参数，也不够友好。

public void test1(int a){

a =1;//checkstyle报检查错误

}

5.3

函数的参数个数不超过5个，若需要传递多个参数时，当使用一个容纳这些参数的对象进行传递，以提高程序的可读性和可扩展性，还可以考虑使用动态参数。

5.4条件表达式使用

1 简化的条件表达式，检查过度复杂的条件表达式，比如： (b == true), b || true, !false, 难读且容易出错。这里最好简化使用。

5.5无效语句

说明：检查无效语句（单独';'语句）.

public void test4(){

if(true);//if语句后的';'号引起checkstyle检查错误

doConditionalStuff();

doUnconditionalStuff();

}

5.6Import 规范

避免引用未使用的import检查.