设计模式学习笔记 - 开源实战二(上):从Unix开源开发学习应对大型复杂项目开发

概述

软件开发的难度无外部两点,一是技术男,代码量不一定多,但要解决的问题比较难,需要用到一些比较深的技术解决方案或者算法,不是靠 “堆人” 就能搞定的,比如自动驾驶、图像识别、高性能消息队列等;而是复杂度,技术不难,但项目很庞大,业务复杂,代码量多,参与开发的人多,比如物流系统、财务系统等。第一点涉及细分专业的领域知识,跟设计、编码无关,所以接下来重点讲解第二点,如何应对如阿健开发的复杂度。

简单的 “hello world” 程序,谁都能写出来。几千行的代码谁都能维护。但是,当代码超过几万行、十几万,甚至几十万、上百万行的时候,软件的复杂度就会呈指数级增长。这种情况下,我们不仅仅要求程序运行得了,运行得正确,还要求代码看得懂、维护得了。实际上,复杂度不仅仅体现在代码本身,还体现在协作开发上,如何管理庞大的团队,来进行有条不紊地协作开发,也是一个很复杂的难题。

如何应对复杂软件开发呢?

Unix开源项目就是一个值得学习的例子。

Unix 从 1969 年诞生,一直演进至今,代码量有几百万行,如此庞大的项目开发,能够如此完美的协作开发,并且长期维护,保持足够的代码质量,这里面有很多成功的经验可以借鉴。所以,接下来就以 Unix 开源项目的开发作为引子,分三个章节,通过下面三个话题,详细的讲讲应对复杂软件开发的方法论。

  • 从设计原则和思想的角度来看,如何应对庞大而复杂在的项目开发?
  • 从研发管理和开发技巧的角度来看,如何应对庞大而复杂在的项目开发?
  • 聚焦在 Code Review 上来看,如何通过 Code View 保持项目的代码质量?

封装与抽象

在 Unix、Linux 系统中,有一句经典的话, “Everything is a file”,翻译成中文就是 :一切皆文件。这句话的意思是,在 Unix、Linux 系统中,很多都系都被抽象成 “文件” 这样一个概念,比如 Socket、驱动、硬盘、系统信息等。它们使用文件系统的路径作为统一的命名空间(namespace),使用统一的 read、write 标准函数来访问。

比如,我们要查看 CPU 信息,在 Linux 系统中,我们只需要使用 vimGedit 等编辑器或者 cat 命令,像打开其他文件一样,打开 /proc/cpuinfo,就能查到相应的信息。此外,我们还可以通过查看 /proc/uptime 文件,了解系统运行了多久,查看 /proc/version 了解系统的内核版本等。

实际上,“一切皆文件” 就体现了封装和抽象的设计思想

封装了不同类型设备的访问细节,抽象为统一的文件访问方式,更高层的代码就能基于统一的访问方式,来访问底层不同类型的设备。这样做的好处是,隔离底层设备访问的复杂性。统一的访问方式能够简化上层代码的编写,并且代码更容易复用。

此外,封装和抽象还能有效的控制代码复杂性的蔓延,将复杂性封装在局部代码中,隔离实现的易变性,提供简单、统一的访问接口,让其他模块来使用,其他模块基于抽象的接口而非具体的实现编程,代码会更加稳定。

分层与模块化

前面规范与重构章节也提到过,模块化是构架复杂系统的常用手段。

对于像 Unix 这样的复杂系统,没有人能掌控所有的细节。之所以我们能开发出如此复杂的系统,并且能维护得了,最主要原因就是将系统划分成各个独立的模块,比如进程调度、进程通信、内存管理、虚拟文件系统、网络接口等模块。不同的模块之间通过接口来进行通信,模块之间的耦合很小,每个小的团队聚焦于一个独立的高内聚模块来开发,最终像搭积木一样,将各个模块组装起来,构建成一个超级复杂的系统

此外,Unix、Linux 等大型系之所以能做到几百、上千人有条不紊地协作开发,也归功于模块化做得好。不同的团队负责不同的模块开发,这样即便在不了解全部细节的情况下,管理者也能协调各个模块,让整个系统有效地运转。

我们常说,计算机领域的任何问题都可以通过增加一个间接的中间层来解决,这本身就体现了分层的重要性。比如,Unix 系统也是基于分层开发的,它可以大致分为三层,分别是内核、系统调用、应用层。每一层都对上层封装实现细节,暴露抽象的接口来调用。而且,任意一层都可以被重写实现,不会影响到其他层的代码。

面对复杂系统的开发,我们要善于使用分层技术,把容易复用、根据题业务关系不大的代码,尽量下沉到下层,把容易变动、根据题业务强相关的代码,尽量上移到上层

基于接口通信

刚刚见到了分层、模块化,那不同层之间、不同模块之间,是如何通信的呢?一般来讲都是通过接口调用在设计模块(module)或者层(layer)要暴露的接口的时候,要学会隐藏实现,接口从命名到定义都要抽象一些,尽量少涉及具体的实现细节

比如,Unix 系统提供的 open() 文件操作函数,底层实现非常复杂,涉及到权限控制、并发控制、物理存储,但我们用起来却非常简单。此外,因为 open() 函数基于抽象而非具体的实现来定义,所以,我们在改动 open() 函数的底层实现时,并不需要改动依赖它的上层代码。

高内聚、松耦合

高内聚、松耦合是一个比较通用的设计思想,内聚性好、耦合少的代码,能让我们在修改或者阅读代码时,聚集在一个小范围的模块或者类中,不需要了解太多其他模块或者类的代码,让我们的焦点不至于太发散,也就降低了阅读和修改代码的难度。而且,因为依赖关系简单,耦合小,修改代码不会牵一发而动全身,代码改动比较集中,引入 bug 的风险也就减少了很多

实际上,刚刚讲到的很多方法,比如封装、抽象、分层、模块化、基于接口通信,都能有效得实现代码的高内聚、松耦合。反过来,代码的高内聚、松耦合,也就意味着,抽象、封装做的比较到位、代码结构清晰、分层和模块化合理、依赖关系简单,那代码的整体质量就不会太差。即便某个具体的类或者模块设计得不怎么合理,代码质量不怎么高,影响的范围也是非常有限地。我们可以聚集于这个模块或者类做相应的小型重构。而对于代码结构的调整,这种改动范围比较集中的小型重构的难度就小多了。

为扩展而设计

越复杂的项目,越要在前期设计上多花点时间。提前思考项目中未来可能会有哪些功能需要扩展,提前预留号扩展点,以便在未来需求变更时,在不改动代码整体结构的情况下,轻松地添加新能够。

做到代码可扩展,需要代码满足开闭原则。特别像 Unix 这样的开源项目,有 n 多人参与开发,任何人都可以提交代码到代码库中。代码满足开闭原则,基于扩展而非修改来添加新功能,最小化、集中化代码改动,避免新代码影响到老代码,降低引入 bug 的风险。

除了满足开闭原则,做到代码可扩展,在前面章节中也提到了很多方法,比如封装和抽象,基于接口而非实现编程等。识别出代码可变部分和不可变部分,将可变部分封装起来,隔离变化,提供抽象化的不可变接口,供上层系统使用。当具体的实现发生变化的时候,我们需要基于相同的抽象接口,扩展一个新的实现,替换掉老的实现即可,上游代码几乎不需要修改。

KISS 首要原则

简单清晰、可读性好,是任何大型软件开发要遵循的首要原则。只要可读性好,即便扩展性不好,顶多就是花点时间、多改动几行代码的事情。但是,如果可读性不好,连看都看不懂,那就不是多花时间可以解决得了的了。如果你对现有代码的逻辑似懂非懂,抱着尝试的心态去修改代码,引入 bug 的可能性就会很大。

不管是自己还是团队,在参与大型项目开发的时候,要尽量避免过度设计、过早优化,在扩展性和可读性有冲突时,应该遵循 KISS 原则,首选可读性

最小惊奇原则

《Unix 编程艺术》一书中提到一个 Unix 的经典设计原则,叫 “最小惊奇原则”,英文是 “The Least Surprise Principle”。实际上,这个原则等同于 “遵守开发规范”,意思是,在做设计或者编码时,要遵循统一的开发规范,避免反直觉的设计。实际上,关于这一点,我们在前面的编码规范部分也讲到过。遵循统一的编码规范,所有的代码就像一个人写出来的,能有效地减少阅读干扰。在大型软件开发中,参与开发的人员很多,如果每个人都按照自己的编码习惯来写代码,那整个项目的代码风格就会千奇百怪,这个类是这种编码风格,另一个类又是另一种编码风格。在阅读的时候,我们要不停的切换去适应不同的编码风格,可读性就变差了。所以,对于大型项目的开发来说,要特别重视遵守统一的开发规范。

总结

本章,我们主要从设计原则和思想的角度,也可以说是设计开发的角度,来学习如何应对复杂软件的开发。主要总结了 7 点。这 7 点在前面我们都详细讲过,它们分别是:

  • 封装与抽象
  • 分层与模块化
  • 基于接口通信
  • 高内聚、松耦合
  • 为扩展而设计
  • KISS 首要原则
  • 最小惊奇原则(遵守开发规范)

当然,这 7 点之间并不是相互独立的,有几点是相互支持的,例如 “高内聚、松耦合” 与抽象封装、分层模块化、基于接口通信。有几点是相互冲突的,比如 KISS 原则与为扩展而设计,这都需要根据实际情况去权衡。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/bicheng/235.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

【详细的Kylin使用心得】

🌈个人主页: 程序员不想敲代码啊 🏆CSDN优质创作者,CSDN实力新星,CSDN博客专家 👍点赞⭐评论⭐收藏 🤝希望本文对您有所裨益,如有不足之处,欢迎在评论区提出指正,让我们共…

2024-03-23青少年软件编程(Python语言)等考(二级)解析

2024-03-23青少年软件编程(Python语言)等考(二级)解析一、单选题(共25题,共50分) 1.期末考试结束了,全班的语文成绩都储存在列表score中,班主任老师请小明找到全班最高分,小明准备用Python来完成,以下哪个选项,可以获取最高分呢?( B ) A. min(score) B. max(score…

超级USB设备工具箱V2.0 绿色版-供大家学习研究参考

1、芯片精灵 ChipGenius V3.01 2、惠普U盘格式化工具 V2.2.0 3、MFormat V1.00中文版 4、MyDisk V2.50 5、安全移除USB磁盘(Disk Ejector) 6、U盘烧录修复工具(PortFree Production Program) V3.38 7、护U使者 V1.28 8、闪存精灵2…

【缺啥补啥】图表征学习-1

图表征学习: 学习图中的元素,如节点、边、子图或整个图的向量表征,并应用基于向量的机器学习算法进行图数据的建模和分析 动态环境: 图数据包括结构、特征、性质、任务等,随时间发生变化 开放环境: 泛指数据…

《Effective C++》《资源管理——13、以对象管理资源》

文章目录 1、Terms13:Use objects to manage resources1.1、普通指针进行资源管理存在的问题1.2、RALL1.3、没有针对“动态分配数组”而设计的智能指针 2、面试相关2.1 解释RAII原则,并给出它在资源管理中的重要性。举出一个可以编译的例子2.2 描述一个你曾经使用RA…

如何批量给Word文件增加前缀序号?“汇帮批量重命名”帮助你批量给word文件增加前缀序号。

批量给Word文件增加前缀序号的过程,对于经常处理大量文档的人来说,是一项既繁琐又必要的任务。首先,我们需要明确为什么要给Word文件增加前缀序号。在很多情况下,当我们需要按照一定的顺序对多个文档进行管理和归档时,…

Faiss原理和使用总结

Faiss是一种用于高维向量检索的库,特别适用于大规模数据集的相似性搜索。其核心原理和使用方法可以总结如下: Faiss的核心原理: 索引结构:Faiss提供了多种索引结构,包括基于树的索引(如k-means、PCA、IVF等…

基于STC15系列库操作LED灯

一、准备工作 1. 基于STC15系列库的工程模板 参考:51单片机工程模板的建立(基于STC15系列库)-CSDN博客 2. Keil编译器 二、程序编写 1. 新建 led.c 和 led.h 文件并存放于 user/led 文件夹下; 2. 新建 user.c 和 user.h 文件并…

如何辨别:DNS污染or DNS劫持?

DNS劫持和DNS污染的情况在互联网中并不少见,到底是出现了DNS污染还是DNS劫持。什么是DNS污染?什么是DNS劫持?我们该如何辨别DNS污染和DNS劫持? DNS劫持: DNS 劫持是指恶意攻击者通过非法手段篡改了网络中的 DNS 服务…

理论知识:Top-K 准确率

Top-1 Accuracy: 这是最常见的准确率评估方式,指的是模型预测的最有可能的类别(即概率最高的类别)是否正是真实的类别。换句话说,就是模型的预测结果中排名第一的类别是否正确。 Top-3 Accuracy: 这个评估标准比 Top-1 更宽松一些…

android 创建module

文章目的: 快速创建module并使用 创建步骤: 1 创建module 2 修改module下的build.gradle文件 3 修改清单文件中MainActivity属性,否则APP会因为有多个启动界面而崩溃 4 在主项目build.gradle引用该object Module 至此,可在APP中…

Golang的[]interface{}为什么不能接收[]int?

在 Go 中,[]interface{} 和 []int 是两种不同的类型,虽然它们的底层数据结构都是切片,但是它们的元素类型不同。[]interface{} 是一个空接口切片,可以容纳任意类型的元素,而 []int 是一个整数切片,只能容纳…

vue项目生成二维码(并避免重复生成)

一、需求&#xff0c;按连接&#xff08;带参数&#xff09;生成二维码 二、步骤 1、先安装插件 npm install qrcodejs2 --save-dev2、在需要用到二维码的页面引入 import QRCode from qrcodejs2;3、主要代码 <div id"qrCode2" ref"qrCodeDiv" class&…

针对springcloud gateway 跨域问题解决方案

springcloud gateway版本 <spring-boot.version>2.3.3.RELEASE</spring-boot.version> <spring-cloud.version>Hoxton.SR8</spring-cloud.version>跨域问题说明 application:1 Access to XMLHttpRequest at https://xxxxxxxxxx from origin http://l…

原生JS如何实现验证码

在原生JavaScript中实现验证码通常涉及到创建一些随机字符或图像&#xff0c;然后让用户输入这些字符以验证他们的身份。以下是一个简单的示例&#xff0c;说明如何使用原生JavaScript创建一个基于文本的验证码。 创建验证码字符串&#xff1a;首先&#xff0c;我们需要一个函…

Goland远程连接Linux进行项目开发

文章目录 1、Linux上安装go的环境&#xff12;、配置远程连接3、其他配置入口 跑新项目&#xff0c;有个confluent-Kafka-go的依赖在Windows上编译不通过&#xff0c;报错信息&#xff1a; undefined reference to __imp__xxx似乎是这个依赖在Windows上不支持&#xff0c;选择让…

IMX6ULL-UBOOT驱动移植

介绍 IMX6ULL正点原子开发板使用的是14x14_evk的芯片 其中14x14代表的是芯片的尺寸。 本教程的标识符以nsouther或者 NSOUTHER NSouther为主 添加板子自己的配置文件 板子的默认配置文件保存在 configs目录下&#xff0c;我们以mx6ull_14x14_evk_emmc_defconfig为主&#xf…

SOT23-6封装单键触摸感应触发芯片TC233A

前言&#xff1a; 触摸芯片很多&#xff0c;现在触摸按键已经应用到很多行业&#xff0c;虽然不能覆盖所有的按键&#xff0c;但确实用的越来越多&#xff0c;国产的价格也便宜的令人发指&#xff0c;比如这个TC233A&#xff0c;也就一毛多一点。 TC233A概述 TC233A 是一个单…

vue 钩子函数

目录 钩子函数概念 生命周期钩子函数 keep-alive 钩子函数 自定义指令的钩子函数 路由导航 / 路由守卫 钩子函数 全局守卫 路由独享守卫 导航守卫 钩子函数概念 在 vue 中可以自动执行的函数叫做钩子函数 生命周期钩子函数 vue 从实例创建到销毁过程中被自动执行的函…

Logback:新版本报no applicable action for [Encoding]问题

logback.xml配置文件如下 <?xml version"1.0" encoding"UTF-8"?><configuration><include resource"org/springframework/boot/logging/logback/base.xml"/><!-- 日志输出的通道 --><appender name"STDOUT&qu…