导航
导航
文章目录
  1. 编程规约
  2. 异常日志
  3. MYSQL 规约
  4. 工程规约
  5. 安全规约

阿里Java开发手册—笔记

摘取其中笔者认为不错的内容。 笔记出处:阿里巴巴Java开发手册公开版

编程规约

  • POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误。
  • 接口类中方法和属性不要加任何修饰符号(public也不要加)保持代码简洁性。
  • long或者Long初始赋值,使用大写的Long,防止跟数字1混淆
  • 所有的覆写方法,必须加@Override注解
  • Object 的 equals 方法容易抛空指针异常,应使用常量或确定有值的对象来调用 equals
    正例: “test”.equals(object);
    反例: object.equals(“test”);
  • 所有的相同类型的包装类对象之间值的比较,全部使用 equals 方法比较
  • 构造方法里面禁止加入任何业务逻辑,如果有初始化逻辑,请放在 init 方法中。
  • POJO 类必须写 toString 方法
  • 使用索引访问用 String 的 split 方法得到的数组时,需做最后一个分隔符后有无内容的检查,否则会有抛 IndexOutOfBoundsException 的风险。
    ps::笔者使用commons.lang3.StringUtils工具方法切分,它对空字符串””会进行过滤。
  • Map/Set 的 key 为自定义对象时,必须重写 hashCode 和 equals。因为String 重写了 hashCode 和 equals 方法,所以可以直接使用 String 对象作为 key 来使用
  • 不要在 foreach 循环里进行元素的 remove/add 操作。remove 元素请使用 Iterator方式,如果并发操作,需要对 Iterator 对象加锁
  • 集合初始化时,尽量指定集合初始值大小。
  • 使用 entrySet 遍历 Map 类集合 KV,而不是 keySet 方式进行遍历
  • SimpleDateFormat 是线程不安全的类,一般不要定义为 static 变量,如果定义为static,必须加锁,或者使用 DateUtils 工具类。
    ps: 笔者之前就入坑了 /(ㄒoㄒ)/~~
  • 避免用 Apache Beanutils 进行属性的 copy。
    ps: 笔者公司项目使用拷贝工具orika(五星推荐)

异常日志

  • 应用中不可直接使用日志系统(Log4j、Logback)中的 API,而应依赖使用日志框架SLF4J 中的 API,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一
  • 对 trace/debug/info 级别的日志输出,必须使用条件输出形式或者使用占位符的方式
  • NPE的注意

MYSQL 规约

  • 任何字段如果为非负数,必须是 unsigned
  • 单表行数超过 500 万行或者单表容量超过 2GB,才推荐进行分库分表
  • 超过三个表禁止 join。需要 join 的字段,数据类型保持绝对一致;多表关联查询时,保证被关联的字段需要有索引
    ps: 考虑到阿里的数据规模,不然笔者认为join的条件太苛刻了。
  • SQL 性能优化的目标:至少要达到 range 级别,要求是 ref 级别,如果可以是 consts最好。
  • 建组合索引的时候,区分度最高的在最左边
  • 不要使用 count(列名)或 count(常量)来替代 count(),count()就是 SQL92 定义的标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关
    说明:count(*)会统计值为 NULL 的行,而 count(列名)不会统计此列为 NULL 值的行。
  • 当某一列的值全是 NULL 时,count(col)的返回结果为 0,但 sum(col)的返回结果为
    NULL,因此使用 sum()时需注意 NPE 问题。
  • 不得使用外键与级联,一切外键概念必须在应用层解决。
  • 禁止使用存储过程,存储过程难以调试和扩展,更没有移植性。
  • 不允许直接拿 HashMap 与 HashTable 作为查询结果集的输出。

工程规约

  • 给 JVM 设置-XX:+HeapDumpOnOutOfMemoryError 参数,让 JVM 碰到 OOM 场景时输出 dump信息

安全规约

  • 用户敏感数据禁止直接展示,必须对展示数据脱敏
    说明:个人手机号码会显示成:158**9119
  • 用户请求传入的任何参数必须做有效性验证
    说明:忽略参数校验可能导致:
  1. page size 过大导致内存溢出
  2. 恶意 order by 导致数据库慢查询
  3. 恶意 order by 导致数据库慢查询
  4. 任意重定向
  5. SQL 注入
  6. Shell 注入
  7. 反序列化注入
  • 表单、AJAX 提交必须执行 CSRF 安全过滤