阿里开发手册

一、代码规范：

  1. 接口中分方法和属性，不加修饰符号如:publc，正确为：void f()
  2. long或Long，统一用Long类型处理
  3. 常量按功能分类归类
  4. if/for/while/switch/do等保留字与括号之间都必须加空格
  5. 注释的双斜线与注释内容之间有且仅有一个空格
  6. 当字符数超过120个时，换行规则：第二行相对第一行缩进4个空格，第三行开始不缩进
  7. 方法参数在定义和传入时，多个参数都厚后边必须加空格
  8. 所有相同类型的包装类对象之间值的比较，全部使用equals比较，如:Integer的比较用equals
  9. 所有实体类必须用包装数据类型
  10. RPC方法（远程调用方法）的返回值和参数必须使用包装数据类型
  11. 所有局部变量使用基本数据类型
  12. 定义DO/DTO/VO等POJO类时，不设定任何属性默认值
  13. POJO类必须写toString方法
  14. 类内方法定义顺序：公有方法或保护方法 > 私有方法 > getter/setter方法
  15. 循环体中，字符串的拼接，使用StringBuilder的append方法扩展
  16. 集合转数组，使用toArray(T[] array)带参方法，最好入参数组大小和集合元素个数一致
  17. foreach循环中进行元素的remove/add操作，使用Iterator方式，
  18. HashMap使用HashMap(int initialCapacity)初始化
  19. 使用set唯一特性去重，避免使用contains方法遍历去重
  20. SimpleDateFormat线程不安全，使用DateUtils工具类更好
  21. 少用if-else，可以使用if() {return ;}
  22. 高并发情况，避免使用等于作为中断或者退出的条件，可能出现击穿的情况，使用大于或小于的区间判断
  23. 循环体中的语句要考虑性能，定义对象、变量、获取数据库连接，try-catch操作，尽量移至循环体外处理
  24. 类、类属性、类方法注释使用/*内容/，不使用// xxx方式
  25. 所有抽象方法，包括接口中的方法，必须要用javadoc注释，注释包括：返回值、参数、异常、还指出该方法做什么事情，实现什么功能
  26. 枚举类型字段都要有注释
  27. 代码修改的同时，注释也要修改，包括：参数、返回值、异常、核心逻辑
  28. 谨慎注释调代码，后续要回复的代码逻辑可以注释，永久不用的直接删掉，仓库有保存历史代码
  29. 注释的要求：1）反应设计思想代码逻辑；2）能够描述业务含义；
  30. 好的命名是自解释了
  31. 待办事宜用TODO，错误不能工作的用（FIXME）

二、异常日志：

  1. try…catch…异常不要用来做流程控制，条件控制，流程条件这些用if等语句处理，try…catch…只用于处理异常
  2. 不大段代码进行try-catch，不利于定位问题
  3. 捕获异常要处理它，不处理要把异常抛给调用者
  4. 方法返回值可以是null，不强制返回空集合空对象，同事添加注释
  5. 防止空指针异常，包装类和基本数据类型，数据库查询结果可能为null，远程调用要进行判断，从session中获取数据要进行空指针判断，一连串调用也容易产生空指针异常
  6. 应用内部推荐异常抛出，而跨应用间的rpc考虑使用Result方式，封装isSuccess()方法、错误码、错误信息
  7. 避免重复代码，重复使用的要抽取
  8. 日志文件至少保存15天，有些异常以“周”为频次发生
  9. 使用日志框架slf4j的api，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一
  10. 日志输出，使用条件形式输出或者使用占位符的方式，如：if() {logger.debug(“ok”)}
  11. 异常信息要包括两类信息：案发现场信息和异常堆栈信息。如果不处理，通过关键字throws往上抛出。如：logger.error(各类参数或对象toString + “_” + e.getMessage(), e)
  12. 记录日志时要思考：1）日志有人看吗？2）看到这个日志我能做什么？3）能不能给问题排查带来好处

三、单元测试

  1. 单元测试代码放在src/test/java下，保证测试粒度足够小，有助于精确定位问题，每个应用分层都要进行单元测试
  2. 单元测试：BCDE，边界值测试（循环边界、特殊取值、特殊时间点、数据顺序），正确的输入，与设计文档相结合，强制错误信息输入

四、安全规约

  1. 敏感数据禁止直接展示，要脱敏
  2. 注意反序列化注入（把字节流转成对象），转成不可预期的对象执行代码影响程序

五、MySQL数据库
1）建表

  1. 表达是与否的字段，必须使用is_xxx的方式命名，数据类型用tinyint，（1表示是，0表示否）
  2. 表名和字段名必须使用小写字母或数字，windows下不区分大小写，但linux下区分大小写
  3. 表名不适用复数名词
  4. 小数类型为decimal，禁止使用float和double，这两个存在精度损失问题，如果存储的数据范围超过decimal，建议将数据拆成整数和小数分开存储
  5. 表必备三字段：id（主键，类型bigint）, gmt_create（datetime类型）主动创建, gmt_modified（datetime类型）被动更新
  6. 表的命名最好加上：业务名称_表的作用（trade_config）
  7. 库名和应用名称尽量一致
  8. 如果字段使用频率高，字段长度短，名称基本一成不变，可以在相关联的表中冗余存储类目名称（即在另一张表中存同样一个字段的数据），避免关联查询
  9. 单表行数超过500万行或者单表容量超过2GB才推荐进行分库分表

2）索引