本文参考《阿里巴巴Java开发手册》

1 异常处理

    （1）【强制】Java 类库中定义的可以通过预检查方式规避 RuntimeException，不应该通过 catch 方式来处理。

    （2）【强制】异常不要用作流程控制，条件控制。

    （3）【强制】catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。

    （4）【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃它，如果不想处理请将该异常抛给调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。

    （5）【强制】有 try 块放到了事务代码中，catch 时一定要注意手动回滚事务。

    （6）【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。JDK7 以上可以使用 try-with-resources 方式。

    （7）【强制】不要在 finally 块中使用 return 。

    （8）【强制】捕获异常与抛异常，必须完全匹配，或者捕获异常是抛异常的父类。

    （9）【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。

    （10）【推荐】防止 NPE ，是程序员的基本修养，注意 NPE 产生的场景：

        1）返回类型为基本数据类型，return 包装数据类型对象时，自动拆箱有可能产生 NPE。

        2）数据的查询结果可能为 null。

        3）集合里的元素即使是 isNotEmpty，取出的数据元素也可能为 null。

        4）远程调用返回对象时，一律要求进行空指针判断，防止 NPE。

        5）对于 Session 中获取的数据，建议 NPE 检查，避免空指针。

        6）级联调用 obj.getA().getB().getC(); 一连串调用，易产生 NPE。

    （11）【推荐】定义时区分 unchecked / checked 异常，避免直接抛出 new RuntimeException()，更不允许抛出 Exception 或者 Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DAOException / ServiceException 等。

    （12）【参考】对于公司外的 http / api 开放接口必须使用 "错误码"；而应用内部推荐异常抛出；跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess()方法、"错误码"、"错误简短信息"。

    （13）【参考】避免出现重复的代码（Don't Repeat Yourself），即 DRY 原则。

2 日志规约

    （1）【强制】应用中不可直接使用日志系统（log4j、Logback）中的 API，而应依赖使用日志框架 SLF4J 中的 API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式的统一。

    （2）【强制】日志文件至少保存15天，因为有些异常具备以"周"为频次发生的特点。

    （3）【强制】应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：

            AppName_logType_logName.log。

                logType：日志类型，stats / monitor / access等；

                logName：日志描述。

    （4）【强制】对 trace / debug / info 级别的日志输出，必须使用条件输出形式或使用占位符的方式。

    （5）【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity = false。

    （6）【强制】异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过 throws 往上抛出。

    （7）【推荐】谨慎的记录日志。生产环境禁止输出 debug 日志，有选择地输出 info 日志；如果使用 warn 来记录刚刚上线时的业务行为信息，一定要注意日志输出量问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。

    （8）【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。如非必要，请不要在此场景打印 error 级别，避免频繁报警。

    （9）【推荐】尽量使用英文来描述日志错误信息，如果日志中的错误信息用英文描述不清楚的话使用中文描述，否则容易产生歧义。

    （10）【强制】国际化团队或海外部署的服务器由于字符集问题，使用全英文来注释和描述日志错误信息。