阿里巴巴 Java 开发手册 (12)


1. 【推荐】图中默认上层依赖于下层,箭头关系表示可直接依赖,如:开放接口层可以依赖于Web层,也可以直接依赖于Service层,依此类推:
. 开放接口层:可直接封装Service接口暴露成RPC接口;通过Web封装成http接口;网关控制层等。
. 终端显示层:各个端的模板渲染并执行显示层。当前主要是velocity渲染,JS渲染,JSP渲染,移动端展示层等。
. Web层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。
. Service层:相对具体的业务逻辑服务层。
. Manager层:通用业务处理层,它有如下特征: 1) 对第三方平台封装的层,预处理返回结果及转化异常信息; 2) 对Service层通用能力的下沉,如缓存方案、中间件通用处理; 3) 与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层输出的封装业务逻辑的对象。
. QUERY:数据查询对象,各层接收上层的查询请求。注:超过2个参数的查询封装,禁止使用Map类来传输。
. VO(View Object):显示层对象,通常是Web向模板渲染引擎层传输的对象。

(二) 二方库规约


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) 次版本号:当做了向下兼容的功能性新增(新增类、接口等)。 3) 修订号:修复bug,没有修改方法签名的功能加强,保持 API 兼容性。 说明: 起始版本号 必须 为: 1.0.0,而不是 0.0.1
3. 【强制】线上应用不要依赖SNAPSHOT版本(安全包除外);正式发布的类库必须使用RELEASE版本号升级+1的方式,且版本号不允许覆盖升级,必 须去中央仓库进行查证。 说明:不依赖SNAPSHOT版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。
4. 【强制】二方库的新增或升级,保持除功能点之外的其它jar包仲裁结果不变。如果有改变,必须明确评估和验证,建议进行 dependency:resolve前后信息比对,如果仲裁结果完全不一致,那么通过dependency:tree命令,找出差异点,进 行<excludes>排除jar包。
5. 【强制】二方库里可以定义枚举类型,参数可以使用枚举类型,但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
6. 【强制】依赖于一个二方库群时,必须定义一个统一版本变量,避免版本号不一致。 说明:依赖springframework-core,-context,-beans,它们都是同一个版本,可以定义一个变量来保存版 本:${spring.version},定义依赖的时候,引用该版本。
7. 【强制】禁止在子项目的pom依赖中出现相同的GroupId,相同的ArtifactId,但是不同的Version。 说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个war,只能有一个版本号出现在最后的lib目录中。曾经出现过线下调试是正确的,发布到 线上出故障的先例。
8. 【推荐】所有pom文件中的依赖声明放在<dependencies>语句块中,所有版本仲裁放 在<dependencyManagement>语句块中。 说明:<dependencyManagement>里只是声明版本,并不实现引入,因此子项目需要显式的声明依赖,version和 scope都读取自父pom。而<dependencies>所有声明在主pom的<dependencies>里的依赖都会自 动引入,并默认被所有的子项目继承。
9. 【推荐】二方库尽量不要有配置项,最低限度不要再增加配置项。
10. 【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则: 1)精简可控原则。移除一切不必要的API和依赖,只包含 Service API、必要的领域模型对象、Utils类、常量、枚举等。如果依赖其它二方库,尽量是provided引入,让二方库使用者去依赖具体版本号;无log 具体实现,只依赖日志框架。 2)稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生 变化。

(三) 服务器规约

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/zwxzdx.html