架构漫谈(八):从架构的角度看如何写好代码 + 我的思考

2023-05-16

我的总结:当先前对于利益相关者的关系理清了,系统基本架构和测试方法等也有了,进入实际Coding阶段。在Coding前,需要我们考虑好业务功能的分配,关注于功能会频繁变更的部分,为未来的维护和扩展打下良好基础。诚然,这确实是一个基础,限于当时的资源、环境等约束,难以将所有问题一步到位的解决,还待于后期的功能修复和完善。 功能模块、功能模块,以期达到松耦合、高弹性的效果,便于后期维护和新功能的部署。


转自InfoQ:https://www.infoq.cn/article/an-informal-discussion-on-architecture-part08

架构漫谈是由资深架构师王概凯 Kevin 执笔的系列专栏,专栏将会以 Kevin 的架构经验为基础,逐步讨论什么是架构、怎样做好架构、软件架构如何落地、如何写好程序等问题。

本文是漫谈架构专栏的第八篇,作者 Kevin 举例介绍了如何写好代码。当我们有了好的架构,那就需要考虑如何将架构落地,而这个时候,代码就显得无比重要了!千万不要让代码成为架构扩展的瓶颈。文中作者提到了代码架构,细细品味吧。

在第六篇文章中,我们得出一个结论,软件架构实际上包括了:代码架构,以及承载代码运行的硬件部署架构。实际上,硬件部署架构最终还是由代码的架构来决定。因为代码架构不合理,是无法把一个运行单元分拆出多个来的,那么硬件架构能分拆的就非常的有限,整个系统最终很难长的更大。

所以我们经常会听说,重写代码,推翻原有架构,重新设计等等说法,来说明架构的进化。这实际上就是当初为了完成任务,没有充分思考所带来的后果。这也并不是架构进化的事情,而是个人对问题领域的逐渐深入理解的过程。所以有必要再讨论一下,代码的架构应该是怎样的。

本文会在之前几篇文章的基础上,进一步探讨如何把架构的思考进行落地,细化到我们代码的实践当中,尽量不要让代码成为系统长大的瓶颈,降低架构分拆的成本。

在前面我们提到,软件实际上是对现实生活的模拟,虚拟化。这是一个非常重要的前提,直接决定了我们的代码应该分为几部分。结合每个部署单元所承担的责任,可以明确的拆分为两个不同的责任:

  1. 表达业务逻辑的代码。很多人把这部分叫做 Domain Logic,或者叫 Domain Model。这部分实际是来源于生活的,必须保持和现实生活中的切分一致,并非人为的抽象而成。

  2. 对用户提供访问并保存业务逻辑运行结果的代码。计算机的状态保存有一个缺陷,本机保留业务运行结果有很大的问题,一般都在外存储设备上保存,也便于扩展。

所以单个部署单元的代码可以分为两个部分,如下图所示:

(点击放大图像)

从这个图中可以看出,软件代码的相关利益人为运行时的访问人员和存储设备。而 service 的代码是最复杂的,需要服务于三方,代码人员的负担是最重的。为了把这三方的变化对 service 的影响降到最低,对于 service 还必须进一步的分拆为三个部分,让每一个部分都能够独立的变化,这样这三方的变化就不会产生连锁响应,降低成本。如下图所示:

(点击放大图像)

这样,就划分成了几个责任:

  1. Service 就专注于 user 的需求,并组合 Glue Code 提供的服务完成需求。

  2. Glue Code 专注于组合 business 的调用,管理 Business 里面对象的生命周期,并且通过 Repository 保存或加载 Business 的状态

  3. Business 专注于实现业务的核心模型。

  4. Repository 专注于数据的保存,并和存储设备一一对应。

大家注意看,还是树形架构。并且左侧的主要需要计算机的相关理论知识,并且要直接面对用户的需求。右侧的更多的需要面对业务的核心。只要这几块的开发人员互相商量好了接口定义,这几个部分的开发就可以并行的进行,极大的提升开发的效率,缩短开发的时间。要做好这几部分,还需要注意,逻辑只允许存在于 Business 中,Service、Glue Code、Repository 都不允许存在业务逻辑。为什么呢?首先我们来看看什么叫业务逻辑。

什么叫业务逻辑?

首先这个定义的前提是指软件代码中的逻辑,不是现实生活中的逻辑。在软件代码中,不需缩进和计算的顺序调用,包括缩进的代码目的是 catch exception 的,都不算逻辑,除此以外都是逻辑。以下用严格的顺序调用来指代这种代码。因为顺序调用是计算机的特性,由编译器来决定的,当然最本质的是因为我们计算的基础都是图灵机。在现实生活中,顺序调用也是逻辑,大家不要和我们这里说的业务逻辑相混淆。

为什么说除了 Business 代码中有逻辑以外,其他地方不能有逻辑呢? 我们每个部分分别分析:

  1. 如果 service 里面不是严格的顺序调用,有很多分支,那么说明这个 service 做了两件或者两件以上的事情。必须把这个 service 分拆,确保每个 service 只做一件事情。因为如果不这么分拆的话,一旦这个 service 中的某各部分发生变动,其他的部分的执行必定会受影响。而确定到底有哪些影响的沟通成本非常高,其他相关利益方没有动力去配合,我们往往不会投入精力仔细评估。最后上线会出很多不可预料的问题,最终会导致损失用户的利益,并且肯定会导致返工,损坏自己的利益。如果是有计算的逻辑的话,比如受益计算,订单金额计算等,那么这部分应该是 Business 代码需要完成的,不能交给 service 代码来实现。

  2. Glue Code 里面如果不是严格的顺序调用,同理会和 service 一样遇到同样的问题。

  3. Repository 里面如果不是严格的顺序调用,包括存储访问的代码里面(比如 SQL),会导致逻辑进入到存储设备中。存储设备的主要目的是拿来存储的,一旦变成了逻辑计算的主体,就会导致存储设备无法通过增加机器的方式横向扩展长大。这个时候就没有架构了,只能换性能更好的机器,这个叫 scale up。只有 scale out 才能算架构。

以上都会导致架构无法快速的横向扩展和分拆,并且增加了修改的成本,这些是不符合开发人员以及业务的利益的。

这么做的好处有哪些呢?

  1. Service、Glue Code、Repository 里面的代码是严格的顺序调用,那么这些代码只要做连通性测试即可,不需要单元测试。因为这些代码都需要和很多上下文打交道,很难做单元测试。这样才算是真正的组合。

  2. Business 不访问任何上下文,不访问任何具体的设备,所以这部分代码是非常容易些单元测试的,并且单元测试必须 100% 覆盖。因为其他地方没有业务逻辑,所以一旦有问题,就可以断定是 Model 的问题,单元测试肯定可以发现。如果单元测试没有发现问题,那么单元测试一定有问题。线上问题的模拟也就变得非常的简单,单元测试也能够得到进一步的补充。

  3. Repository 很容易按照存储设备本身的最小访问粒度来完成工作,比如 DB,完全可以做到单表访问。因为这个时候存储设备只关心存取数据,完全和业务没有关系。做表的分拆也是非常容易的事情,存储设备通过增加机器就可以横向扩展长大。很多人会担心说,没有了 join,访问 DB 的次数是不是更多了,会导致性能下降? 按照现在网络的条件,网络访问和 Disk IO 访问的差距已经不大了,合理的设计下,多访问几次 DB 并不会导致这个问题。另外如果多台 DB 的话,还能通过并行加速访问。

  4. 由于 Service、Glue Code、Repository 代码简单了,才可以让我们的开发人员投入更多的时间研究业务,毕竟这部分才是软件所真正服务的对象。

我们再来看一个实际的例子,如下图所示:

(点击放大图像)

Manager 类实际就是 Glue Code。有几个注意点需要说明一下:

  1. 不能把 Business Model 当做数据对象来处理,Model 关心的实际上是业务行为,数据只是是这些行为的结果。所以 Glue Code 需要把 Model 转换为 Entity,Entity 和存储设备里面的存储粒度一一对应。比如在 DB 中,每个 Entity 对应一张表,并且跟着表的变化而变化,这样就保证存储的变更不会影响 Model。同样 Service 和用户之间的数据交互,也是不会和 Model 之间相关的,确保用户的需求变化,不会影响到 Model。因为用户的需求变化是最频繁的,没有逻辑,可以让我快速的满足业务的需求。

  2. 在 Service 这里,最好不要考虑代码重用。因为当多个不同的角色访问同一个接口,一旦某个角色的需求发生了变化,就会要求开发人员去修改。而这个修改往往会影响到其他的角色,需要这些角色一起配合来确定是否受影响,但是这些角色因为没有需求,往往不会配合。这样就给开发人员造成了很多不必要的沟通,成本是非常高的。最终都会导致线上 Bug,影响最终的用户。所以尽量给不同的角色不同的 Service,避免重用,降低沟通成本。很多人会说这样 Service 不就太多了吗? 这样 Service 注册,查找等管理需求就出现了,Service 治理中心就是来解决这个问题的。因为 Service 里面没有逻辑,所以开发和管理非常的简单,可以快速应对业务的变化。我们只有更快地变,更容易的变,才能更好地应对变。

  3. Business Model 是必须要重用的,一旦发现重用出现问题,那么说明 Business Model 的识别出现了问题,这是一个我们要重新思考 Model 的信号。Business Model 必须是一个完美的树状,如果不是,也说明 Model 的识别出了问题。

在实际操作中,Service、Glue Code、Repository 不能有逻辑,实际上和很多人的观念是冲突的,认为这个根本做不到。做到这一点需要很多的学习成本,但是一定可以做得到。当发现做不到的时候,可以断定是业务的分析出了问题。比如不该合并的合并了,不该计算的计算了。这个问题一定有办法解决的,做不到都是理由,无非是想早点把自己的工作结束罢了。虽然刚开始会比较困难,一旦把这个观念变成自觉,开发的质量和效率马上就能高好几个级别。

我的游泳教练曾和我说过这些话,我至今记忆犹新:“业余选手,越想从水里浮起来,就越想把头抬起来,身体反而沉下去。只有克服恐惧,把头往水里压下去,身体才能够从水里浮起来。真正专业的习惯往往是和我们日常的行为相反的”。

我们真正想快速的完成代码工作,就要克服自己对时间的恐惧,真正的去研究业务的问题,相关 stakeholder 的利益,把这个变成我们的习惯。写代码的时候让该出现逻辑的地方出现逻辑,让不该出现的地方不能出现。一旦不该出现的地方出现了逻辑,那么要马上意识到,这个地方是一个坑,这个问题一定和业务的分析不透彻有关系。

很多人可能会把这个做法和 Martin Fowler 曾经提出过充血模型和贫血模型来比较,和 Domain Driven Design 来比较,其实没有必要。这个分拆完全是从软件所解决的问题,根据软件架构推导出来的,很多地方和两位前辈的观点是一致的,但是并不完全等同。

以上只是针对单一的 Service 部署单元的分析,扩展开去,对于其他的部署单元也是类似的。每个单元的下一级都可以认为是 Repository,每个单元的上一级都可以认为是 User。这些实践在我自己的项目中都有用到,非常的有效,迭代的速度非常的快。很多人担心 Business Model 建不好,其实没关系,刚开始可以粗糙一点,后续可以慢慢的完善。这个架构已经隔离好了每个部分的变化对其他部分的影响,变化成本都在可控的范围之内。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

架构漫谈(八):从架构的角度看如何写好代码 + 我的思考 的相关文章

  • SpringBoot项目启动加载时排除某一个类

    在Application启动类上 xff0c 用这个注解就可以指定某个类不加载进容器 64 ComponentScan
  • 手写一个生产者/消费者模式(三种方式实现)

    这种设计模式需要满足以下三点要求 xff1a xff08 1 xff09 生产者生产数据到缓冲区中 xff0c 消费者从缓冲区中取数据 xff08 2 xff09 如果缓冲区已经满了 xff0c 则生产者线程阻塞 xff1b xff08 3
  • Android中Okhttp,Volley,Retrofit网络框架优缺点及对比

    Okhttp xff1a Square 公司开源的 OkHttp 是一个专注于连接效率的 HTTP 客户端 OkHttp 提供了对 HTTP 2 和 SPDY 的支持 xff0c 并提供了连接池 xff0c GZIP 压缩和 HTTP 响应
  • Google身份验证服务端实现

    import org apache commons codec binary Base32 import org apache commons codec binary Base64 import javax crypto Mac impo
  • 下载jdk8登录账号

    目前在官网下载低于jdk1 8的java jdk的时候需要登陆 xff0c 这边分享一个账号 xff0c 方便下载 2696671285 64 qq com 密码 xff1a Oracle123
  • idea中maven项目 jar包下载不完整解决办法

    有时从git上clone项目 xff0c maven工程 xff0c 有时候pom xml在project标签处报错 xff1a Failed to read artifact descriptor for xxx jar 这种有时候时ja
  • 【RoboMaster】舵机驱动&蓝牙模块教程

    本文是为参加2021赛季北京理工大学机器人队校内赛所写的简单教程 xff0c 意在帮助参赛选手快速了解校内赛所需模块的使用方法 xff0c 以及其与薪火培训知识的联系 舵机驱动 硬件接线 舵机是由直流电机 减速齿轮组 传感器和控制电路组成的
  • vs编译程序加快速度的方法

    在使用VS2013编译C 43 43 程序的时候 xff0c 修改某个文件 xff0c 会使整个工程都重新编译一遍 xff0c 为了使编译速度加快 xff0c 可以修改C 43 43 配置属性 xff1a 第一因时间引起的 xff1a 1
  • Visual Studio中gets报错解决方法

    方法如下 xff1a 1 这是敲出gets后报的错 2 经过查找资料 xff0c 知道vs2015之后就不支持gets了 xff0c 变成了gets s xff0c 并且后面的括号中也不能单独写一个数组名 xff0c 还需加上数组内的个数
  • 利用RCLCPP实现话题的发布与订阅

    目录 1 创建节点2 编写发布与订阅节点2 1 发布节点 xff08 topic publisher 01 cpp xff09 2 2 订阅节点 xff08 topic subscribe 01 cpp xff09 2 3 修改CmakeL
  • ROS2实现虚拟串口通信

    目录 1 下载demo文件1 1安装python3 serial 2 下载虚拟串口模拟器socat3 串口通信测试3 1代码修改3 2开启uart example py3 3开启发送端口dev pts 23 4进入demo文件夹 xff0c
  • ubuntu编译卡死解决

    添加交换空间 一 xff0c 查看当前系统的swap大小 span class token function free span span class token parameter variable m span 二 xff0c 创建一个
  • 运行LIO-SAM,[lio_sam_imuPreintegration-2] process has died,[lio_sam_mapOptmization-5] process has died

    报错图例 解决办法 span class token builtin class name cd span usr local lib span class token function sudo span span class token
  • 运行LeGO-LOAM

    参考 链接 xff1a https blog csdn net weixin 39754100 article details 112186264 https blog csdn net NEU Ocean article details
  • PELCO-D协议校验位

    PELCO D的功能是用于矩阵和其它设备之间的通信协议 PELCO D控制命令格式如下 字节1字节2字节3字节4字节5字节6字节7起始字节云台地址命令字1命令字2数据1数据2结束字节FFaddresscommand1command2data
  • 【Arduino 无刷电机控制教程】

    Arduino 无刷电机控制教程 1 概述 2 试验准备 3 实验原理 4 Arduino 无刷电机控制 电路图 4 1 实验组件 4 2 用于 BLDC 电机控制的 Arduino 代码 5 实验验证 5 1 电位计控制无刷电机速度 5
  • SLAM之camera(Intel RealSense D435)调试第二弹:Ubuntu16.04平台下getting started

    一 实验环境 Camera Type D435 Firmware Version 05 09 02 00 or 05 10 06 00 Operating System amp Kernel Version Ubuntu16 04 5 LT
  • 【电赛】电设校赛常用电路整理

    电设校赛常用电路整理 写在前面引用与致谢单电源供电集成运放电压比较器单限比较器过零比较器改进 xff1a 限制幅度和设置偏置 滞回比较器窗口比较器 波形发生与变换正弦波RC正弦振荡电路LC正弦振荡电路 方波三角波锯齿波尖顶波阶梯波 场效应管
  • 材料力学:使用matlab绘制铰支梁在多个集中力、集中力偶矩作用下的挠曲线

    材料力学 xff1a 使用matlab绘制铰支梁在多个集中力 集中力偶矩作用下的挠曲线 一 程序输入参数介绍 二 程序设计思路介绍 1 输入变量预处理 2 支座反力求解 3 梁的弯矩求算 4 数值积分法求解挠度 5 曲线绘制及关键点标注 三

随机推荐