学习阿里巴巴开发手册-15

工程规约

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向模板渲染引擎层传输的对象。

二方库规约

定义 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：详细规定参考下方

二方库版本号命名方式：主版本号.次版本号.修订号

1） 主版本号：当做了不兼容的 API修改，或者增加了能改变产品方向的新功能。

2） 次版本号：当做了向下兼容的功能性新增（新增类、接口等）。

3） 修订号：修复 bug，没有修改方法签名的功能加强，保持 API 兼容性。

注意起始版本号必须为：1.0.0，而不是0.0.1，正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级

4.线上应用不要依赖 SNAPSHOT版本（安全包除外）；正式发布的类库必须使用 RELEASE版本号升级+1的方式，且版本号不允许覆盖升级，必须去中央仓库进行查证。

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

5.二方库的新增或升级，保持除功能点之外的其它 jar包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行 dependency:resolve前后信息比对，

  如果仲裁结果完全不一致，那么通过 dependency:tree命令，找出差异点，进行<excludes>排除 jar包。