四、工程规约

四、工程规约

1、应用分层

推荐部分

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

image-20240908191532327

  • 开放接口层：可直接封装Service接口暴露成RPC接口；通过Web封装成http接口；网关控制层等。

  • 终端显示层：各个端的模板渲染并执行显示层。当前主要是velocity渲染，JS渲染，JSP渲 染，移动端展示层等。

  • Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。

  • Service 层：相对具体的业务逻辑服务层。

  • Manager 层：通用业务处理层，它有如下特征：

    ​ 1） 对第三方平台封装的层，预处理返回结果及转化异常信息；

    ​ 2） 对Service层通用能力的下沉，如缓存方案、中间件通用处理；

    ​ 3） 与DAO层交互，对DAO的业务通用能力的封装。

  • DAO层：数据访问层，与底层Mysql、Oracle、Hbase、OB进行数据交互。

  • 外部接口或第三方平台：包括其它部门RPC开放接口，基础平台，其它公司的HTTP接口。

参考部分

1、（分层异常处理规约）在DAO层，产生的异常类型有很多，无法用细粒度异常进行 catch，使用catch(Exceptione)方式，并 throw new DaoException(e)，不需要打印日志， 因为日志在Manager/Service层一定需要捕获并打到日志文件中去，如果同台服务器再打日志，浪费性能和存储。在Service层出现异常时，必须记录日志信息到磁盘，尽可能带上参数信息， 相当于保护案发现场。如果Manager层与Service同机部署，日志方式与DAO层处理一致，如果是单独部署，则采用与Service一致的处理方式。Web层绝不应该继续往上抛异常，因为已经处于顶层，无继续处理异常的方式，如果意识到这个异常将导致页面无法正常渲染，那么就 应该直接跳转到友好错误页面，尽量加上友好的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。

✨2、分层领域模型规约：

  • DO（Data Object）：与数据库表结构一一对应，通过DAO层向上传输数据源对象。
  • DTO（Data Transfer Object）：数据传输对象，Service和Manager向外传输的对象。
  • BO（Business Object）：业务对象。可以由Service层输出的封装业务逻辑的对象。
  • QUERY：数据查询对象，各层接收上层的查询请求。注：超过2个参数的查询封装，禁止使用Map类来传输。
  • VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
  • PO（Persistent Object）：持久化对象，PO的主要作用是实现数据库记录的持久化，即将数据库记录映射为Java对象，以便在程序中操作。

🎃2、二方库规约

强制部分

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目录中。曾经出现过线下调试是正确的，发布到线上出故障的先例。

推荐部分

1、工具类二方库已经提供的，尽量不要在本应用中编程实现。

  • 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的特性是不 支持的，例如：泛型。

2、所有pom文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在<dependencyManagement>语句块中。

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

3、二方库尽量不要有配置项，最低限度不要再增加配置项。

参考部分

1、为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：

​ 1）精简可控原则。移除一切不必要的API和依赖，只包含 Service API、必要的领域模型对 象、Utils类、常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无log具体实现，只依赖日志框架。

​ 2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能 方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

3、服务器规约

推荐部分

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维护不一致的问题。