代码规范在企业中其实非常重要,每个人的编码习惯和风格都不一样,软件行业人员流动非常很频繁,一段好的代码,令人赏心悦目,一段糟糕的代码让人不能直视。
工作过很多年,没有规范,只能让代码越写越乱,业务越高越复杂,最后你可能只是修改了一个非常小的功能,牵一发而动全身,最后的接口代码到后来修改的成本越来越高,很容易出现Px级别的生产故障。然后各种复盘追责,最后的结果当然不会太好。
代码分层
阿里巴巴编码规约中代码分层的规范
开放 API 层:可直接封装 Service 接口暴露成 RPC 接口;通过 Web 封装成 http 接口;网关控制层等。 比如有些以jar包形式提供的RPC接口,可以封装一些对外请求的出参和入参或者一些对外枚举等等。
终端显示层: 各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染,JS 渲染,JSP 渲染,移动端展示等。 目前很多项目都是前后端分离,主要前端同学一些静态资源页面等等。
Web 层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。
Service 层:相对具体的业务逻辑服务层。
Manager 层:通用业务处理层,它有如下特征: 1) 对第三方平台封装的层,预处理返回结果及转化异常信息,适配上层接口。 2) 对 Service 层通用能力的下沉,如缓存方案、中间件通用处理。 3) 与 DAO 层交互,对多个 DAO 的组合复用。
DAO 层:数据访问层,与底层 MySQL、Oracle、Hbase、OB 等进行数据交互。
第三方服务:包括其它部门 RPC 服务接口,基础平台,其它公司的 HTTP 接口,如淘宝开放平台、支 付宝付款服务、高德地图服务等。
外部数据接口:外部(应用)数据存储服务提供的接口,多见于数据迁移场景中。
分层领域模型规约
DO(Data Object):此对象与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
DTO(Data Transfer Object):数据传输对象,Service 或 Manager 向外传输的对象。
BO(Business Object):业务对象,可以由 Service 层输出的封装业务逻辑的对象。
Query:数据查询对象,各层接收上层的查询请求。注意超过 2 个参数的查询封装,禁止使用 Map 类 来传输。
VO(View Object):显示层对象,通常是 Web 向模板渲染引擎层传输的对象。
结合领域驱动设计我们可以画一下我们的一些的最佳实践
区分web应用还是RPC接口,外部对外直接是web层controller服务,RPC服务对外提供jar包依赖,加一个facade门面模式,做一些简单的参数校验
业务聚合层BO, 具体业务逻辑的封装
数据持久化层DAO, CACHE等等
第三方接口重新封装转换参数
领域服务