《代码整洁之道》读书笔记

川长思鸟来 2022-06-10 06:44 449阅读 0赞

# 背景 #

很早之前就接触过这本书，但当时比较热衷于看架构和设计模式之类的书籍，就把这本《代码整洁之道》排到了后面去看。也是因为从架构中能读懂很多思想和道理来，后又经人推荐，再次拿起这本书来仔细品味。

# 内容 #

整本书洋洋洒洒讲了17章内容，但总结起来，并没有那么复杂。

我们还是从接触事物最初的方式来思考，即Why-What-How。如下图所示：

## 1、Why ##

\-Why？  
\-为什么要读这本书?  
\-为什么我们需要编写整洁代码？

最初可能由于某些原因（如：开发周期短、人员水平有限、懒惰心理、管理漏洞等等），造成一部分糟糕或冗余等代码。

只要这种状况不被打破，根据破窗原理，这个糟糕代码就会逐渐越扩越大。

由于糟糕代码很难维护和扩展，整个团队等开发效率都有可能被拖累。逼不得已时只能选择走上漫长的重构之路，若是上述问题得不到重视，那将是又一轮的恶性循环……

> Tips:参见思维导图中的第一分支。

## 2、What ##

那了解了糟糕代码的沉重代价以后，我们就迫切的想知道，整洁代码应该是什么样子的？

关于“整洁代码“的看法，各个专家们看法不一，这个概念当然也不会死板到一种阐述方式。

总的来看，可以归结于这几个词：**优雅、高效、精炼。**

> Tips:参见思维导图中的第二分支。

## 3、How ##

至此，就要去聊方法论的东西了。到底怎样做才能写出整洁的代码呢？

这里，小编将书中的内容归纳为三大部分。其一，是指导原则。任何的行为和要求都要遵循一定的原则，理解原则可以帮助我们做出更好的实践。其二，是具体的实现方法。其三，是在二的基础上扩展的进阶内容。

### 3.1、原则 ###

*  SRP  
    单一职责原则

好处就不用多说了，也是设计模式的六大原则之一。要想重用性高，就需要细分，细分就需要有标准和依据，按照职责划分更适合业务逻辑的实现。

具体编程中适用于类、函数、接口、分层、模块等多种场景下。

*  OCP  
    开放封闭原则

总的来说就是，对修改关闭，对添加开放。前提是做好抽象和单一职责。

*  DIP  
    依赖倒转原则

模块应该依赖于抽象，抽象不应该依赖于具体实现。

### 3.2、规范（要求） ###

基于3.1的原则，3.2提出了具体的要求，来帮助我们编写整洁的代码。

这块的内容有很多，也很细节，全部列举出来也没有太大的意义，这里说几条小编感触比较深的几点，分享给大家：

*  1） 命名要规范  
    取有意义的名字，切忌使用i、j、a等；考虑名称等可读性和可理解性，不要使用缩写和生僻单词；区分动名词，方法命名宜使用动词、DTO对象宜使用名词等。
 *  2）注释要写好  
    要起到对代码的补充阐释的作用，杜绝过多冗余注释。
 *  3）格式要重视  
    格式是整洁的直接影响因素，不要小看每一个换行和空格哦。
 *  4）功能要精炼  
    与单一职责原则相契合，函数要短小精悍，过长的函数／方法不仅可读性差、容易出错，更影响复用性。
 *  5）参数要抽象  
    函数／方法是供调用方调用的，参数个数不宜超过三个，如果超过三个，那么你该考虑抽象了。
 *  6) 不要返回null  
    返回null值，增加了调用方的判断null的代码处理，影响原有的代码逻辑，不如在被调用的方法中做一次处理。  
    ……

![这里写图片描述][SouthEast]

# 小结 #

凡事不怕难，就怕用心，就怕思考。我们的目标不是码农，但做高质量的码农也不是容易的。细心总结，你会发现很多原理都是相通的，只有深刻的理解了，才能真正的做好。

[SouthEast]: /images/20220610/921a322c3fd5421f8f1a1a17ac884e67.png

发表评论取消回复

表情：

评论列表（有 0 条评论，449人围观）

还没有评论，来说两句吧...

相关阅读

相关《代码整洁之道读书笔记》

第十三章《并发编程》感悟（2019.05.29）为什么要并发 1.并发是一种解耦策略，它帮助我们把做什么（目的）和何时（时机）做分解开 2.解耦目的与时机能明显

柔光的暖阳◎/ 2024年01月14日 08:04/ 0 赞/ 230 阅读

相关 CleanCode---代码整洁之道笔记

CleanCode---代码整洁之道笔记一、整洁代码二、有意义的命名三、函数四、注释五、格式六、对象和数据结构七、

╰+哭是因爲堅強的太久メ/ 2023年01月13日 09:47/ 0 赞/ 548 阅读

相关代码整洁之道Clean code读书笔记

为了提升自己的基础能力以及代码风格，稳扎稳打，计划阅读代码整洁之道这本书。目录第一章整洁代码第二章有意义的命名第三章函数第四章注释第五章格

忘是亡心i/ 2022年11月07日 11:57/ 0 赞/ 361 阅读

相关【读书笔记】代码整洁之道

正如书名所说，这本书主要讲述的就是如何写出真正整洁的代码。作者在本书中阐述了在命名、函数、注解、代码格式、对象和数据结构、错误处理、边界问题、单元测试、类、系统、并发编程等方面

不念不忘少年蓝@/ 2022年10月17日 04:24/ 0 赞/ 375 阅读

相关《代码整洁之道》读书笔记

1.重复是一切邪恶的根源，许多原则与设计规则都是为了避免重复而产生的。如面向对象编程的基类，面向组件编程等等。 2.添加有意义的语境，对于命名，起一个比较容易检查的命名。比如

深碍√TFBOYSˉ_/ 2022年06月11日 03:57/ 0 赞/ 487 阅读

相关代码整洁之道读书笔记

自从进入游戏开发团队以后，最近一直在忙游戏开发，团队里的xxx师兄对我提供了很好指导，同时也督促自己变的“勤奋”了。。。个人觉得其中一个很好的习惯就是写读书笔记吧，以前

忘是亡心i/ 2022年06月11日 00:44/ 0 赞/ 451 阅读

相关《代码整洁之道》读书笔记

背景很早之前就接触过这本书，但当时比较热衷于看架构和设计模式之类的书籍，就把这本《代码整洁之道》排到了后面去看。也是因为从架构中能读懂很多思想和道理来，后又经人推荐，再

川长思鸟来/ 2022年06月10日 06:44/ 0 赞/ 450 阅读

相关代码整洁之道－阅读笔记

3 函数 > 3.1 > 3.1.1.短小：函数的第一规则是要短小。第二条规则是还要更短小。 > > > 程序中每个函数都只有两行、三行或四行长。每

拼搏现实的明天。/ 2022年05月22日 11:16/ 0 赞/ 430 阅读

相关《代码整洁之道》笔记

《代码整洁之道》笔记 ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9

素颜马尾好姑娘i/ 2021年09月29日 03:56/ 0 赞/ 964 阅读

相关《代码整洁之道》读书笔记

最初我喜欢这本书可能是因为非技术方面的原因，这本书中有很多我喜欢的插图。这本书的第一章的第一句话是这样说的：读这本书通常有两个原因：1. 你是一名程序员。2. 你想成为更好

梦里梦外;/ 2021年09月22日 03:58/ 0 赞/ 604 阅读