代码检查规则介绍

1. 命名规范Type类型命名规范AbstractClassName 抽象类Abstract.*$|.*Factory$ConstantName 常量(static , final 字段)A-ZA-Z0-9*(_A-Z0-9+)*$LocalFinalVariableName 局部的final变量，包括catch中的参数a-za-zA-Z0-9*$LocalVariableName 局部的非final型的变量，包括catch中的参数a-za-zA-Z0-9*$MemberName 非static型变量a-za-zA-Z0-9*$MethodName 方法名a-za-zA-Z0-9*$PackageName package名a-z+(.a-za-z0-9*)*$ParameterName 方法中的参数名a-za-zA-Z0-9*$StaticVariableName 仅仅是static型的变量（不包括static final型）a-za-zA-Z0-9*$TypeName 类型(Class或Interface)名A-Za-zA-Z0-9*$2. JavaDoc注释类和接口的JavaDoc 方法的JavaDoc变量的JavaDoc3. 长度限制 文件长度：Java文件的行数不能超过某个值，默认值是1500每行长度：每行的字母个数不能超过某个值，默认值是120方法长度：方法的行数不能超过某个值，默认值是150方法的参数个数：方法参数的个数不能超过某个值，默认值是7return 语句的数量：方法中return语句的个数不能超过某个值，默认值是24. 重复的代码检查内容重复的代码：当相同代码的行数超过某个值时，就认为是重复的代码，默认值是155. 多余的不必要的括号不必要的圆括号：检查不必要的圆括号”(,)”。 例如：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)，而不是s.equals(“hello”)使用equals()比较对象的引用，而不要使用=或!= 10. switch为switch语句提供default标签switch语句的default应该放在最后检查case中是否有 break，return ，throw 或 continue语句，确保每次switch只执行一个分支11. Exception限制 try-catch 的嵌套层次，默认值是3不允许throws某些异常，例如：java.lang.Exception、java.lang.Error、java.lang.RuntimeException和your.package.Exception等从catch语句中抛出一个新的异常时，没有把原来的异常传入新异常中，会导致异常跟踪信息的丢失(把异常作为参数传入自定义的异常处理类)在当前catch语句中, 处理被捕获的异常（记录异常；抛出新的异常；处理异常）, （项目组：不管有没有进行处理，一定要再次throw出去，重点是指调用平台的异常，不要自己吞下去，以方便平台组用来解决问题）不要捕获NullPointerException，因为捕获了之后会把这个异常屏蔽，可能会引起后续抛出很难分辨的异常开发人员不要抛出NullPointerException，因为大家通常会认为这个异常是JVM抛出的，考虑用IllegalArgumentException代替，这样会更清晰，更像是开发人员发起的异常不要从finally语句返回值1. 对Java的异常类的使用：l 不允许使用RuntimeException等无法通过类名反应出异常产生原因的异常类l 其它如IllegalArgumentException、ClassCastException等能反应出异常原因的异常类也建议再封装成模块自定义的异常类2. 异常类体系每个模块的异常基类继承自下面两个类Checked Exception: mons.exception.SoTowerExceptionRuntime Exception: org.sotower. commons.exception.SoTowerRuntimeException3. 合理使用Checked Exception和Runtime Exception：l 如果提供的api能通过捕获的异常处理保证系统的正常运转，建议抛出Checked Exceptionl 大部分情况都是使用Runtime Exception4. 对外发布为Runtime Exception不能修改为Checked Exception，可能造成用户已有代码出错5. BSP、BPM对外提供的接口必须使用try、catch、throw方式进行日志记录后再转抛，其它核心代码的catch块中建议尽量加入日志记录（如控制器部分），日志使用apache commons loggingimport mons.logging.Log;import mons.logging.LogFactory;private static final Log log = LogFactory.getLog(Xxxxx.class);log.error(详细的异常信息描述。, ex);/ 不建议使用的2种方式/ log.error(详细的异常信息描述。);/ log.error(ex);6. 捕获的异常在保证系统能继续正常执行逻辑的前提下，应进行处理，而不要继续throw7. 对捕获的异常（catch代码块中）：l 如果没有继续throw异常，需加上注释说明不继续throw的原因，同时通过log.warn(处理的异常信息描述。, ex)的方式记录l 如果继续throw异常，建议转为平台的异常类8. 异常信息描述得足够详尽，描述异常信息时：l 应包含各种有用信息，如方法传入的参数、关键的类属性、对象属性和临时变量等能取到的对于分析异常有用信息，包装到异常信息描述中l 应清晰易懂，用户能根据异常的描述信息进行排错处理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. 将e.printStackTrace()或System.out.println(e.getMessage()等直接输出到控制台方式的代码替换为日志输出的方式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对象禁止采用+或+=拼接字符串，调用StringBuffer.append()代替15. 接口设计不要仅仅为了定义常量而定义一个接口或抽象类方法的返回类型尽量使用接口而不要使用实现类16. SQL在使用Connection, Statement, and ResultSet等资源之后要关闭不要在for循环中执行数据库操作17. 日志在日志中记录栈跟踪信息时，要确保全部的栈跟踪信息被输出考虑用logger代替System.(out|err).print考虑用logger代替printStackTrace()18. 赋值尽量不要进行内部赋值操作，例如：String s = Integer.toString(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;1