企业中的开发规范

• 1 .每一个java源文件都必须要有开头注释，在该java源文件被创建的时候都必须生成相应的开头注释信息，以标明该java源文件的作者及功能此外还要列出类名，版本信息，日期和版权声明。非该源文件创建者对源文件进行修改的人都必须在开头注释中填写修改人信息，修改日期，以及修改的内容。
• 2．对于未被引用的类，无须导入到该源文件中。在对完成一个类的编写后，如果采用的是eclipse那么请随手按下ctrl+shift+O去除未被引用的类。
• 3．重要的操作信息均要有日志，用logger.info进行记载。
• 4．在对查询数据库后获取的结果对象进行操作的时候，注意非空验证。即对查询结果进行非空判断以避免对查询出来的空结果进行操作而导致运行异常！
• 5．在对查询数据库后获取的结果对象进行操作的时候，注意非空验证。即对查询结果进行非空判断以避免对查询出来的空结果进行操作而导致运行异常！
• 6．尽量在循环体外声明一个变量，在循环体内实例化该对象。
• 7．对字符串进行处理的时候，尽量使用 StringBuffer而不是直接使用String
• 8．除物理删除数据库操作外，对数据库进行添加操作时，都必须对数据库中的CREATE_BY跟CREATE_DATE字段进行赋值操作。对数据库进行修改操作时，都必须对数据中的UPDATE_BY跟UPDATE_DATE字段进行赋值操作。
• 9 . 一个类的源代码不宜过多，在处理复杂业务时可考虑一个具体业务用一个方法来实现，以保证主流程部分代码的简洁。
• 10．类的命名规范：主业务为新增是以Add开头，主业务为修改时以Update开头，主业务为删除时以Delete开头，主业务为取得单条数据信息时以Get开头，主业务以查询多条纪录时以Query开头，主业务为验证数据时以Check开头，一个action处理数据库增，删，改三种操作时以Save开头。一些工具类及通用类的命名以能表达该类的主要作用为前提自行定义：如登录使用Login,注销使用Logout等。

例如：
添加用户信息：AddUserAction
根据用户ID修改用户信息：UpdateUserByIdAction
根据用户ID删除用户信息：DeleteUserByIdAction
保存用户信息：SaveUserAction
根据用户名称获取用户信息：GetUserByNameAction
根据名称查询用户信息：QueryUserByNameAction

• 11 . 非源文件创建者对代码进行修改时，必须在修改处加上//modify by 修改者 修改日期：2017-6-10 修改内容： 的注释。对原先的代码若非该段代码的编写人员在做修改则应注释掉原代码，不应直接删除。该段代码原先编写人员可根据具体实际决定是否要删除。
• 12 . 不使用System.out.print输出调试信息，而用log4j的logger.debug();打印出调试信息以利于后期系统开发完毕后，关闭调试信息的输出
• 13 . 不使用System.out.print输出调试信息，而用log4j的logger.debug();打印出调试信息以利于后期系统开发完毕后，关闭调试信息的输出
• 14．写完一个方法后，必须做一下UT，使代码更加的健壮。
• 15．日志有debug，info，warn，error四个级别，请根据业务的需要正确使用对应级别的日志，不要都用debug。