（读书笔记）【代码整洁之道】

前言

首先这是一本好书。他是一本采用Java代码的为案例的书，书中很多例子，但是自己对java不精通，很多代码都没有仔细看就跳过了。这是也是略有遗憾的地方。然后这次读书很匆忙，书中很多细节可能没有体会出来，过段时间回头再看看吧。之所以前三章读书笔记中跳过了，是因为感觉没有讲到重点啊。

一、注释

1、不要把代码注释掉，最好直接删除掉；

2、好的方法名已经具有很好的阅读性，不需要添加额外的注释了；

3、如果代码里有特殊的逻辑设计，比如自定义的算法逻辑，这个注释是必须要的。

二、格式

1、垂直距离，一般指的是前后花括号之间的行数。垂直距离越短越好；

2、概念相关的方法体尽量放在一起；

3、垂直顺序，一般执行函数放在开头，调用方法放在后面，一般而言，一个好的类提供较少的输入输出端口，内部调用方法对外不可见；

4、横向记录，一般程序员喜欢看短的代码行。标准不是唯一，个人的感觉一行代码尽量在IDE的代码屏幕内为准。

5、基本的代码格式直接使用IDE的格式化功能，具体自己百度；

6、团队规则，团队规则是在基础的格式化规范上提出开发团队适用的规范，个人感觉要点可能不多，但是还是有必要的，而且这个不会花太大的代价去实行。

三、对象和数据结构

1、个人感觉对象可以和现实的物品进行关联，比如我们模拟一个体温计的对象，这样的话，我们只要给出测量端口和查看测量结果端口，其余部分进行封装，还有不同的体温计，可以使用抽象对象的方式去思考和实现；

2、对象和数据结构不要混淆，一般而言，对象拥有真实行为，而数据结构没有；

3、隐藏结构，书中指出不要暴露对象内容的数据结构；

4、数据传送对象（DTO），指的是只有公共变量的类；

5、 对象暴露行为，隐藏数据；数据结构暴露数据，没有明显行为。

四、错误处理

1、使用异常而非返回码，在能预见异常的地方手动抛出（throw）；

2、可控异常对于一般的应用开发，其依赖成本要高于收益，但是关键代码库可以使用可控异常；

3、特例模式，书上说创建一个或者配置一个对象，用来处理特例；在接口中使用多态的方式进入到特例中，这样外部程序不需要调整，只要调整内部行为就好了；

4、不要返回NULL值，如果实例化对象失败，建议也要创建默认实例。因为程序中如果没有判断null值，就会奔溃；

5、不要传递NULL值，原理类似上面的 不要返回NULL值。

五、边界（针对第三方程序包和开源代码）

1、书上提出测试边界的概念，感觉好像没有什么用啊。

六、单元测试

1、TDD三定律，具体见书中；

2、测试代码的质量和生产代码一样重要，不要忽视测试代码，不然后期基本等于没有测试；

3、我们目前的单元测试使用的是vs自带的单元测试项目，所以框架上没有问题，还是在测试代码的质量上和管理上。

七、类

1、类应该要短小，有以下几大原则：单一权责，内聚；

2、重构代码并不是减少整个程序的代码量，相反，重构代码后因为采用具有意义的方法名和拆分大类后反而会增加代码量，这个是正常的；

3、隔离修改，如何做到隔离修改，这个是好的代码的成功的地方，目前个人认为多态，抽象，依赖倒置的设计模式可以较好的做到隔离修改。

八、系统

1、将系统的构造和使用分开，分解mian，我们可以得到工厂模式的原型，将初始化和运行分隔开来，还可以使用依赖倒置的设计模式；

2、AOP框架（软件架构师进阶），面向切面编程，具体内容大家自己百度吧；

3、目前C#的AOP框架较少，C#现在有AspectJ的aop框架，AOP框架能够分离日志处理和异常处理的模块；

4、系统要整洁，感觉这章有点飘啊。

九、迭进

1、减少重复的代码，模板方法模式使用；

2、时时照拂自己的创造的东西，用心是最珍贵的资源。

十、并发编程

1、单一权责原则，限制数据作用域，使用数据复本，线程尽可能地独立；

2、了解执行模型：互斥，线程饥饿，死锁，活锁；

3、测试多线程代码的复杂度比单线程的高很多；

4、并发线程开发较复杂，但是目前基本不涉及，没有深入。

十一、逐步改进

1、糟糕的代码不是一步就产生的，而是逐渐变坏的，所以在没有糟糕到无法重构前，最好停下来先把代码重构掉；

2、重构有点像解魔方，需要经过许多小步骤后，才能达到较大的目标；

3、随着代码腐败下去，会出现大量隐藏纠结的依赖关系，这些都是要破除的；

4、书中的逐步改进的实例是基于项目已经有完善的单元测试的基础上的，作者的原则是每次做少量的改动，完成改动后进行对应的单元测试，只有在单元测试通过后才进行下一步的重构。这样就能保证重构后的代码不会有bug，但是很多时候可能还没有完善的单元测试，这样的话，就需要好好地进行测试，至少要做到路径全覆盖。

十二、JUnit框架

1、JUnit是java的测试框架，现在我们使用的是微软的TestUnit，具体内容这次就先跳过了；

十三、重构SerialDate

1、这章竟然是重构开源代码的案例，这次也就先跳过吧；

十四、味道和启发

1、不要忽视编译器警告，目前我们有stylecoop来控制；

2、函数参数个数问题，死代码，垂直分离，信息过多，基类依赖派生类，选择子参数，不恰当的静态方法，用多态替代if/else或者switch/case，都是最常见的点了；

3、这章内容列举了很多编码的问题和编码的技巧，如果把这章的要点都吃透，那你写出来的就是好代码了；

4、测试，这块书中简单介绍了，个人总结不好。

附录A

附录部分这次也先跳过了。