代码规范

  一、编程规约

  1、一些命名的风格必须是不能随着自己的个性而来的，必须强制；

  2、常量的定义，也要有一些规范，常量主要注意有一定的范围使用；

  3、代码格式，主要就是改写的一定要写，而且要注意我们都知道而又不喜欢做的，比如缩进，空格，写注释之类的；

  4、必须要写注释，注释也要有一定的规范，比如：所有的类都必须添加创建者和创建日期，这是最起码的对代码的记录；代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻 辑等的修改；特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫 描，经常清理此类标记。

  5、OOP规约 ，举一些简单常用的规范：所有的覆写方法，必须加@Override注解；相同参数类型，相同业务含义，才可以使用 Java的可变参数，避免使用 Object；避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析 成本，直接用类名来访问即可；所有整型包装类对象之间值的比较，全部使用equals方法比较；慎用 Object的 clone方法来拷贝对象；任何类、方法、参数、变量，严控访问范围。

  6、集合处理 ，集合初始化时，指定集合初始值大小；在使用Collection 接口任何实现类的addAll()方法时，都要对输入的集合参数进行 NPE判断。

  7、控制语句，当switch 括号内的变量类型为String并且此变量为外部参数时，必须先进行null 判断；表达异常的分支时，少用 if-else 方式，不要在其它表达式（尤其是条件表达式）中，插入赋值语句。

  二、异常日志 

  1、对于异常处理，不要用来做流程控制，条件控制；避免出现重复的代码（少复制粘贴自己的代码）；方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分 说明什么情况下会返回 null值。

  2、所有日志文件至少保存15天，网络日志最少6个月；尽量用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使 用中文描述即可，否则容易产生歧义（个人比较推荐中文，因为我们是中国人）。

三、单元测试

  好的单元测试必须遵守 AIR原则，具有有自动化、独立性、可重复执行的特点；单元测试是可以重复执行的，不能受到外界环境的影响。 说明：单元测试通常会被放到持续集成中，每次有代码 check in 时单元测试都会被执行；单元测试代码必须写在如下工程目录：src/test/java，不允许写在业务代码目录下； 单元测试的基本目标：语句覆盖率达到 70%；核心模块的语句覆盖率和分支覆盖率 都要达到 100% 。

四、安全规约 

  安全为主，隶属于用户个人的页面或者功能必须进行权限控制校验；禁止向 HTML页面输出未经安全过滤或未正确转义的用户数据，总之，就是秘密和规矩。

五、MySQL数据库 

  表名不使用复数名词，禁用保留字，如 desc、range、match、delayed等，请参考MySQL官方保留字；表的命名最好是遵循“业务名称_表的作用；代码中写分页查询逻辑时，若 count为0应直接返回，避免执行后面的分页语句。 

六、工程结构 

  为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则： 精简可控原则，稳定可追溯原则；

  做工程时，图比较直观，在图中默认上层依赖于下层，箭头关系表示可直接依赖。