java基本规范

1 格式与命名规范

1.1 缩进

缩进应该是每行2个空格。 不要在源文件中保存Tab字符， 在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。

1.2 换行

l
每行代码最长统一设置成120个字符。（可以通过开发工具进行长度限制。如图1，Myelipse8.5设置方法）

（图1）
l
If(),for(),while()，try(),catch(),finally()等关键字建议都需要单独占用一行。

1.3 命名规则

l 包名：采用完整的英文描述符，应该都是由小写字母组成。对于全局包，将你的 Internet
域名反转并接上包名。如：com.jinmajia.www.domain

l 类名：采用完整的英文描述符，所有单词的第一个字母大写。如：public class LoginIn{}.

l 接口：采用完整的英文描述符说明接口封装，所有单词的第一个字母大写。

l 变量名：字段采用完整的英文描述，第一个字母小写，任何中间单词的首字母大写。如：int countPeople；

l 方法名：英文首字母小写，其余单词首字母大些，并按功能取名。如：int void findUserById（）。

l JSP文件命名：采用完整的英文描述说明JSP所完成的功能，尽可能包括一个生动的动词，第一个字母小写，如：viewMessage.jsp。

l 获取成员方法名：被访问字段名的前面加上前缀 get。如：getFirstName()。布尔型的获取成员函数，所有的布尔型获取函数用单词is
做前缀。 isPersistent()。

l 常量名：静态常量字段全部采用大写字母，单词之间用下划线分隔。。如：public
static final Int ALL_NUMBER = 1。

l 数据库表名：英文小写，多个单词用下划线分开，并按功能取名。如：user_order表。

l 循环计数器变量：建议采用字母 i，j，k
或者 counter。

2注释规范

2.1 注释要求

l 注释应该增加代码的清晰度

l 保持注释的简洁

l 在写代码之前写注释

l 注释出为什么做了一些事，而不仅仅是做了什么

2.2类文件开头注释

该注释可以自动生成，如下为MyEclipse的统一设置

/**
* fileName:${file_name}
* description:这里添加类描述
* author:cuiyaonan email:cuiyaonan2000@163.com
* createDate:${date}
*/

2.3 方法头注释

该注释可以自动生成，如下为MyEclipse的统一设置

/**
* description:
这里添加方法功能描述
* author:cuiyaonan email:cuiyaonan2000@163.com
* createDate:${date}
*/

2.4失效代码注释

由/*...*/界定，标准的C-Style的注释。专用于注释已失效的代码。(非/** */注释)

/*
* int a = 1;
* System.out.println(a);
*/

2.5代码内部注释

//：在成员函数内采用单行注释，来说明业务逻辑、代码段和暂时变量的声明。注释符"//"后必须紧跟一个空格，然后才是注释信息。

3编程规范

3.1基本规范

l
隐藏工具类的构造器，确保只有static方法和变量的类不能被构造
l
变量定义尽量基于接口而不是具体实现类，如Map map = new HashMap()

l
代码中不能使用System.out.println()，e.printStackTrace()，必须使用logger打印信息。或者其他的异常处理机制。
l
左括号和后一个字符之间不应该出现空格；同样，右括号和前一个字符之间也不应该出现空格。
l
在处理 String
的时候要尽量使用 StringBuffer
类。
l
避免使用索引来调用数据库中间层组件返回的结果集。

3.2 异常处理

l
重新抛出的异常必须保留原来的异常，即throw new NewException("message",e);
而不能写成throw new NewException("message")。
l
在异常被捕获且没有重新抛出的地方须写日志或录入数据库。

l
框架尽量捕获低级异常，并封装成高级异常重新抛出，隐藏低级异常的细节。

3.3 代码度量

3.3.1方法度量

l
方法（构造器）参数在7个以内。（可以放入集合传递，推荐用Map key表示功能
value代表值）
l
方法长度150行以内（方法如过长可以拆分成不同功能的方法）
l
方法能够抽离出来作为工具的尽量抽离出来
l
方法内建议不要使用递归算法。

3.3.3 其他度量

l
布尔表达式中的布尔运算符(&&,||)的个数不超过3个
l
if语句的嵌套层数3层以内
l
类文件长度2000行以内（如类文件长度超过2000行，建议拆分成不同的类，类似拆分方法）
l
匿名内部类建议20行以内

4开发环境统一

同一个项目建议统一如下内容：

l 开发工具版本，如Myeclipse8.5

l
Web服务器版本,如：Tomcat6.5

l 测试数据库版本

l
JDK版本，如JDK6。以及其他jar包版本。

l 编码格式（utf-8）。包括tomact，Myeclipse，数据，视图展现层（如jsp）