阿里巴巴JAVA开发手册(二)

版本号	制作团队	更新日期	备注
1.0.0	阿里巴巴集团技术部	2016.12.7	首次向 Java 业界公开

二、异常日志

(一) 异常处理

1. 【强制】不要捕获 Java 类库中定义的继承自 RuntimeException 的运行时异常类，如: IndexOutOfBoundsException / NullPointerException，这类异常由程序员预检查来规避，保证程序健壮性。
   正例:

if(obj != null) {
    ...
}

反例:

try { 
    obj.method() 
} catch(NullPointerException e){
    ...
}

2 【强制】异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。

3【强制】对大段代码进行 try-catch，这是不负责任的表现。catch 时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的 catch 尽可能进行区分异常类型，再做对应的异常处理。

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

5 【强制】有 try 块放到了事务代码中，catch 异常后，如果需要回滚事务，一定要注意手动回滚事务。

6 【强制】finally 块必须对资源对象、流对象进行关闭，有异常也要做 try-catch。
说明:如果 JDK7，可以使用 try-with-resources 方法。

7 【强制】不能在 finally 块中使用 return，finally 块中的 return 返回后方法结束执行，不会再执行 try 块中的 return 语句。

8 【强制】捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
说明:如果预期抛的是绣球，实际接到的是铅球，就会产生意外情况。

9 【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分 说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
说明:本规约明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回 null 的情况。

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

• 1) 返回类型为包装数据类型，有可能是 null，返回 int 值时注意判空。
  反例:

public int f(){ 
    return Integer 对象
}，如果为 null，自动解箱抛 NPE。

• 2) 数据库的查询结果可能为 null。
• 3) 集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。
• 4) 远程调用返回对象，一律要求进行 NPE 判断。
• 5) 对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
• 6) 级联调用 obj.getA().getB().getC();一连串调用，易产生 NPE。

11【推荐】在代码中使用“抛异常”还是“返回错误码”，对于公司外的 http/api 开放接口必须使用“错误码”;而应用内部推荐异常抛出;跨应用间 RPC 调用优先考虑使用 Result 方式，封装 isSuccess、“错误码”、“错误简短信息”。
说明:关于 RPC 方法返回方式使用 Result 方式的理由:

• 1)使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
• 2)如果不加栈信息，只是 new 自定义异常，加入自己的理解的 error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输 的性能损耗也是问题。

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

13【参考】避免出现重复的代码(Don’t Repeat Yourself)，即 DRY 原则。
说明:随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。
正例:一个类中有多个 public 方法，都需要进行数行相同的参数校验操作，这个时候请抽取:

private boolean checkParam(DTO dto){
    ...
}

(二) 日志规约

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

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
private static final Logger logger = LoggerFactory.getLogger(Abc.class);

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

3 【强制】应用中的扩展日志(如打点、临时监控、访问日志等)命名方式:
appName_logType_logName.log。logType:日志类型，推荐分类有 stats/desc/monitor/visit 等;logName:日志描述。这种命名的好处:通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。
正例:

mppserver 应用中单独监控时区转换异常，如: mppserver_monitor_timeZoneConvert.log 说明:推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于 通过日志对系统进行及时监控。

4 【强制】对 trace/debug/info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
说明:logger.debug(“Processing trade with id: ” + id + ” symbol: ” + symbol); 如果日志级别是 warn，上述日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，会执行 toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。
正例:(条件)

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
} 

正例:(占位符)

logger.debug("Processing trade with id: {} and symbol : {} ", id, symbol);

5 【强制】避免重复打印日志，浪费磁盘空间，务必在 log4j.xml 中设置 additivity=false。
正例:
<logger name="com.taobao.ecrm.member.config" additivity="false">

6 【强制】异常信息应该包括两类信息:案发现场信息和异常堆栈信息。如果不处理，那么往上 抛。
正例:

logger.error(各类参数或者对象 toString + "_" + e.getMessage(), e);

7 【强制】输出的 POJO 类必须重写 toString 方法，否则只输出此对象的 hashCode 值(地址值)，没啥参考意义。

8 【推荐】可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error 级别只记录系统逻辑出错、异常、或者重要的错误信息。如非必要，请不要在此场景打出 error 级别，避免频繁报警。

9 【推荐】谨慎地记录日志。生产环境禁止输出 debug 日志;有选择地输出 info 日志;如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
说明:大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。纪录日志时请思考:这些日志真的有人看吗?看到这条日志你能做什么?能不能给问题排查带来好处?

10【参考】如果日志用英文描述不清楚，推荐使用中文注释。对于中文 UTF-8 的日志，在 secureCRT 中，set encoding=utf-8;如果中文字符还乱码，请设置:全局>默认的会话设置>外观>字体>选择字符集gb2312;如果还不行，执行命令:set termencoding=gbk，并且直接使用中文来进行检索。

三、MYSQL 规约

(一) 建表规约

1 【强制】表达是与否概念的字段，必须使用 is_xxx 的方式命名，数据类型是 unsigned tinyint ( 1 表示是，0 表示否)，此规则同样适用于 odps 建表。
说明:任何字段如果为非负数，必须是 unsigned。

2 【强制】表名、字段名必须使用小写字母或数字;禁止出现数字开头，禁止两个下划线中间只出现数字。数据库字段名的修改代价很大，因为无法进行预发布，所以字段名称需要慎重考虑。
正例:

getter_admin，task_config，level3_name 

反例:

GetterAdmin，taskConfig，level_3_name

3 【强制】表名不使用复数名词。 说明:表名应该仅仅表示表里面的实体内容，不应该表示实体数量，对应于 DO 类名也是单数形式，符合表达习惯。

4 【强制】禁用保留字，如 desc、range、match、delayed 等，参考官方保留字。

5 【强制】唯一索引名为 uk_字段名;普通索引名则为 idx_字段名。
说明:uk_ 即 unique key;idx_ 即 index 的简称。

6 【强制】小数类型为 decimal，禁止使用 float 和 double。
说明:float 和 double 在存储的时候，存在精度损失的问题，很可能在值的比较时，得到不正确的结果。如果存储的数据范围超过 decimal 的范围，建议将数据拆成整数和小数分开存储。

7 【强制】如果存储的字符串长度几乎相等，使用 CHAR 定长字符串类型。

8 【强制】varchar 是可变长字符串，不预先分配存储空间，长度不要超过 5000，如果存储长度 大于此值，定义字段类型为 TEXT，独立出来一张表，用主键来对应，避免影响其它字段索引效率。

9 【强制】表必备三字段:id, gmt_create, gmt_modified。
说明:其中 id 必为主键，类型为 unsigned bigint、单表时自增、步长为 1;分表时改为从 TDDL Sequence 取值，确保分表之间的全局唯一。gmt_create, gmt_modified 的类型均为 date_time 类型。

10【推荐】表的命名最好是加上“业务名称_表的作用”，避免上云梯后，再与其它业务表关联
时有混淆。
正例:

tiger_task / tiger_reader / mpp_config

11【推荐】库名与应用名称尽量一致。

12【推荐】如果修改字段含义或对字段表示的状态追加时，需要及时更新字段注释。

13【推荐】字段允许适当冗余，以提高性能，但是必须考虑数据同步的情况。冗余字段应遵循:

• 1)不是频繁修改的字段。
• 2)不是 varchar 超长字段，更不能是 text 字段。
  正例:

各业务线经常冗余存储商品名称，避免查询时需要调用 IC 服务获取。

14【推荐】单表行数超过 500 万行或者单表容量超过 2GB，才推荐进行分库分表。
说明:如果预计三年后的数据量根本达不到这个级别，请不要在创建表时就分库分表。
反例:

某业务三年总数据量才 2 万行，却分成 1024 张表，问:你为什么这么设计?答:分 1024 张表，不是标配吗?

15【参考】合适的字符存储长度，不但节约数据库表空间、节约索引存储，更重要的是提升检索 速度。
正例:

人的年龄用 unsigned tinyint(表示范围 0-255，人的寿命不会超过 255 岁);海龟就必须是 smallint，但如果是太阳的年龄，就必须是 int;如果是所有恒星的年龄都加起来，那么就必须使用 bigint。

(二) 索引规约

1 【强制】业务上具有唯一特性的字段，即使是组合字段，也必须建成唯一索引。 说明:不要以为唯一索引影响了 insert 速度，这个速度损耗可以忽略，但提高查找速度是明显的;另外，即使在应用层做了非常完善的校验和控制，只要没有唯一索引，根据墨菲定律， 必然有脏数据产生。

2 【强制】超过三个表禁止 join。需要 join 的字段，数据类型保持绝对一致;多表关联查询时，保证被关联的字段需要有索引。
说明:即使双表 join 也要注意表索引、SQL 性能。

3 【强制】在 varchar 字段上建立索引时，必须指定索引长度，没必要对全字段建立索引，根据实际文本区分度决定索引长度。
说明:索引的长度与区分度是一对矛盾体，一般对字符串类型数据，长度为 20 的索引，区分度会高达 90%以上，可以使用 count(distinct left(列名, 索引长度))/count(*)的区分度来确定。

4 【强制】页面搜索严禁左模糊或者全模糊，如果需要请走搜索引擎来解决。
说明:索引文件具有 B-Tree 的最左前缀匹配特性，如果左边的值未确定，那么无法使用此索引。

5 【推荐】如果有 order by 的场景，请注意利用索引的有序性。order by 最后的字段是组合索引的一部分，并且放在索引组合顺序的最后，避免出现 file_sort 的情况，影响查询性能。
正例:

where a=? and b=? order by c; 
索引:a_b_c

反例:

索引中有范围查找，那么索引有序性无法利用，如:WHERE a>10 ORDER BY b; 索引 a_b 无法排序。

6 【推荐】利用覆盖索引来进行查询操作，来避免回表操作。
说明:如果一本书需要知道第 11 章是什么标题，会翻开第 11 章对应的那一页吗?目录浏览一下就好，这个目录就是起到覆盖索引的作用。
正例:I

DB 能够建立索引的种类:主键索引、唯一索引、普通索引，而覆盖索引是一种查询的 一种效果，用 explain 的结果，extra 列会出现:using index.

7 【推荐】利用延迟关联或者子查询优化超多分页场景。
说明:MySQL 并不是跳过 offset 行，而是取 offset+N 行，然后返回放弃前 offset 行，返回 N 行，那当 offset 特别大的时候，效率就非常的低下，要么控制返回的总页数，要么对超过特 定阈值的页数进行 SQL 改写。
正例:

先快速定位需要获取的 id 段，然后再关联:
SELECT a.* FROM 表 1 a, (select id from 表 1 where 条件 LIMIT 100000,20 ) b where a.id=b.id

8 【推荐】 SQL 性能优化的目标:至少要达到 range 级别，要求是 ref 级别，如果可以是 consts
最好。说明:

• 1)consts 单表中最多只有一个匹配行(主键或者唯一索引)，在优化阶段即可读取到数据。 2)ref 指的是使用普通的索引。(normal index)
• 3)range 对索引进范围检索。
  反例:

explain 表的结果，type=index，索引物理文件全扫描，速度非常慢，这个 index 级别 比较 range 还低，与全表扫描是小巫见大巫。

9 【推荐】建组合索引的时候，区分度最高的在最左边。
正例:

如果 where a=? and b=? ，a 列的几乎接近于唯一值，那么只需要单建 idx_a 索引即可。

说明:存在非等号和等号混合判断条件时，在建索引时，请把等号条件的列前置。如:where a>? and b=? 那么即使 a 的区分度更高，也必须把 b 放在索引的最前列。

10.【参考】创建索引时避免有如下极端误解:

• 1)误认为一个查询就需要建一个索引。
• 2)误认为索引会消耗空间、严重拖慢更新和新增速度。
• 3)误认为唯一索引一律需要在应用层通过“先查后插”方式解决。

(三) SQL 规约

1 【强制】不要使用 count(列名)或 count(常量)来替代 count()，count()就是 SQL92 定义的 标准统计行数的语法，跟数据库无关，跟 NULL 和非 NULL 无关。
说明:count(*)会统计值为 NULL 的行，而 count(列名)不会统计此列为 NULL 值的行。

2 【强制】count(distinct col) 计算该列除 NULL 之外的不重复数量。注意 count(distinct col1, col2) 如果其中一列全为 NULL，那么即使另一列有不同的值，也返回为 0。

3 【强制】当某一列的值全是 NULL 时，count(col)的返回结果为 0，但 sum(col)的返回结果为 NULL，因此使用 sum()时需注意 NPE 问题。
正例:

可以使用如下方式来避免 sum 的 NPE 问题:SELECT IF(ISNULL(SUM(g)),0,SUM(g)) FROM table;

4 【强制】使用 ISNULL()来判断是否为 NULL 值。注意:NULL 与任何值的直接比较都为 NULL。 说明:

• 1) NULL<>NULL 的返回结果是 NULL，不是 false。
• 2) NULL=NULL 的返回结果是 NULL，不是 true。
• 3) NULL<>1 的返回结果是 NULL，而不是 true。
  5 【强制】在代码中写分页查询逻辑时，若 count 为 0 应直接返回，避免执行后面的分页语句。

6 【强制】不得使用外键与级联，一切外键概念必须在应用层解决。 说明:(概念解释)学生表中的 student_id 是主键，那么成绩表中的 student_id 则为外键。 如果更新学生表中的 student_id，同时触发成绩表中的 student_id 更新，则为级联更新。外键与级联更新适用于单机低并发，不适合分布式、高并发集群;级联更新是强阻塞，存在数据 库更新风暴的风险;外键影响数据库的插入速度。

7 【强制】禁止使用存储过程，存储过程难以调试和扩展，更没有移植性。

8 【强制】IDB 数据订正时，删除和修改记录时，要先 select，避免出现误删除，确认无误才能 提交执行。

9 【推荐】in 操作能避免则避免，若实在避免不了，需要仔细评估 in 后边的集合元素数量，控 制在 1000 个之内。

10.【参考】因阿里巴巴全球化需要，所有的字符存储与表示，均以 utf-8 编码，那么字符计数方 法注意:
说明:
SELECT LENGTH(“阿里巴巴”); 返回为 12
SELECT CHARACTER_LENGTH(“阿里巴巴”); 返回为 4 如果要使用表情，那么使用 utfmb4 来进行存储，注意它与 utf-8 编码。

11.【参考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系统和事务日志资源少，但 TRUNCATE 无事务且不触发 trigger，有可能造成事故，故不建议在开发代码中使用此语句。 说明:TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

(四) ORM 规约

1 【强制】在表查询中，一律不要使用 * 作为查询的字段列表，需要哪些字段必须明确写明。 说明:1)增加查询分析器解析成本。2)增减字段容易与 resultMap 配置不一致。

2 【强制】POJO 类的 boolean 属性不能加 is，而数据库字段必须加 is_，要求在 resultMap 中 进行字段与属性之间的映射。
说明:参见定义 POJO 类以及数据库字段定义规定，在 sql.xml 增加映射，是必须的。

3 【强制】不要用 resultClass 当返回参数，即使所有类属性名与数据库字段一一对应，也需要定义;反过来，每一个表也必然有一个与之对应。
说明:配置映射关系，使字段与 DO 类解耦，方便维护。

4 【强制】xml 配置中参数注意使用:#{}，#param# 不要使用${} 此种方式容易出现 SQL 注入。

5 【强制】iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使 用。
说明:其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录，再通过 subList 取 start,size 的子集合，线上因为这个原因曾经出现过 OOM。

正例:

在 sqlmap.xml 中引入 #start#, #size#
Map<String, Object> map = new HashMap<String, Object>(); map.put("start", start);
map.put("size", size);

6 【强制】不允许直接拿 HashMap 与 HashTable 作为查询结果集的输出。 反例:

某同学为避免写一个<resultMap>，直接使用 HashTable 来接收数据库返回结果，结果 出现日常是把 bigint 转成 Long 值，而线上由于数据库版本不一样，解析成 BigInteger，导 致线上问题。

7 【强制】更新数据表记录时，必须同时更新记录对应的 gmt_modified 字段值为当前时间。

8 【推荐】不要写一个大而全的数据更新接口，传入为 POJO 类，不管是不是自己的目标更新字 段，都进行 update table set c1=value1,c2=value2,c3=value3; 这是不对的。执行 SQL 时，尽量不要更新无改动的字段，一是易出错;二是效率低;三是 binlog 增加存储。

9 【参考】@Transactional 事务不要滥用。事务会影响数据库的 QPS，另外使用事务的地方需要 考虑各方面的回滚方案，包括缓存回滚、搜索引擎回滚、消息补偿、统计修正等。

10.【参考】中的 compareValue 是与属性值对比的常量，一般是数字，表示相等时带上此条件;表示不为空且不为 null 时执行;表示不为 null 值时执行。

四、工程规约

(一) 应用分层

1 【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如:开放接口层可以依赖于 Web 层，也可以直接依赖于 Service 层，依此类推:

• 开放接口层:可直接封装 Service 接口暴露成 RPC 接口;通过 Web 封装成 http 接口;网关控 制层等。
• 终端显示层:各个端的模板渲染并执行显示层。当前主要是 velocity 渲染，JS 渲染，JSP 渲 染，移动端展示层等。
• Web 层:主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
• Service 层:相对具体的业务逻辑服务层。
• Manager 层:通用业务处理层，它有如下特征:
  1) 对第三方平台封装的层，预处理返回结果及转化异常信息;
  2) 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理; 3) 与 DAO 层交互，对 DAO 的业务通用能力的封装。
• DAO 层:数据访问层，与底层 Mysql、Oracle、Hbase、OB 进行数据交互。
• 外部接口或第三方平台:包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。
  2 【参考】(分层异常处理规约)在 DAO 层，产生的异常类型有很多，无法用细粒度异常进行 catch，使用 catch(Exception e)方式，并 throw new DaoException(e)，不需要打印日志， 因为日志在 Manager/Service 层一定需要捕获并打到日志文件中去，如果同台服务器再打日志， 浪费性能和存储。在 Service 层出现异常时，必须记录日志信息到磁盘，尽可能带上参数信息， 相当于保护案发现场。如果 Manager 层与 Service 同机部署，日志方式与 DAO 层处理一致，如 果是单独部署，则采用与 Service 一致的处理方式。Web 层绝不应该继续往上抛异常，因为已 经处于顶层，无继续处理异常的方式，如果意识到这个异常将导致页面无法正常渲染，那么就 应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错 误码和错误信息方式返回。

3 【参考】分层领域模型规约:

• DO(Data Object):与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
• DTO(Data Transfer Object):数据传输对象，Service 和 Manager 向外传输的对象。
• BO(Business Object):业务对象。可以由 Service 层输出的封装业务逻辑的对象。
• QUERY:数据查询对象，各层接收上层的查询请求。注:超过 2 个参数的查询封装，禁止使 用 Map 类来传输。
• VO(View Object):显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

(二) 二方库规约

1 【强制】定义 GAV 遵从以下规则:
1) GroupID 格式:com.{公司/BU }.业务线.[子业务线]，最多 4 级。
说明:{公司/BU} 例如:alibaba/taobao/tmall/aliexpress 等 BU 一级;子业务线可选。
正例:

com.taobao.tddl 或 com.alibaba.sourcing.multilang

2) ArtifactID 格式:产品线名-模块名。语义不重复不遗漏，先到仓库中心去查证一下。
正例:

tc-client / uic-api / tair-tool

3) Version:详细规定参考下方。

2 【强制】二方库版本号命名方式:主版本号.次版本号.修订号
1) 主版本号:当做了不兼容的 API 修改，或者增加了能改变产品方向的新功能。
2) 次版本号:当做了向下兼容的功能性新增(新增类、接口等)。
3) 修订号:修复 bug，没有修改方法签名的功能加强，保持 API 兼容性。

3 【强制】线上应用不要依赖 SNAPSHOT 版本(安全包除外);正式发布的类库必须使用 RELEASE 版本号升级+1 的方式，且版本号不允许覆盖升级，必须去中央仓库进行查证。
说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。

4 【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一 致，那么通过 dependency:tree 命令，找出差异点，进行排除 jar 包。

5 【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚 举类型或者包含枚举类型的 POJO 对象。

6 【强制】依赖于一个二方库群时，必须定义一个统一版本变量，避免版本号不一致。
说明:依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本:${spring.version}，定义依赖的时候，引用该版本。

7 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的 Version。
说明:在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号 出现在最后的 lib 目录中。曾经出现过线下调试是正确的，发布到线上出故障的先例。

8 【推荐】工具类二方库已经提供的，尽量不要在本应用中编程实现。

• json 操作: fastjson
• md5 操作:commons-codec
• 工具集合:Guava 包
• 数组操作:ArrayUtils(org.apache.commons.lang3.ArrayUtils)
• 集合操作:CollectionUtils(org.apache.commons.collections4.CollectionUtils)
• 除上面以外还有 NumberUtils、DateFormatUtils、DateUtils 等优先使用 org.apache.commons.lang3 这个包下的，不要使用 org.apache.commons.lang 包下面 的。原因是 commons.lang 这个包是从 JDK1.2 开始支持的所以很多 1.5/1.6 的特性是不 支持的，例如:泛型。

9 【推荐】所有 pom 文件中的依赖声明放在语句块中，所有版本仲裁放在 语句块中。 说明:里只是声明版本，并不实现引入，因此子项目需要显式的声明 依赖，version 和 scope 都读取自父 pom。而所有声明在主 pom 的 里的依赖都会自动引入，并默认被所有的子项目继承。

10【推荐】二方库尽量不要有配置项，最低限度不要再增加配置项。

11【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则: 1)精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对 象、Utils 类、常量、枚举等。如果依赖其它二方库，尽量是 provided 引入，让二方库使用 者去依赖具体版本号;无 log 具体实现，只依赖日志框架。 2)稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能 方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

(三) 服务器规约

1 【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。
说明:操作系统默认 240 秒后，才会关闭处于 time_wait 状态的连接，在高并发访问下，服务 器端会因为处于 time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上调小 此等待值。
正例:

在 linux 服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值(秒):
net.ipv4.tcp_fin_timeout = 30

2 【推荐】调大服务器所支持的最大文件句柄数(File Descriptor，简写为 fd)。 说明:主流操作系统的设计是将 TCP/UDP 连接采用与文件一样的方式去管理，即一个连接对应 于一个 fd。主流的 linux 服务器默认所支持最大 fd 数量为 1024，当并发连接数很大时很容易因为 fd 不足而出现“open too many files”错误，导致新的连接无法建立。 建议将 linux 服务器所支持的最大句柄数调高数倍(与服务器的内存数量相关)。

3 【推荐】给JVM设置-XX:+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump
信息。
说明:OOM 的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错 非常有价值。

4 【参考】服务器内部重定向必须使用 forward;外部重定向地址必须使用 URL Broker 生成， 否则因线上采用 HTTPS 协议而导致浏览器提示“不安全”。此外，还会带来 URL 维护不一致的问题。

五、安全规约

1 【强制】可被用户直接访问的功能必须进行权限控制校验。 说明:防止没有做权限控制就可随意访问、操作别人的数据，比如查看、修改别人的订单。

2 【强制】用户敏感数据禁止直接展示，必须对展示数据脱敏。 说明:支付宝中查看个人手机号码会显示成:158****9119，隐藏中间 4 位，防止隐私泄露。

3 【强制】用户输入的 SQL 参数严格使用参数绑定或者 METADATA 字段值限定，防止 SQL 注入，
禁止字符串拼接 SQL 访问数据库。

4 【强制】用户请求传入的任何参数必须做有效性验证。 说明:忽略参数校验可能导致:

• page size 过大导致内存溢出
• 恶意 order by 导致数据库慢查询  正则输入源串拒绝服务 ReDOS
• 任意重定向
• SQL 注入
• Shell 注入
• 反序列化注入

5 【强制】禁止向 HTML 页面输出未经安全过滤或未正确转义的用户数据。

6 【强制】表单、AJAX 提交必须执行 CSRF 安全过滤。
说明:CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在 CSRF漏洞的应用/网站，攻击者可以事先构造好 URL，只要受害者用户一访问，后台便在用户不知 情情况下对数据库中用户参数进行相应修改。
7 【强制】URL 外部重定向传入的目标地址必须执行白名单过滤。
正例:

try {
    if (com.alibaba.fasttext.sec.url.CheckSafeUrl
       .getDefaultInstance().inWhiteList(targetUrl)){
        response.sendRedirect(targetUrl);
   }
} catch (IOException e) {
    logger.error("Check returnURL error! targetURL=" + targetURL, e);
    throw e;
}

8 【强制】Web 应用必须正确配置 Robots 文件，非 SEO URL 必须配置为禁止爬虫访问。

User-agent: * Disallow: /

9 【强制】在使用平台资源，譬如短信、邮件、电话、下单、支付，必须实现正确的防重放限制，如数量限制、疲劳度控制、验证码校验，避免被滥刷、资损。 说明:如注册时发送验证码到手机，如果没有限制次数和频率，那么可以利用此功能骚扰到其它用户，并造成短信平台资源浪费。

10【推荐】发贴、评论、发送即时消息等用户生成内容的场景必须实现防刷、文本内容违禁词过滤等风控策略。

个人博客： http://www.shengyang.me