孤尽班第8天笔记 -- 工程结构规约

工程为什么要分层？

分层了才能实现扩展，让更多的人一起来干。每层都能够有专人负责维护。

所以，分层可增强工程的可扩展性和可维护性。

计算机领域的任何问题都可以通过增加一个中间层解决。

个人感觉增加中间层确实是一个解决办法，但是不能滥用。

MVC框架模式

Model: 数据和业务逻辑

View: 与用户交互的部分，如jsp，html页面，模板渲染引擎等

Controller：dispatcher和servlet

分层异常处理

DAO层：异常类型很多，不需要打印日志。

Manager/Service层：必须记录出错日志到磁盘，尽可能带上参数信息，保护案发现场。

Web层：绝不能往上抛异常，应跳转到友好错误页面，友好的错误提示信息。

开放接口层：将异常处理成错误码和错误信息方式返回。

分层模型

DO(Data Object)：此对象与数据库表结构一一对应，通过DAO层向上传输数据源对象。

DTO(Data Transfer Object)：数据传输对象，Service或Manager向外传输的对象。需要涉及序列化和发序列化。

BO(Business Object)：业务对象，可以由Service层输出的封装业务逻辑的对象。不需要涉及序列化和反序列化。

Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。这是为了保证参数的字段名称的正确。

VO (View Object)：显示层对象，通常是Web向模板渲染引擎层传输的对象。

Maven

主要功能

1. 依赖管理

工程的坐标：G(groupId), A(artifactId), V(version)

Maven的依赖仲裁

• 按照DependencyManager版本声明进行仲裁
• 如无仲裁声明，则按照依赖最短路径确定版本。
• 若相同路径，则按照第一声明优先原则。

2. 规范目录结构

3. 完整的项目构建阶段

4. 支持多种插件

二方库依赖

什么是二方库

一方库：本工程中的各模块的相互依赖

二方库：公司内部的依赖库，一般指公司内部的其他项目发布的jar包

三方库：公司之外的开源库，比如apache、Google、alibaba等发布的依赖

二方库GroupID、ArtifactID的定义

GroupID

格式：com.{公司/BU}.业务线[.子业务线]，最多4级。

说明：{公司/BU}例如：alibaba/taobao/tmall/aliexpress等BU一级；子业务线可选。

正例：com.taobao.jstorm或者com.alibaba.dubbo.register

ArtifactID

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

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

二方库中Version的命名方式

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

主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级

次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改

修订号：保持完全兼容性，修复BUG、新增次要功能特性等

版本号应该从1.0.0开始。

二方库引用规约

1. 线上应用不要依赖SNAPSHOT版本

2. 正式发布的类库必须去中央仓库查证，使RELEASE版本号有延续性 

3. 正式发布的类库版本号不允许覆盖升级

4. 二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变（说明：在升级时，进行dependency:resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行<exclude>排除jar包。）

5. 二方库里定义的枚举类型，参数中可以使用，但返回值不允许使用

6. 依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致

7. 禁止在依赖中出现相同的GroupID，相同的ArtifactID，但是不同的Version（说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。曾经出现过线下调试是正确的，发布到线上却出故障的先例。）

二方库引用建议

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

2. 所有版本仲裁使用<dependencyManagement>语句块

3. 二方库不要有配置项

4. 不要使用不稳定的工具包或者Utils类

二方库发布原则

• 精简可控原则移除不必要的API和依赖
• 只包含Service API、以及必要的工具类
• 如果依赖其它二方库，尽量provided引入
• 无log具体实现，只依赖日志框架

maven依赖的作用域参考此篇：

Maven Dependency Scopes | BaeldungA quick and practical guide to dependency scopes in Maven.https://www.baeldung.com/maven-dependency-scopes稳定可追溯原则

• 记录每个版本的变化
• 二方库维护者
• 源码的位置
• 公共二方库的行为不变