文 | 学者学者
各位屏幕前的读者朋友大家早上中午晚上凌晨好，本文是《码出规范》专题的第十四篇，应用分层规范。文中参考阿里巴巴最新发布的《Java开发手册》，结合《springboot2.x独门秘籍》专题中的项目开发进度，学以致用，让你在开发中码出高效，码出质量。本专题所得收入均捐赠公益事情，希望用技术情怀帮助更多的人。
| 注释规约 | 代码格式 |
|---|---|
| 命名风格 | 常量定义 |
| 并发处理 | 集合处理 |
| OOP规约 | 日志规约 |
| 单元测试 | ...更多 |
关于工程结构的规范，一共分为如下三部分：
- 应用分层规范
- 二方库依赖规范
- 服务器规范
本文主要内容是讲解应用分层规范。良好的工程结构，不仅可以增加代码的可维护性，而且对软件的扩展性、健壮性有着非常大的益处。
-
【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于Web 层，也可以直接依赖于 Service 层，依此类推：
• 开放接口层：可直接封装 Service 方法暴露成 RPC 接口；通过 Web 封装成 http 接口；进行网关安 全控制、流量控制等。
• 终端显示层：各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染，JSP 渲染，移动端展示等。
• Web 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
• Service 层：相对具体的业务逻辑服务层。
• Manager 层：通用业务处理层，它有如下特征：
1） 对第三方平台封装的层，预处理返回结果及转化异常信息。
2） 对 Service 层通用能力的下沉，如缓存方案、中间件通用处理。
3） 与 DAO 层交互，对多个 DAO 的组合复用。
• DAO 层：数据访问层，与底层 MySQL、Oracle、Hbase 等进行数据交互。
• 外部接口或第三方平台：包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。
- 【参考】（分层异常处理规约）在 DAO 层，产生的异常类型有很多，无法用细粒度的异常进行 catch，使用 catch(Exception e)方式，并 throw new DAOException(e)，不需要打印日志，因为日志在 Manager/Service 层一定需要捕获并打印到日志文件中去。
如果同台服务器再打日志，浪费性能和存储。在 Service 层出现异常时，必须记录出错日志到磁盘，尽可能带上参数信息，相当于保护案发现场。如果 Manager 层与 Service 同机部署，日志方式与DAO 层处理一致，如果是单独部署，则采用与 Service 一致的处理方式。
Web 层绝不应该继续往上抛异常，因为已经处于顶层，如果意识到这个异常将导致页面无法正常渲染，那么就应该直接跳转到友好错误页面，加上用户容易理解的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。
- 【参考】分层领域模型规约：
• 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 类来传输。
一如既往，期待您的真知灼见…，《码出规范》系列文章以及大厂内部资料将持续更新，如需获取资料或实战案例源码，欢迎点击我的主页呼叫我，乐意为你解决开发中的疑难杂症。
网友评论