代码整洁之道个人总结

代码整洁之道总结

1.switch语句

	写出短小的switch很难，即便是只有两种条件的switch语句也要比单个代码块和函数大得多，写出制作一件事的switch也很难。当switch条件增多时，代码还会变长。它明显做了不止一件事，违反了单一职权原则和开放闭合原则。

	遇到此类问题的解决方案是：**将switch语句埋到工厂底下，不让任何人看到，该工厂使用switch语句为实体的派生物创建适当的实体，而不同的函数。**

2.函数参数

	最理想的参数数量是零（零参数函数），其次是一（单参数函数），再次是二（双参数函数），应尽量避免三（三参数函数），有足够特殊的理由才能用三个以上参数（多参数函数）。

3.使用异常替代返回错误码

	 从指令式函数返回错误码轻微违反了指令与询问之间的规则，它鼓励了在if语句判断中把指令当做表达式使用。这不会引起动词/形容词混淆，但却导致更深层次的嵌套结构。当返回序错误码时，就是在要求调用者立刻处理错误。

	如果使用异常替代返回错误码，错误处理代码就能从主路径代码中分离出来，得到简化。

4.抽离Try/Catch代码块

Try/Catch代码块搞乱了代码结构，把错误处理与正常流程混为一谈，最好把try和catch代码块的主题部分抽离出来，另外形成函数。

5.注释

有些注释是必须的，也会有利的。唯一真正还的注释是想尽办法不去写的注释。

6.垂直位置（垂直格式）

变量声明：变量声明应尽可能靠近其使用位置，因为函数很短，本地变量应该在函数的顶部出现。

1）实体变量：实体变量应该在顶部声明，这不会增加变量的垂直距离，因为在设计中，它们如果不是被该类的所有方法也是被大多数方法所用。

2）相关函数：若某个函数调用了另外一个，就应该把他们放到一起，而且调用者应该尽可能放在被调用者上面，这样，程序就有了自然顺序。若鉴定遵守这条约定，读者将能够确信函数声明总会在其代用后很快出现。

3）概念相关：概念相关的代码应该放到一起。相关性越强，彼此之间的距离就该越短。相关性应建立在直接依赖度额基础上，如函数间调用，或函数使用某个变量，但也有其他相关性的可能，相关性可能来自于执行相似操作的已足以函数。

7.横向格式

一行代码应该有多宽？应该尽量保持代码行短小，死守80个字符的上限，最长代码行达到100个字符到120个字符。

8.整洁的测试

• 做到测试可读的方式：明确、简洁、还有足够的表达力，在测试中，以尽可能少的文字表达大量的内容。

• 整洁测试遵循的规则：

1）快速：测试运行速度快。

2）独立：测试应该相互独立。

3）可重复：测试应当可在任何环境中重复通过。

4）自足验证：测试应该有布尔输出值。

5）及时：测试应及时编写。

9.类的组织

​ 遵循标准的Java约定，类应该从一组变量列表开始，如果有公共静态常量，应该先出现，然后是私有静态变量，以及私有实体变量，很少会有公共变量。

​ 类的名名称应当描述其权责，命名正是帮助判断类的长度的第一手段。如果无法为某个类命以准确的名称，这个类大概太长了，类名越含混，该类就有可能拥有过多权责。（系统应该由许多短小而不是少量巨大的类组成，每个小类封装成一个权责，只有一个修改的原因，并与少数其他类一起协同达成期望的系统行为。）

1）单一权责原则

​ 单一权责原则，类或模块应有且只有一条加以修改的理由。该原则既给出了权责的定义，又是类的长度的指导方针。类只应有一个权责（只有一条修改的理由）。

2）内聚

类应该只有少量实体变量，类中的每个方法第应该操作一个或多个这种变量。方法操作的变量越多，就越粘聚到类上，如果一个类中的每个变量都被每个方法所使用，则该类具有最大的内聚性。

10.并非编程

• 发生思索的4个条件

  1）互斥

  无法在同一时间为多个线程所用，数量上有限制

  2）上锁及等待

  当某个线程获取一个资源，在获取到其他全部所需资源并完成其工作之前，不会释放这个资源。

  3）无抢先机制

  线程无法从其他线程处夺取资源，一个线程持有资源时，其他线程获得这个资源的唯一手段就是等待该线程释放资源。

  4）循环等待