代码走查规范1766.doc

综合征管信息系统 代码走查规范 文档编号： 当前版本： 1.0 修改日期： 2010年8月18日  一、 JAVA编程规范 3 1、 变量定义问题 3 2、 变量命名规则 3 3、 变量的声明和初始化(Initialization) 3 4、 换行(Wrapping Lines) 4 5、 Map对象使用问题 4 6、 equals方法使用问题 5 7、 import多余包问题 5 8、 NullPointerException问题 6 9、 关于对象声明问题 7 10、 注释 7 11、 访问静态变量或方法 8 12、 使用静态变量 8 13、 If语句 8 14、 Java源文件的长度 8 15、 方法的长度 8 二、 项目开发规范 8 1、 Java文件命名规则 8 2、 JSP代码规范 9 3、 CTRL代码规范 14 4、 Event VO BO 17 5、 Proxy代码规范 18 6、 日志 20 7、 异常处理 21 8、 缓存 22  JAVA编程规范 变量定义问题 如果定义的变量只是在某个局部内使用，就在局部内定义，不要在局部外定义。 问题代码： // 返回的明细信息放到vo里传到前台 MAmkdjVO mamkdjVO = new MAmkdjVO(); //如果找到详细信息的记录，就展现 if (responseEvent.getFindNoRecordFlag() == 1) { mamkdjVO = responseEvent.getDetailVO();mamkdjVO只是在if条件内使用，只需要自if内定义即可) //如果找到详细信息的记录，就展现 if (responseEvent.getFindNoRecordFlag() == 1) {// 返回的明细信息放到vo里传到前台 MAmkdjVO mamkdjVO = responseEvent.getDetailVO(); 变量命名规则 1、禁用差别不大（只有一个或少数几个字母不同）的名称 例如：hiThere和hiThre 2、在名称中禁用下划线字符(_) 变量的声明和初始化(Initialization) 避免声明的局部变量覆盖上一级声明的变量尽量在声明局部变量的同时初始化。换行(Wrapping Lines) 当一个表达式无法容纳在一行内时，可以依据如下一般规则断开之： - 在一个逗号后面断开- 在一个操作符前面断开- 宁可选择较高级别(higher-level)的断开，而非较低级别(lower-level)的断开- 新的一行应该与上一行同一级别表达式的开头处对齐- 如果以上规则导致你的代码混乱或者使你的代码都堆挤在右边，那就代之以缩进8个空格。 //用 Iterator 实现遍历 Iterator keyValuePairs = conditionMap.entrySet().iterator(); //开始遍历条件map while (keyValuePairs.hasNext()) { Map.Entry conditionEntry = (Map.Entry) keyValuePairs.next();//用 Iterator 实现遍历 Iterator = conditionMap.keySet().iterator(); //开始遍历条件map while (.hasNext()) { String key = (String) keySet.next(); //可以直接造型成实际对象 Object keyValue = conditionMap.get(key); equals方法使用问题 使用equals方法进行比较的时候，把不为空的对象放在前面，避免NullPointerException异常。 问题代码： //数据库中存在记录 1代表存在记录 0代表不存在 if (responseEvent.getFindNoRecordFlag().equals(1)) { //数据库中存在记录 1代表存在记录 0代表不存在 if (1.equals(responseEvent.getFindNoRecordFlag())) { import多余包问题 每个java代码，提交前应该检查是否import没有使用的类，可以使用CTRL+SHIFT+O快捷键整理。 问题代码： NullPointerException问题 所有的公共方法必须考虑null对象参数，根据实际需要，要对传入的参数作非空校验。 问题代码： public static void v