阿里巴巴开发手册六

六、工程结构

（一）应用分层

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

  • 开放接口层:可直接封装 Service 方法暴露成 RPC 接口;通过 Web 封装成 http 接口;进行 网关安全控制、流量控制等。
  • 终端显示层:各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染， JSP 渲染，移动端展示等。
  • Web 层:主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
  • Service 层:相对具体的业务逻辑服务层。
  • Manager 层:通用业务处理层，它有如下特征:
    • 对第三方平台封装的层，预处理返回结果及转化异常信息;
    • 对Service层通用能力的下沉，如缓存方案、中间件通用处理;
    • 与DAO层交互，对多个DAO的组合复用。
  • DAO 层:数据访问层，与底层 MySQL、Oracle、Hbase 等进行数据交互。
  • 外部接口或第三方平台:包括其它部门 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 层输出的封装业务逻辑的对象。
  • AO(Application Object): 应用对象。在 Web 层与 Service 层之间抽象的复用对象模型， 极为贴近展示层，复用度不高。
  • VO(View Object): 显示层对象，通常是 Web 向模板渲染引擎层传输的对象。
  • Query: 数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。

（二）二方库依赖

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

  • GroupID格式:com.{公司/BU }.业务线.[子业务线]，最多4级。
  • ArtifactID格式:产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
  • Version:详细规定参考下方。

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

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

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

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

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

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

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

8、【推荐】所有 pom 文件中的依赖声明放在语句块中，所有版本仲裁放在 语句块中。

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

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

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

（三）服务器

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

2、【推荐】调大服务器所支持的最大文件句柄数(File Descriptor，简写为fd)。

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

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

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

附1：本手册专有名词

  1. POJO(Plain Ordinary Java Object): 在本手册中，POJO 专指只有 setter / getter / toString 的简单类，包括 DO/DTO/BO/VO 等。
  2. GAV(GroupId、ArtifactctId、Version): Maven 坐标，是用来唯一标识 jar 包。
  3. OOP(Object Oriented Programming): 本手册泛指类、对象的编程处理方式。
  4. ORM(Object Relation Mapping): 对象关系映射，对象领域模型与底层数据之间的转换， 本文泛指 iBATIS, mybatis 等框架。
  5. NPE(java.lang.NullPointerException): 空指针异常。
  6. SOA(Service-Oriented Architecture): 面向服务架构，它可以根据需求通过网络对松散耦合的粗粒度应用组件进行分布式部署、组合和使用，有利于 升组件可重用性，可维护性。
  7. 一方库: 本工程内部子项目模块依赖的库(jar 包)。
  8. 二方库: 公司内部发布到中央仓库，可供公司内部其它应用依赖的库(jar 包)。
  9. 三方库: 公司之外的开源库(jar 包)。 10.IDE(Integrated Development Environment): 用于 供程序开发环境的应用程序，一 般包括代码编辑器、编译器、调试器和图形用户界面等工具，本《手册》泛指 IntelliJ IDEA 和 eclipse。
posted @ 2019-10-29 10:29  清华大咖  阅读(384)  评论(0)  编辑  收藏  举报