0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

优秀的代码都是如何分层的?看了直呼NB!

jf_ro2CN3Fa 来源:芋道源码 2023-06-09 14:39 次阅读

1.背景

说起应用分层,大部分人都会认为这个不是很简单嘛 就controller,service, mapper三层。看起来简单,很多人其实并没有把他们职责划分开,在很多代码中,controller做的逻辑比service还多,service往往当成透传了,这其实是很多人开发代码都没有注意到的地方,反正功能也能用,至于放哪无所谓呗。这样往往造成后面代码无法复用,层级关系混乱,对后续代码的维护非常麻烦。

的确在这些人眼中分层只是一个形式,前辈们的代码这么写的,其他项目代码这么写的,那么我也这么跟着写。但是在真正的团队开发中每个人的习惯都不同,写出来的代码必然带着自己的标签,有的人习惯controller写大量的业务逻辑,有的人习惯在service中之间调用远程服务,这样就导致了每个人的开发代码风格完全不同,后续其他人修改的时候,一看,我靠这个人写的代码和我平常的习惯完全不同,修改的时候到底是按着自己以前的习惯改,还是跟着前辈们走,这又是个艰难的选择,选择一旦有偏差,你的后辈又维护你的代码的时候,恐怕就要骂人了。

所以一个好的应用分层需要具备以下几点:

方便后续代码进行维护扩展。

分层的效果需要让整个团队都接受

各个层职责边界清晰

基于 Spring Boot + MyBatis Plus + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

项目地址:https://github.com/YunaiV/ruoyi-vue-pro

视频教程:https://doc.iocoder.cn/video/

2.如何进行分层

2.1阿里规范

在阿里的编码规范中约束的分层如下:

35275a80-068c-11ee-962d-dac502259ad0.jpg

开放接口层:可直接封装 Service 方法暴露成 RPC 接口;通过 Web 封装成 http 接口;进行 网关安全控制、流量控制等。

终端显示层:各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染,JS 渲染, JSP 渲染,移动端展示等。

Web 层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。

Service 层:相对具体的业务逻辑服务层。

Manager 层:通用业务处理层,它有如下特征:1. 对第三方平台封装的层,预处理返回结果及转化异常信息;2. 对Service层通用能力的下沉,如缓存方案、中间件通用处理;3. 与DAO层交互,对多个DAO的组合复用。

DAO 层:数据访问层,与底层 MySQL、Oracle、Hbase 进行数据交互。

阿里巴巴规约中的分层比较清晰简单明了,但是描述得还是过于简单了,以及service层和manager层有很多同学还是有点分不清楚之间的关系,就导致了很多项目中根本没有Manager层的存在。下面介绍一下具体业务中应该如何实现分层

2.2优化分层

从我们的业务开发中总结了一个较为的理想模型,这里要先说明一下由于我们的rpc框架选用的是thrift可能会比其他的一些rpc框架例如dubbo会多出一层,作用和controller层类似

352fb702-068c-11ee-962d-dac502259ad0.jpg

1.最上层controller和TService是我们阿里分层规范里面的第一层:轻业务逻辑,参数校验,异常兜底。通常这种接口可以轻易更换接口类型,所以业务逻辑必须要轻,甚至不做具体逻辑。

2.Service:业务层,复用性较低,这里推荐每一个controller方法都得对应一个service,不要把业务编排放在controller中去做,为什么呢?如果我们把业务编排放在controller层去做的话,如果以后我们要接入thrift,我们这里又需要把业务编排在做一次,这样会导致我们每接入一个入口层这个代码都得重新复制一份如下图所示:

353c7492-068c-11ee-962d-dac502259ad0.jpg

这样大量的重复工作必定会导致我们开发效率下降,所以我们需要把业务编排逻辑都得放进service中去做:

3554a3be-068c-11ee-962d-dac502259ad0.jpg

3.Mannager:可复用逻辑层。这里的Mannager可以是单个服务的,比如我们的cache,mq等等,当然也可以是复合的,当你需要调用多个Mannager的时候,这个可以合为一个Mannager,比如逻辑上的连表查询等。如果是httpMannager或rpcMannager需要在这一层做一些数据转换

4.DAO:数据库访问层。主要负责“操作数据库的某张表,映射到某个java对象”,dao应该只允许自己的Service访问,其他Service要访问我的数据必须通过对应的Service。

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 实现的后台管理系统 + 用户小程序,支持 RBAC 动态权限、多租户、数据权限、工作流、三方登录、支付、短信、商城等功能

项目地址:https://github.com/YunaiV/yudao-cloud

视频教程:https://doc.iocoder.cn/video/

3.分层领域模型的转换

在阿里巴巴编码规约中列举了下面几个领域模型规约:

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类来传输。

层次 领域模型
Controller/TService VO/DTO
Service/Manager AO/BO
DAO DO

每一个层基本都自己对应的领域模型,这样就导致了有些人过于追求每一层都是用自己的领域模型,这样就导致了一个对象可能会出现3次甚至4次转换在一次请求中,当返回的时候同样也会出现3-4次转换,这样有可能一次完整的请求-返回会出现很多次对象转换。如果在开发中真的按照这么来,恐怕就别写其他的了,一天就光写这个重复无用的逻辑算了吧。

所以我们得采取一个折中的方案:

1.允许Service/Manager可以操作数据领域模型,对于这个层级来说,本来自己做的工作也是做的是业务逻辑处理和数据组装。

2.Controller/TService层的领域模型不允许传入DAO层,这样就不符合职责划分了。

3.同理,不允许DAO层的数据传入到Controller/TService.

356a162c-068c-11ee-962d-dac502259ad0.jpg

4.总结

总的来说业务分层对于代码规范是比较重要,决定着以后的代码是否可复用,是否职责清晰,边界清晰。

当然这种分层其实见仁见智, 团队中的所有人的分层习惯也不同,所以很难权衡出一个标准的准则,总的来说只要满足职责逻辑清晰,后续维护容易,就是好的分层。

最后,如果你的团队有更好的分层,或者上面所描述的有什么错误的地方还请留言指正一下。

声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 编码
    +关注

    关注

    6

    文章

    836

    浏览量

    54531
  • 代码
    +关注

    关注

    30

    文章

    4596

    浏览量

    67327

原文标题:优秀的代码都是如何分层的?看了直呼NB!

文章出处:【微信号:芋道源码,微信公众号:芋道源码】欢迎添加关注!文章转载请注明出处。

收藏 人收藏

    评论

    相关推荐

    聊一聊MCU的软件分层

    在功能实现上这段代码没有问题。但如果硬件做变动呢?例如更换为其它品牌的mcu或者IO口更改呢?while(1)里面的代码是不是都要发生变动呢?不同的mcu底层库是有区别的。换一个MCU要通篇改动代码非常恶心!工作量也巨大!非常有
    发表于 07-07 14:43 720次阅读
    聊一聊MCU的软件<b class='flag-5'>分层</b>

    请问LWIP使用标准的socket开发代码都是无操作系统下的代码

    ,bind,等函数,但是当写了代码,我看了下,有个NO_SYS 定义成1了,即使我改成其他0,又有其他错误。我看了下web_server,像什么tcp_recv都是注册成回调函数,请问
    发表于 09-16 06:51

    给嵌入式代码也来个分层

    给嵌入式代码也来个分层 一、遇到的问题代码结构也会有缺陷:(1)开发效率低:每次使用片内的某一资源(例如定时器等),笔者都要去查询CC2430中文手册,比较eggache~(2)代码
    发表于 03-23 13:54

    MCU级软件有必要分层

    一、MCU级软件有必要分层吗?1.1 如果不分层会怎样?看下面这段示例代码void main(){sys_init()while(1){ //用PA1控制LED亮灭GPIO_SetBits
    发表于 11-03 08:57

    ModBus主机底层的分层和软件层面的任务调度

    开始本篇之前我想先谈一下为什么要把一个ModBus主机分成4篇来写,一是代码分层理念,随着工作时间的增长以及工作的深入你会发现分层是那么的至关重要不仅仅是代码的可读性更重要的是更方便
    发表于 03-01 07:29

    【学习打卡】OpenHarmony的开源以及分层介绍

    例子,就像买房一样,有些人买的是毛坯房,有些人买的是精装修的房子,开源软件更像是毛坯房,你买回来之后可以根据自己的需要进行改装,但是房子本身的水电都是齐全的。所谓的软件分层中的层指的是代码中的逻辑分隔
    发表于 07-11 17:36

    中科创达现场展出NB-IoT解决方案及其优秀的应用案例

    12月21日,中科创达携Thundersoft TurboX® NB-IoT解决方案及其优秀的应用案例亮相ELEXCON深圳国际电子展暨嵌入式系统展。
    的头像 发表于 12-29 09:36 5442次阅读

    浅谈Java Web项目代码如何分层

    在软件体系架构设计中,分层式结构是最常见,也是最重要的一种结构。微软推荐的分层式结构一般分为三层,从下至上分别为:数据访问层、业务逻辑层(又或称为领域层)、表示层。这也是Java Web中重要的三层架构中的三个层次。区分层次的目
    发表于 05-11 10:23 3688次阅读
    浅谈Java Web项目<b class='flag-5'>代码</b>如何<b class='flag-5'>分层</b>

    通信技术NB-IoT为什么可以这么优秀?

    本文主要介绍了NB-IoT的行业应用以及为什么NB-IoT这么优秀的原因?
    的头像 发表于 09-24 09:34 6265次阅读
    通信技术<b class='flag-5'>NB</b>-IoT为什么可以这么<b class='flag-5'>优秀</b>?

    都是通信技术,NB-IoT为什么可以这么优秀

    景、NB-IoT技术优势以及NB-IoT技术是否能解决该应用场景的一些难点。抛开成本问题不谈,NB-IoT的海量连接、深度覆盖、低功耗等优势都是需要前提条件的,了解这些前提条件与应用场
    的头像 发表于 10-25 19:43 3973次阅读
    <b class='flag-5'>都是</b>通信技术,<b class='flag-5'>NB</b>-IoT为什么可以这么<b class='flag-5'>优秀</b>?

    如何进行单片机代码架构的分层

    最近看了一个大神吴坚鸿的文章,他的软件架构写得还是不错的,但是代码风格一般,全局变量满天飞,但开发出来的产品稳定,性能也好。不管怎么说,在企业里,老板只追求结果,不追求过程,即使代码写得再不好,能实现功能就不错了。在这里,我借鉴
    发表于 06-12 17:45 1次下载
    如何进行单片机<b class='flag-5'>代码</b>架构的<b class='flag-5'>分层</b>

    让你看了头大的代码

    1、下面一段代码将注释和代码混在了一起,不认真看还真不知道。   高亮显示后:   2、看到这种多层嵌套恶心
    的头像 发表于 09-16 18:08 1491次阅读
    让你<b class='flag-5'>看了</b>头大的<b class='flag-5'>代码</b>

    九个单片机仿真优秀案例及源代码

    九个单片机仿真优秀案例及源代码
    发表于 03-17 09:13 160次下载
    九个单片机仿真<b class='flag-5'>优秀</b>案例及源<b class='flag-5'>代码</b>

    聊一聊MCU的软件分层

    一、MCU级软件有必要分层吗?1.1 如果不分层会怎样?看下面这段示例代码void main(){ sys_init() while(1) { //用PA1控制LED
    发表于 10-28 14:36 9次下载
    聊一聊MCU的软件<b class='flag-5'>分层</b>

    优秀代码的应用分层都是如何实现的

    开放接口层:可直接封装 Service 方法暴露成 RPC 接口;通过 Web 封装成 http 接口;进行 网关安全控制、流量控制等。
    的头像 发表于 10-11 09:37 1074次阅读