如何避免代码的熵增

在开发中与别人交流或在程序员社区中,经常会有关于烂代码的讨论,并且为其起了一个打趣的名字”屎山“。 仅从名字上也不难看出,大家对于这种代码是十分的厌恶的。其实随着需求的变化和增加,项目不可避免的会变的混乱,在物理学里有个名词叫“熵增”。 熵增过程是一个自发的由有序向无序发展的过程 既然代码会膨胀,并且会变得混乱,如何做能够尽量的避免这种情况的发生呢? 核心办法就是主动做功,在规划、实施、复盘等各个阶段有意的去做治理,从而避免代码的混乱。 勾勒整体 在需求开发之前,要建立对需求的整体的认识,从整体拆分细节,从细节着手开发。这么做的主要目的就是对需求有一个全局的规划,确定需求边界,就不会再开发的时候迷失方向,导致整个需求的实现变得混乱,代码和思想都没有清晰的表达。 在整体确定,边界清晰的时候,还需要考虑一点:当前需求与已有功能的关系时怎么样的,如何能花费更小的成本将新增需求融入现有系统。 完成上面说的还有一步就是追问,此方案是否为最优方案,是否还存在更为简化更易于理解的放啊的方案,如果回答全部为是,那么关于整体这部分的考量也就到此结束了。 化繁为简 我对专业的定义是:可以将自己领域的复杂问题简单化的能力。把简单的事情做复杂是庸才,把复杂的事情做复杂是通才,把复杂的事情做简单是天才。 在程序开发中,以易读为第一要务。写代码的主要目的是给人阅读,其次才是机器执行。在开发中,应该以代码的可读性为最高优先级,其次才是性能或其他指标。 大道至简,做到简不容易,需要通过不断的练习与反思,才能窥其门径。 摒弃过度设计 好的程序设计应该是立足业务的基础上长出来的,在业务不是很明朗的时候,应该更专注于方案和代码的简单而不是过度设计。 业务不明朗的时候大多数的设计是无用的而且一些设计会带来代码复杂读的增加,虽然可以美其名余曰有更好的扩展性,没有用的扩展性等于没有扩展性。 好的设计应该是以对业务有深入理解后,通过重构的手段展现出来的,而不是在业务一开始就过分的考虑设计。 不断重构 重构的时机有三种: 对业务有更深入理解的时候 在原有功能扩展新功能的时候 已有功能存在设计缺陷的时候(性能,扩展性,易读性) 重构不应该等”有时间“的时候,”有时间“就等于没有时间。重构应该发生在发现问题的时候,发现问题就解决问题。 就像打扫卫生一样,每发现一个地方乱了,就顺手整理一下,虽然没有刻意的花时间去进行整理,但是整个房间依然会保持整洁。 应该缩小重构的粒度,增加重构的频率,使重构变得小而频繁。 总结 除了上述说的情况之外,保持学习也是很关键。思而不学则殆,通过学习他人项目治理的思想,来增加自身的理解,并在开发中不断的去验证、思考和改进,从而写出更简洁高效的代码。 纸上得来终觉浅,绝知此事要躬行。学习只能是觉知,关键在于实践,知行结合,才是真正把知识内化为己所用。希望本文能对你有所帮助,个人观点难免会有疏漏和偏颇,如果有不同观点,欢迎留言讨论。

February 20, 2023 · 1 min · 云溪

我用了近两天的时间,只为了写三行代码

事情发生在我们线上的一个遗留问题,问题大致情况是我们引入的一个库会导致服务在运行一段时间后出现死锁,并且会造成整个网站无法访问。 我们发现通过配置库的一些参数可以避免死锁的情况发生,但是会引发事务无法回滚的新问题。 由于后者相对故障等级更低一些,我们首先进行了故障降级,选择了优先保障服务运行。 后面则是排查为什么会新的配置会出现事务无法回滚,这个事情由我负责排查。 从部门同事那了解了问题的详细情况后我就开始着手进行排查。首先是对问题进行梳理把新引入的库与框架之间的关系以及整体的一个运行流程进行了梳理。 如果要对整个流程做详细的了解,需要阅读的代码量是十分庞大的,不仅需要阅读库,还需要对框架源码进行阅读。 就解决问题而言,我认为需要做粗略的流程梳理即可,通过对整个流程的一个大致了解,然后确定问题的具体发生位置,然后对具体位置进行详细了解。 在粗略梳理的过程中,我从新引入库开始着手,主要是由于库的代码量相对较少,阅读起来相对更快一些,且如果仅从库层面就能解决问题,也可以省略的框架代码的阅读。 对于库源码的了解我通过 wiki + 源码的方式,这样能够更省力的了解库的整个运行机制。 然而了解了库的运行机制后,我发现问题可能出现在库与框架的配合上。需要涉及到框架源码的阅读。 在开始阅读框架源码前,我决定在本地构建一个复现环境,通过对构建出的本地环境对源码进行 debug 调试。 经过反复的 debug 最终终于确定了问题出现的原因,是由于新库引入后,事务开启时新建一个数据库连接,而通过 ORM 进行数据库查询时会创建另一个数据库连接。这就导致事务和 SQL 的执行不是在同一个数据库连接中,也就造成了数据库事务无法生效的问题。 确定了问题的原因解决方案就好确定了,我们只需要保证事务和 SQL 执行在同一个连接中即可,而解决这个问题只写了三行代码,既保证了功能的完整,没有侵入库和框架进行底层源码的改造。 这次问题的排查让我想到了福特公司用一万美元画一条线的故事。 画一条线,1美元;知道在哪儿画线,9999美元。 这次的问题离不开部门同时的帮助,在排查的过程中和同事进行了 2-3 轮的沟通。不仅让我对问题有一个全面的认识,也几次在我遇到困惑时,给了我解决问题的灵感,包括在最后解决方案制定后的论证,都蕴含了整个团队的心血。 也希望这次的一个排查经过能够对看文章的你有一些启发,欢迎你分享你的感悟和思考。

August 27, 2022 · 1 min · 云溪