2023年11月29日发(作者：)
1. 命名规范
Type 类型 命名规范
AbstractClassName 抽象类 ^Abstract.*$|^.*Factory$
ConstantName 常量(static , final 字段) ^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$
LocalFinalVariableName 局部的final变量，包括catch中的参数 ^[a-z][a-zA-Z0-9]*$
局部的非final型的变量，包括catch中
LocalVariableName ^[a-z][a-zA-Z0-9]*$
的参数
MemberName 非static型变量 ^[a-z][a-zA-Z0-9]*$
MethodName 方法名 ^[a-z][a-zA-Z0-9]*$
PackageName package名 ^[a-z]+(.[a-z][a-z0-9]*)*$
ParameterName 方法中的参数名 ^[a-z][a-zA-Z0-9]*$
仅仅是static型的变量（不包括static
StaticVariableName ^[a-z][a-zA-Z0-9]*$
final型）
TypeName 类型(Class或Interface)名 ^[A-Z][a-zA-Z0-9]*$
2. JavaDoc注释
类和接口的JavaDoc
方法的JavaDoc
变量的JavaDoc
3. 长度限制
文件长度：Java文件的行数不能超过某个值，默认值是1500
每行长度：每行的字母个数不能超过某个值，默认值是120
方法长度：方法的行数不能超过某个值，默认值是150
方法的参数个数：方法参数的个数不能超过某个值，默认值是7
return 语句的数量：方法中return语句的个数不能超过某个值，默认值是2
4. 重复的代码
检查内容重复的代码：当相同代码的行数超过某个值时，就认为是重复的代码，默认值是15
5. 多余的
不必要的括号{}
不必要的圆括号：检查不必要的圆括号”(,)”。 例如：if(((((true)))))
6. 未简化的
未被简化的条件表达式：检查过度复杂的条件表达式，例如： (b == true)， b || true，!false
未被简化的布尔返回值：检查未被简化的boolean返回语句，例如：
if (valid())
return false;
else
return true
可以简化成：
return !valid();
7. 空白区域(empty block)
检查{}包含起来的区域是否为空
8. 空语句(empty statement)
检查是否有空的语句 ;
9. 比较
equals和hashCode方法：检查一个类是否同时重写了equals和hashCode方法
子类在重写hashCode()方法时，要调用父类的hashCode()
在实现equals()方法时要使用instanceof操作符
要把常量放在equals()方法的左边，例如：“hello”.equals(s)，而不是(“hello”)
使用equals()比较对象的引用，而不要使用==或!=
10. switch
为switch语句提供default标签
switch语句的default应该放在最后
检查case中是否有 break，return ，throw 或 continue语句，确保每次switch只执行一个分支
11. Exception
限制 try-catch 的嵌套层次，默认值是3
不允许throws某些异常，例如：ion、、eException和ion
等
从catch语句中抛出一个新的异常时，没有把原来的异常传入新异常中，会导致异常跟踪信息的丢失(把异常作为参
数传入自定义的异常处理类)
在当前catch语句中, 处理被捕获的异常（记录异常；抛出新的异常；处理异常）, （项目组：不管有没有进行处理，
一定要再次throw出去，重点是指调用平台的异常，不要自己吞下去，以方便平台组用来解决问题）
不要捕获NullPointerException，因为捕获了之后会把这个异常屏蔽，可能会引起后续抛出很难分辨的异常
开发人员不要抛出NullPointerException，因为大家通常会认为这个异常是JVM抛出的，考虑用
IllegalArgumentException代替，这样会更清晰，更像是开发人员发起的异常
不要从finally语句返回值
1. 对Java的异常类的使用：
不允许使用等无法通过类名反应出异常产生原因的异常类
RuntimeException
其它如IllegalArgumentException、ClassCastException等能反应出异常原因的异常类也建议再
封装成模块自定义的异常类
2. 异常类体系
每个模块的异常基类继承自下面两个类
Checked Exception: rException
Runtime Exception: r. rRuntimeException
SoTowerExceptionSoTowerRuntimeException
BspBaseExceptionBpmBaseExceptionBspBaseRuntimeException
BpmBaseRuntimeException
SoTIBaseExceptionSoTIBaseRuntimeException
XxxxException
XxxxRuntimeException
3. 合理使用Checked Exception和Runtime Exception：
如果提供的api能通过捕获的异常处理保证系统的正常运转，建议抛出Checked Exception
大部分情况都是使用Runtime Exception
4. 对外发布为Runtime Exception不能修改为Checked Exception，可能造成用户已有代码出错
5. BSP、BPM对外提供的接口必须使用try、catch、throw方式进行日志记录后再转抛，其它核心代码的catch
块中建议尽量加入日志记录（如控制器部分），日志使用apache commons logging
import ;
import tory;
private static final Log log = LogFactory.getLog(Xxxxx.class);
log.error("详细的异常信息描述。", ex);
// 不建议使用的2种方式
// ("详细的异常信息描述。");
// (ex);
6. 捕获的异常在保证系统能继续正常执行逻辑的前提下，应进行处理，而不要继续throw
7. 对捕获的异常（catch代码块中）：
如果没有继续throw异常，需加上注释说明不继续throw的原因，同时通过
("处理的异常信息
描述。", ex)
的方式记录
如果继续throw异常，建议转为平台的异常类
8. 异常信息描述得足够详尽，描述异常信息时：
应包含各种有用信息，如方法传入的参数、关键的类属性、对象属性和临时变量等能取到的对于分析异常有
用信息，包装到异常信息描述中
应清晰易懂，用户能根据异常的描述信息进行排错处理
public void test(String arg1, String arg2) {
try {
System.out.println(arg1 + arg2);
} catch (Exception ex) {
// 拼接内容较多时，使用StringBuilder或StringBuffer
// 异常信息应足够详尽，如果有关键的对象属性，也应加入到信息描述中
String exMsg = "进行打印输出操作时出错。出错时的方法参数为[" + arg1 + "," + arg2 + "]。";
// BSP和BPM对外的接口以及平台其它核心部分需进行日志记录
log.error(exMsg, ex);
// 将原始异常包装为平台的异常再抛出，两个参数
throw new BspTestRuntimeException(exMsg, ex);
}
}
9. 将tackTrace()或n(sage())等直接输出到控制台方式的代码
替换为日志输出的方式
10. 程序的处理逻辑尽量不依赖于异常，异常的性能不好
11. 每个模块（BSP、BPM、SoTI）有自己的异常基类，子异常类继承自各自模块的基类
12. 定义的异常类名应清晰直观，如UserNotFoundException、InvalidPerformerException等
12. if-else
限定if-else的嵌套层数，默认值是1，最佳值是2
把if-else和循环语句放在括号中
13. 循环
限定for循环的嵌套层数，最佳值是2
不要在for循环体中给控制循环的变量赋值
不要在循环中创建新的对象
14. String
检查内容相同的字符串：确保一个文件中内容相同的字符串不会多次重复出现，建议使用常量来代替多次重复出现
的字符串，默认只允许出现1次
不要使用String对象
禁止采用+或+=拼接字符串，调用()代替
15. 接口设计
不要仅仅为了定义常量而定义一个接口或抽象类
方法的返回类型尽量使用接口而不要使用实现类
16. SQL
在使用Connection, Statement, and ResultSet等资源之后要关闭
不要在for循环中执行数据库操作
17. 日志
在日志中记录栈跟踪信息时，要确保全部的栈跟踪信息被输出
考虑用logger代替System.(out|err).print
考虑用logger代替printStackTrace()
18. 赋值
尽量不要进行内部赋值操作，例如：String s = ng(i = 2);
代码中不要出现魔法数，例如：fileType = 0;其中0表示的到底是什么类型，让人无法看懂。建议先用常量定义类型
public static final int TEXT_FILE_TYPE = 0;
public static final int DOC_FILE_TYPE = 1;
public static final int XSL_FILE_TYPE = 2;
然后再给fileType赋值 fileType= TEXT_FILE_TYPE;
19. 数组与集合
不要用null代替空数组返回，创建一个空的数组返回
不要用null代替枚举类型返回，创建一个空的枚举对象返回
不要用null代替集合返回，创建一个空的集合对象返回
20. 可移植性
在创建时，不要硬编码文件分隔符
不要使用硬编码n 和r作为换行符
在应用中硬编码IP会使应用不能部署到其他环境
21. 其他
禁止使用的表达式，例如；禁止在代码中使用"n"
检查项目中多余的没有被调用的方法
发布评论