CategoryResourceRepost/极客时间专栏/geek/设计模式之美/开源与项目实战:开源实战/78 | 开源实战二(上):从Unix开源开发学习应对大型复杂项目开发.md
louzefeng bf99793fd0 del
2024-07-09 18:38:56 +00:00

11 KiB
Raw Blame History

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

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

如何应对复杂软件开发Unix开源项目就是一个值得学习的例子。

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

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

话不多说,让我们正式开始今天的学习吧!

封装与抽象

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

比如我们要查看CPU的信息在Linux系统中我们只需要使用Vim、Gedit等编辑器或者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点前面我们都详细讲过如果你对哪块理解得不够清楚可以回过头去再看下。这7点分别是

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

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

课堂讨论

从设计原则和思想的角度来看,你觉得哪些原则或思想在大型软件开发中最能发挥作用,最能有效地应对代码的复杂性?

欢迎留言和我分享你的想法。如果有收获,也欢迎你把这篇文章分享给你的朋友。