Java开发规范-阿里巴巴华山版-下

文章来源阿里巴巴   作者:阿里巴巴   发布时间:2020-06-25   阅读:1235   标签:代码规范

Java开发规范-阿里巴巴华山版

三 单元测试

  1. 【强制】 好的单元测试必须遵守 AIR 原则。

    单元测试在线上运行时,感觉像空气( AIR)一样并不存在,但在测试质量的保障上,却是非常关
    键的。好的单元测试宏观上来说,具有自动化、独立性、可重复执行的特点。

    ⚫ A: Automatic(自动化)
    ⚫ I: Independent(独立性)
    ⚫ R: Repeatable(可重复)

  2. 【强制】 单元测试应该是全自动执行的,并且非交互式的。测试用例通常是被定期执行的,执行过程必须完全自动化才有意义。输出结果需要人工检查的测试不是一个好的单元测试。单元测试中不准使用 System.out 来进行人肉验证,必须使用 assert 来验证。

  3. 【强制】 保持单元测试的独立性。为了保证单元测试稳定可靠且便于维护,单元测试用例之间决不能互相调用,也不能依赖执行的先后次序。

    反例: method2 需要依赖 method1 的执行, 将执行结果作为 method2 的输入。

  4. 【强制】 单元测试是可以重复执行的,不能受到外界环境的影响。

    单元测试通常会被放到持续集成中,每次有代码 check in 时单元测试都会被执行。如果单测对外部
    环境(网络、服务、中间件等) 有依赖,容易导致持续集成机制的不可用

  5. 【强制】 对于单元测试,要保证测试粒度足够小,有助于精确定位问题。单测粒度至多是类
    级别,一般是方法级别。

    只有测试粒度小才能在出错时尽快定位到出错位置。单测不负责检查跨类或者跨系统的交互逻辑,
    那是集成测试的领域

  6. 【强制】 核心业务、核心应用、核心模块的增量代码确保单元测试通过。

    说明: 新增代码及时补充单元测试,如果新增代码影响了原有单元测试,请及时修正。

  7. 【强制】 单元测试代码必须写在如下工程目录: src/test/java,不允许写在业务代码目录下。

    说明: 源码编译时会跳过此目录,而单元测试框架默认是扫描此目录。

  8. 【推荐】 单元测试的基本目标:语句覆盖率达到 70%;核心模块的语句覆盖率和分支覆盖率都要达到 100%

    在工程规约的应用分层中提到的 DAO 层, Manager 层,可重用度高的 Service,都应该进行单元测试。

  9. 【推荐】 编写单元测试代码遵守 BCDE 原则,以保证被测试模块的交付质量。

    ⚫ B: Border,边界值测试,包括循环边界、特殊取值、特殊时间点、数据顺序等。
    ⚫ C: Correct,正确的输入,并得到预期的结果。
    ⚫ D: Design,与设计文档相结合,来编写单元测试。
    ⚫ E: Error,强制错误信息输入(如:非法数据、异常流程、业务允许外等),并得到预期的结果。

  10. 【推荐】 对于数据库相关的查询,更新,删除等操作,不能假设数据库里的数据是存在的,或者直接操作数据库把数据插入进去,请使用程序插入或者导入数据的方式来准备数据

  11. 【推荐】 和数据库相关的单元测试,可以设定自动回滚机制,不给数据库造成脏数据。或者对单元测试产生的数据有明确的前后缀标识。

  12. 【推荐】 对于不可测的代码在适当的时机做必要的重构,使代码变得可测,避免为了达到测试要求而书写不规范测试代码。

  13. 【推荐】 对于不可测的代码在适当的时机做必要的重构,使代码变得可测,避免为了达到测试要求而书写不规范测试代码。

  14. 【推荐】 单元测试作为一种质量保障手段,在项目提测前完成单元测试, 不建议项目发布后补充单元测试用例。

  15. 【参考】 为了更方便地进行单元测试,业务代码应避免以下情况:

    ⚫ 构造方法中做的事情过多。
    ⚫ 存在过多的全局变量和静态方法。
    ⚫ 存在过多的外部依赖。
    ⚫ 存在过多的条件语句。
    说明: 多层条件语句建议使用卫语句、策略模式、状态模式等方式重构

  16. 【参考】 不要对单元测试存在如下误解

    ⚫ 那是测试同学干的事情。本文是开发手册,凡是本文内容都是与开发同学强相关的。
    ⚫ 单元测试代码是多余的。 系统的整体功能与各单元部件的测试正常与否是强相关的。
    ⚫ 单元测试代码不需要维护。一年半载后,那么单元测试几乎处于废弃状态。
    ⚫ 单元测试与线上故障没有辩证关系。好的单元测试能够最大限度地规避线上故障。

四 安全规约

  1. 【强制】 隶属于用户个人的页面或者功能必须进行权限控制校验。

    防止没有做水平权限校验就可随意访问、 修改、删除别人的数据,比如查看他人的私信内容、修改
    他人的订单

  2. 【强制】 用户敏感数据禁止直接展示,必须对展示数据进行脱敏。

    中国大陆个人手机号码显示为:137**0969,隐藏中间 4 位,防止隐私泄露

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

  4. 强制】 用户请求传入的任何参数必须做有效性验证。

    说明: 忽略参数校验可能导致:
    ⚫ page size 过大导致内存溢出
    ⚫ 恶意 order by 导致数据库慢查询
    ⚫ 任意重定向
    ⚫ SQL 注入
    ⚫ 反序列化注入
    ⚫ 正则输入源串拒绝服务 ReDoS

    Java 代码用正则来验证客户端的输入,有些正则写法验证普通用户输入没有问题,但是如果攻
    击人员使用的是特殊构造的字符串来验证,有可能导致死循环的结果。

  5. Java 代码用正则来验证客户端的输入,有些正则写法验证普通用户输入没有问题,但是如果攻
    击人员使用的是特殊构造的字符串来验证,有可能导致死循环的结果。

  6. 【强制】 表单、 AJAX 提交必须执行 CSRF 安全验证

    CSRF(Cross-site request forgery)跨站请求伪造是一类常见编程漏洞。对于存在 CSRF 漏洞的应用
    /网站,攻击者可以事先构造好 URL,只要受害者用户一访问,后台便在用户不知情的情况下对数据库中
    用户参数进行相应修改。

  7. 【强制】 在使用平台资源,譬如短信、邮件、电话、下单、支付,必须实现正确的防重放的机制,如数量限制、疲劳度控制、验证码校验,避免被滥刷而导致资损。

    如注册时发送验证码到手机,如果没有限制次数和频率,那么可以利用此功能骚扰到其它用户,并
    造成短信平台资源浪费。

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

五 Mysql数据库

5.1 建表规约

  1. 【强制】 表达是与否概念的字段,必须使用 is_xxx 的方式命名,数据类型是 unsigned tinyint( 1 表示是, 0 表示否)

    说明: 任何字段如果为非负数,必须是 unsigned(无符号的)。
    注意: POJO 类中的任何布尔类型的变量,都不要加 is 前缀,所以,需要在<resultMap>设置从 is_xxx
    到 Xxx 的映射关系。数据库表示是与否的值,使用 tinyint 类型,坚持 is_xxx 的命名方式是为了明确其取
    值含义与取值范围。
    正例: 表达逻辑删除的字段名 is_deleted, 1 表示删除, 0 表示未删除。

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

    MySQL 在 Windows 下不区分大小写,但在 Linux 下默认是区分大小写。因此,数据库名、表名、字段名,都不允许出现任何大写字母,避免节外生枝

  3. 【强制】 表名不使用复数名词。

  4. 【强制】 禁用保留字,如 desc、 range、 match、 delayed 等, 请参考 MySQL 官方保留字

  5. 【强制】 主键索引名为 pk字段名;唯一索引名为 uk字段名; 普通索引名则为 idx_字段名。

  6. 【强制】 小数类型为 decimal,禁止使用 float 和 double。

    说明: 在存储的时候, float 和 double 都存在精度损失的问题,很可能在比较值的时候,得到不正确的
    结果。如果存储的数据范围超过 decimal 的范围,建议将数据拆成整数和小数并分开存储。

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

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

  9. 【强制】 表必备三字段: id, create_time, update_time。

    说明: 其中 id 必为主键,类型为 bigint unsigned、单表时自增、步长为 1。 create_time, update_time
    的类型均为 datetime 类型。

  10. 【推荐】 表的命名最好是遵循“业务名称_表的作用” 。

    正例: alipay_task / force_project / trade_config

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

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

  13. 【推荐】 字段允许适当冗余,以提高查询性能,但必须考虑数据一致。冗余字段应遵循:
    1) 不是频繁修改的字段。
    2) 不是 varchar 超长字段,更不能是 text 字段。
    3) 不是唯一索引的字段。
    正例: 商品类目名称使用频率高,字段长度短,名称基本一不变,可在相关联的表中冗余存储类目名
    称,避免关联

  14. 【推荐】 单表行数超过 500 万行或者单表容量超过 2GB,才推荐进行分库分表。

    说明: 如果预计三年后的数据量根本达不到这个级别,请不要在创建表时就分库分表。

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

5.2 索引规约

  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

  6. 【推荐】 利用覆盖索引来进行查询操作, 避免回表。

    如果一本书需要知道第 11 章是什么标题,会翻开第 11 章对应的那一页吗?目录浏览一下就好,这
    个目录就是起到覆盖索引的作用。

    1. 覆盖索引:索引包含了查询正在查找的所有数据(只有bTree能做到,哈希索引、空间索引和全文索引都不行)

    2. 回表:基于非主键索引的查询需要多扫描一棵索引树。

      1. 将需要的字段放在索引中去。查询的时候就能避免回表。
    3. 聚簇索引(主键索引):保存了索引列和具体的数据:

      优点

      1. 聚簇索引将索引和数据行保存在同一个B-Tree中,查询通过聚簇索引可以直接获取数据,相比非聚簇索引需要第二次查询(非覆盖索引的情况下)效率要高。
      2. 聚簇索引对于范围查询的效率很高,因为其数据是按照大小排列的,

      缺点:

      1. 聚簇索引的更新代价比较高,如果更新了行的聚簇索引列,就需要将数据移动到相应的位置。这可能因为要插入的页已满而导致“页分裂”。
      2. 插入速度严重依赖于插入顺序,按照主键进行插入的速度是加载数据到Innodb中的最快方式。如果不是按照主键插入,最好在加载完成后使用OPTIMIZE TABLE命令重新组织一下表。
      3. 聚簇索引在插入新行和更新主键时,可能导致“页分裂”问题。
      4. 聚簇索引可能导致全表扫描速度变慢,因为可能需要加载物理上相隔较远的页到内存中(需要耗时的磁盘寻道操作)。
    4. 非聚簇索引(二级索引):

      1. InnoDB的的二级索引的叶子节点存放的是KEY字段加主键值。因此,通过二级索引查询首先查到是主键值,然后InnoDB再根据查到的主键值通过主键索引找到相应的数据块。
      2. MyISAM的二级索引叶子节点存放的还是列值与行号的组合,叶子节点中保存的是数据的物理地址。所以可以看出MYISAM的主键索引和二级索引没有任何区别,主键索引仅仅只是一个叫做PRIMARY的唯一、非空的索引,且MYISAM引擎中可以不设主键
  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 列的几乎接近于唯一值,那么只需要单建 i dxa 索引即可。
    说明: 存在非等号和等号混合时,在建索引时,请把等号条件的列前置。如: where c>? and d=? 那么
    即使 c 的区分度更高,也必须把 d 放在索引的最前列, 即索引 idx_d

  10. 【推荐】 防止因字段类型不同造成的隐式转换, 导致索引失效。

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

    1) 宁滥勿缺。 认为一个查询就需要建一个索引。
    2) 宁缺勿滥。 认为索引会消耗空间、 严重拖慢记录的更新以及行的新增速度。
    3) 抵制惟一索引。 认为业务的惟一性一律需要在应用层通过“先查后插” 方式解决。

5.3-SQL语句

  1. 【强制】 不要使用 count(列名)或 count(常量)来替代 count(), count()是 SQL92 定义的
    标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。

    说明: count(*)会统计值为 NULL 的行,而 count(列名)不会统计此列为 NULL 值的行。

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

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

    使用如下方式来避免 sum 的 NPE 问题: SELECT IFNULL(SUM(column), 0) 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. 【强制】 数据订正(特别是删除、 修改记录操作) 时,要先 select,避免出现误删除,确认无误才能执行更新语句。

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

  10. 【参考】 如果有国际化需要,所有的字符存储与表示,均以 utf-8 编码,注意字符统计函数的区别。

    SELECT LENGTH(“轻松工作”); 返回为 12
    SELECT CHARACTER_LENGTH(“轻松工作”); 返回为 4
    如果需要存储表情,那么选择 utf8mb4 来进行存储,注意它与 utf-8 编码的区别。

  11. 【参考】 TRUNCATE TABLE 比 DELETE 速度快,且使用的系统和事务日志资源少,但TRUNCATE 无事务且不. 触发 trigger,有可能造成事故,故不建议在开发代码中使用此语句。

    说明: TRUNCATE TABLE 在功能上与不带 WHERE 子句的 DELETE 语句相同。

    5.4 ORM映射

    1. 【强制】 在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明。

      1)增加查询分析器解析成本。

      2)增减字段容易与 resultMap 配置不一致。

      3)无用字段增加网络消耗,尤其是 text 类型的字段。

    2. 【强制】 POJO 类的布尔属性不能加 is,而数据库字段必须加 is_,要求在 resultMap 中进行
      字段与属性之间的映射

      说明: 参见定义 POJO 类以及数据库字段定义规定,在<resultMap>中增加映射,是必须的。 在
      MyBatis Generator 生成的代码中,需要进行对应的修改。

    3. 【强制】 不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需要定义;反过来,每一个表也必然有一个 POJO 类与之对应。

      说明: 配置映射关系,使字段与 DO 类解耦,方便维护。

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

    5. 【强制】 iBATIS 自带的 queryForList(String statementName,int start,int size)不推荐使用

      其实现方式是在数据库取到 statementName 对应的 SQL 语句的所有记录,再通过 subList 取start,size 的子集合。

    6. 【强制】 不允许直接拿 HashMap 与 Hashtable 作为查询结果集的输出

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

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

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

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

    六-工程结构

    6.1-应用分层

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

      1567497568598

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

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

    • DO( Data Object): 此对象与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
    • DTO( Data Transfer Object):数据传输对象, Service 或 Manager 向外传输的对象。
    • BO( Business Object):业务对象, 由 Service 层输出的封装业务逻辑的对象。
    • AO( Application Object): 应用对象, 在 Web 层与 Service 层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
    • VO( View Object):显示层对象,通常是 Web 向模板渲染引擎层传输的对象。
    • Query:数据查询对象,各层接收上层的查询请求。 注意超过 2 个参数的查询封装,禁止使用 Map 类来传输

6.2-二方库依赖

  1. 【强制】 定义 GAV 遵从以下规则:

    1. GroupID 格式: com.{公司/BU }.业务线 [.子业务线],最多 4 级。

      说明: {公司/BU} 例如: alibaba/taobao/tmall/aliexpress 等 BU 一级;子业务线可选。
      正例: com.taobao.jstorm 或 com.alibaba.dubbo.register

    2. ArtifactID 格式:产品线名-模块名。语义不重复不遗漏,先到中央仓库去查证一下。

      正例: dubbo-client / fastjson-api / jstorm-tool

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

  2. 【强制】 二方库版本号命名方式:主版本号.次版本号.修订号

    1) 主版本号: 产品方向改变, 或者大规模 API 不兼容, 或者架构不兼容升级。
    2) 次版本号: 保持相对兼容性,增加主要功能特性,影响范围极小的 API 不兼容修改。
    3) 修订号: 保持完全兼容性, 修复 BUG、 新增次要功能特性等。

    注意起始版本号必须为: 1.0.0,而不是 0.0.1, 正式发布的类库必须先去中央仓库进行查证,使版
    本号有延续性, 正式版本号不允许覆盖升级。如当前版本: 1.3.3, 那么下一个合理的版本号: 1.3.4 或
    1.4.0 或 2.0.0

  3. 【强制】 线上应用不要依赖 SNAPSHOT 版本( 安全包除外) 。

    说明: 不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建

  4. 【强制】 二方库的新增或升级,保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变,必须明确评估和验证。

    在升级时,进行 dependency:resolve 前后信息比对,如果仲裁结果完全不一致,那么通过dependency:tree 命令,找出差异点,进行<exclude>排除 jar 包。

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

  6. 【强制】 依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。

    说明: 依赖 springframework-core,-context,-beans,它们都是同一个版本,可以定义一个变量来保存
    版本: ${spring.version},定义依赖的时候,引用该版本。

  7. 【强制】 禁止在子项目的 pom 依赖中出现相同的 GroupId,相同的 ArtifactId,但是不同的Version。

    说明: 在本地调试时会使用各子项目指定的版本号,但是合并成一个 war,只能有一个版本号出现在最后的 lib 目录中。 可能出现线下调试是正确的,发布到线上却出故障的问题。

  8. 【推荐】 底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。

  9. 推荐】 所有 pom 文件中的依赖声明放在<dependencies>语句块中,所有版本仲裁放在<dependencyManagement>语句块中。

    说明: <dependencyManagement>里只是声明版本,并不实现引入,因此子项目需要显式的声明依
    赖, version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的<dependencies>里的依赖都会自动引入,并默认被所有的子项目继承。

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

  11. 【参考】 为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:

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

6.3-服务器

  1. 【推荐】 高并发服务器建议调小 TCP 协议的 time_wait 超时时间。

    操作系统默认 240 秒后,才会关闭处于 time_wait 状态的连接,在高并发访问下,服务器端会因为
    处于 time_wait 的连接数太多,可能无法建立新的连接,所以需要在服务器上调小此等待值。
    正例: 在 linux 服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值(秒):
    net.ipv4.tcp_fin_timeout = 30

  2. 【推荐】 调大服务器所支持的最大文件句柄数( File Descrip

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

  3. 【推荐】 给 JVM 环境参数设置-XX:+HeapDumpOnOutOfMemoryError 参数,让 JVM 碰到OOM 场景时输出 dump 信息

    说明: OOM 的发生是有概率的,甚至相隔数月才出现一例,出错时的堆内信息对解决问题非常有帮助

  4. 【推荐】 在线上生产环境, JVM 的 Xms 和 Xmx 设置一样大小的内存容量, 避免在 GC 后调整堆大小带来的压力。

  5. 【参考】 服务器内部重定向使用 forward; 外部重定向地址使用 URL 拼装工具类来生成, 否则会带来 URL 维护不一致的问题和潜在的安全风险。

七-设计规约

  1. 【强制】 存储方案和底层数据结构的设计获得评审一致通过,并沉淀成为文档。

    说明: 有缺陷的底层数据结构容易导致系统风险上升,可扩展性下降,重构成本也会因历史数据迁移和系统平滑过渡而陡然增加,所以,存储方案和数据结构需要认真地进行设计和评审,生产环境提交执行后,需要进行 double check。

    正例: 评审内容包括存储介质选型、表结构设计能否满足技术方案、存取性能和存储空间能否满足业务发展、表或字段之间的辩证关系、字段名称、字段类型、索引等;数据结构变更(如在原有表中新增字段)也需要进行评审通过后上线。

  2. 强制】 在需求分析阶段,如果与系统交互的 User 超过一类并且相关的 User Case 超过 5个,使用用例图来表达更加清晰的结构化需求

  3. 【强制】 如果某个业务对象的状态超过 3 个,使用状态图来表达并且明确状态变化的各个触发条件

    说明: 状态图的核心是对象状态,首先明确对象有多少种状态,然后明确两两状态之间是否存在直接转换关系,再明确触发状态转换的条件是什么。
    正例: 淘宝订单状态有已下单、待付款、已付款、待发货、已发货、已收货等。比如已下单与已收货这两种状态之间是不可能有直接转换关系的。

  4. 【强制】 如果系统中某个功能的调用链路上的涉及对象超过 3 个,使用时序图来表达并且明确各调用环节的输入与输出。

    说明: 时序图反映了一系列对象间的交互与协作关系,清晰立体地反映系统的调用纵深链路。

  5. 【强制】 如果系统中模型类超过 5 个,并且存在复杂的依赖关系,使用类图来表达并且明确类之间的关系。

    说明: 类图像建筑领域的施工图,如果搭平房,可能不需要,但如果建造蚂蚁 Z 空间大楼,肯定需要详细的施工图

  6. 【强制】 如果系统中超过 2 个对象之间存在协作关系,并且需要表示复杂的处理流程,使用活动图来表示。

    说明: 活动图是流程图的扩展,增加了能够体现协作关系的对象泳道,支持表示并发等。

  7. 【推荐】 需求分析与系统设计在考虑主干功能的同时,需要充分评估异常流程与业务边界。

    反例: 用户在淘宝付款过程中,银行扣款成功,发送给用户扣款成功短信,但是支付宝入款时由于断网演练产生异常,淘宝订单页面依然显示未付款,导致用户投诉。

  8. 【推荐】 类在设计与实现时要符合单一原则。

    说明: 单一原则最易理解却是最难实现的一条规则,随着系统演进,很多时候,忘记了类设计的初衷。

  9. 【推荐】 谨慎使用继承的方式来进行扩展,优先使用聚合/组合的方式来实现。

    不得已使用继承的话,必须符合里氏代换原则,此原则说父类能够出现的地方子类一定能够出现,比如, “把钱交出来” ,钱的子类美元、欧元、人民币等都可以出现。

  10. 【推荐】 系统设计时,根据依赖倒置原则,尽量依赖抽象类与接口,有利于扩展与维护。

    说明: 低层次模块依赖于高层次模块的抽象,方便系统间的解耦。

  11. 【推荐】 系统设计时,注意对扩展开放,对修改闭合。

    说明: 极端情况下,交付线上生产环境的代码都是不可修改的,同一业务域内的需求变化,通过模块或类的扩展来实现。

  12. 【推荐】 系统设计阶段,共性业务或公共行为抽取出来公共模块、公共配置、公共类、公共方法等, 避免出现重复代码或重复配置的情况。

    说明: 随着代码的重复次数不断增加,维护成本指数级上升。

  13. 【推荐】 避免如下误解: 敏捷开发 = 讲故事 + 编码 + 发布。

    说明: 敏捷开发是快速交付迭代可用的系统,省略多余的设计方案,摒弃传统的审批流程,但核心关键点上的必要设计和文档沉淀是需要的。

  14. 【参考】 系统设计主要目的是明确需求、理顺逻辑、后期维护,次要目的用于指导编码。

    说明: 避免为了设计而设计,系统设计文档有助于后期的系统维护和重构,所以设计结果需要进行分类归档保

  15. 【参考】 设计的本质就是识别和表达系统难点, 找到系统的变化点,并隔离变化点。

    说明: 世间众多设计模式目的是相同的, 即隔离系统变化点。

  16. 【参考】 系统架构设计的目的:

    1. 定系统边界。确定系统在技术层面上的做与不做
    2. 确定系统内模块之间的关系。确定模块之间的依赖关系及模块的宏观输入与输出。
    3. 确定指导后续设计与演化的原则。使后续的子系统或模块设计在规定的框架内继续演化。
    4. 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等
  17. 确定非功能性需求。非功能性需求是指安全性、可用性、可扩展性等

    1. 所有可交互的控件元素必须能被 tab 键聚焦,并且焦点顺序需符合自然操作逻辑
    2. 用于登陆校验和请求拦截的验证码均需提供图形验证以外的其它方式
    3. 自定义的控件类型需明确交互方式

发表评论

目录