阿⾥代码规范pdf_看完阿⾥的代码规范,⽴马学会代码分层,
再也不会被同事怼...
代码规范重要吗?很重要很重要,整洁的代码能让你和同事都⼼旷神怡,也能让你在离职的时候不会被骂.....今天就来讲讲优秀IT⼈的代码都是如何分层的。
⼀、背景
说起应⽤分层,⼤部分⼈都会认为这个不是很简单嘛 就controller,service, mapper三层。
看起来简单,很多⼈其实并没有把他们职责划分开,在很多代码中,controller做的逻辑⽐service还多,service往往当成透传了,这其实是很多⼈开发代码都没有注意到的地⽅,反正功能也能⽤,⾄于放哪⽆所谓呗。这样往往造成后⾯代码⽆法复⽤,层级关系混乱,对后续代码的维护⾮常⿇烦。
的确在这些⼈眼中分层只是⼀个形式,前辈们的代码这么写的,其他项⽬代码这么写的,那么我也这么跟着写。
但是在真正的团队开发中每个⼈的习惯都不同,写出来的代码必然带着⾃⼰的标签,有的⼈习惯controller写⼤量的业务逻辑,有的⼈习惯在service中之间调⽤远程服务,这样就导致了每个⼈的开发代码风格完全不同。
后续其他⼈修改的时候,⼀看,我靠这个⼈写的代码和我平常的习惯完全不同,修改的时候到底是按着⾃⼰以前的习惯改,还是跟着前辈们⾛,这⼜是个艰难的选择,选择⼀旦有偏差,你后来的同事⼜维护你的代码的时候,恐怕就要怼⼈了。
所以⼀个好的应⽤分层需要具备以下⼏点:
⽅便后续代码进⾏维护扩展;
分层的效果需要让整个团队都接受;
各个层职责边界清晰
⼆、如何进⾏分层
2.1、阿⾥规范
在阿⾥的编码规范中约束的分层如下:
开放接⼝层:可直接封装 Service ⽅法暴露成 RPC 接⼝;通过 Web 封装成 http 接⼝;进⾏ ⽹关安全控制、流量控制等。
终端显⽰层:各个端的模板渲染并执⾏显⽰的层。当前主要是 velocity 渲染,JS 渲染, JSP 渲染,移动端展⽰等。
Web 层:主要是对访问控制进⾏转发,各类基本参数校验,或者不复⽤的业务简单处理等。
Service 层:相对具体的业务逻辑服务层。
Manager 层:通⽤业务处理层,它有如下特征:
1. 对第三⽅平台封装的层,预处理返回结果及转化异常信息;
2. 对Service层通⽤能⼒的下沉,如缓存⽅案、中间件通⽤处理;
3. 与DAO层交互,对多个DAO的组合复⽤。
DAO 层:数据访问层,与底层 MySQL、Oracle、Hbase 进⾏数据交互。
阿⾥巴巴规约中的分层⽐较清晰简单明了,但是描述得还是过于简单了,以及service层和manager层
有很多同学还是有点分不清楚之间的关系,就导致了很多项⽬中根本没有Manager层的存在。下⾯介绍⼀下具体业务中应该如何实现分层。thrift
2.2、优化分层
从我们的业务开发中总结了⼀个较为的理想模型,这⾥要先说明⼀下由于我们的rpc框架选⽤的是thrift可能会⽐其他的⼀些rpc框架例如dubbo会多出⼀层,作⽤和controller层类似:
最上层controller和TService是阿⾥分层规范⾥⾯的第⼀层:轻业务逻辑,参数校验,异常兜底。通常这种接⼝可以轻易更换接⼝类型,所以业务逻辑必须要轻,甚⾄不做具体逻辑。
Service:业务层,复⽤性较低,这⾥推荐每⼀个controller⽅法都得对应⼀个service,不要把业务编排放在controller中去做,为什么呢?如果我们把业务编排放在controller层去做的话,如果以后我们要接⼊thrift,我们这⾥⼜需要把业务编排在做⼀次,这样会导致我们每接⼊⼀个⼊⼝层这个代码都得重新复制⼀份如下图所⽰:
这样⼤量的重复⼯作必定会导致我们开发效率下降,所以我们需要把业务编排逻辑都得放进service中去做:
Mannager:可复⽤逻辑层。这⾥的Mannager可以是单个服务的,⽐如我们的cache,mq等等,当然也可以是复合的,当你需要调⽤多个Mannager的时候,这个可以合为⼀个Mannager,⽐如逻辑上的连表查询等。如果是httpMannager或rpcMannager需要在这⼀层做⼀些数据转换
DAO:数据库访问层。主要负责“操作数据库的某张表,映射到某个java对象”,dao应该只允许⾃⼰的Service访问,其他Service要访问我的数据必须通过对应的Service。
三、分层领域模型的转换
在阿⾥巴巴编码规约中列举了下⾯⼏个领域模型规约:
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类来传输。
每⼀个层基本都⾃⼰对应的领域模型,这样就导致了有些⼈过于追求每⼀层都是⽤⾃⼰的领域模型,这样就导致了⼀个对象可能会出现3次甚⾄4次转换在⼀次请求中,当返回的时候同样也会出现3-4次转换,这样有可能⼀次完整的请求-返回会出现很多次对象转换。如果在开发中真的按照这么来,恐怕就别写其他的了,⼀天就光写这个重复⽆⽤的逻辑算了吧。
所以我们得采取⼀个折中的⽅案:
1、允许Service/Manager可以操作数据领域模型,对于这个层级来说,本来⾃⼰做的⼯作也是做的是业务逻辑处理和数据组装。
2、Controller/TService层的领域模型不允许传⼊DAO层,这样就不符合职责划分了。
3、同理,不允许DAO层的数据传⼊到Controller/TService。
四、总结
总的来说业务分层对于代码规范是⽐较重要,决定着以后的代码是否可复⽤,是否职责清晰,边界清晰。
当然这种分层其实见仁见智, 团队中的所有⼈的分层习惯也不同,所以很难权衡出⼀个标准的准则,总的来说只要满⾜职责逻辑清晰,后续维护容易,就是好的分层。
最后,如果你的团队有更好的分层,或者上⾯所描述的有什么错误的地⽅还请评论指正⼀下。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论