JAVA基础及规范学习笔记

JAVA基础及规范学习笔记

一、代码编写规范

1. 优势

• 促进团队合作
• 减少bug的处理
• 减低维护成本
• 有助于代码审查

2. 规则

• 数据库操作
  数据库操作、IO操作等需要使用结束close()的对象必须在try-catch-finally的finally中close(),如果有多个IO对象需要close（），需要分别对每个对象的close（）方法进行try-catch，防止一个IO对象关闭失败其他IO对象都未关闭。
• 异常处理
  记录日志、throws子句、Error继承异常、记录异常、异常数量、异常捕获。
• 优先级
• 数值表达式定义清晰
  避免使用不易理解的数字，用有意义的标识来替代。
• 数组声明规则
  数组声明的时候使用int[] index,而不是使用int index[]使程序的可读性差。
• 定义打印类调试代码
  不使用System.out与System.err进行控制台打印，应该使用工具类（如：日志工具）进行统一记录或者打印。
  说明：代码发布的时候可以统一关闭控制台打印，代码调试的时候又可以打开控制台打印，方便调试。
• 集合必须指定类型
  为方便程序阅读，除去强制转化代码；
• 数据类覆写Object的方法
  数据类覆写通toString()、hashCode()、equals()->数据类的比较
  父类如果实现了比较合理的toString(),子类可以继承不必再重写。
• 重复代码合并
• 及时释放内存空间
• 保持代码简洁易懂