整理《编程的智慧》

---

前言

王垠的《编程的智慧》一文，从第一次读到现在，已经过了许久。从第一次看的时候就感觉这文章十分的厉害，大概是我没十几年的从业是写不出来的状态。全文说的很好，我很多时候也按照其中去做。但是很多时候总是不得要领，所以总是在闲暇之余打开看了一遍又一遍。想着要把文中的习惯和好的做法融入到自己写的代码中去，所以就觉得是应该整理一下，以自己的方式记录出来，也比较好形成一个直观的概念，在写代码的时候方便一些。

说这些的时候总是会想起王垠提出过很多次的教条主义，无奈在我看来，教条主义有时候真的是一个好东西。毕竟不是每个人都能把一门技艺磨练的炉火纯青，信手拈来。所以我们需要准则来告诉我们，什么时候该做什么，什么时候不该做什么。虽然不会有很多创新和多大的提高，最起码，不会捅篓子。生活在集体之中，对这一点要尤为注意。

---

全文小标题

1. 反复推敲代码

    By me: 写的时候记得要把当时预料到的坑给TODO一下，不然过后也就忘记了，打注释也好。另外就如文中所说，过阵子再回来看这部分代码，又会有不一样的感觉。
   

2. 写优雅的代码

    if语句最好有两个分支。写代码说起来总归是线性的，所以逻辑要整理清楚。先哪一步，后哪一步。
   

3. 写模块化的代码

    - 避免写太长的函数
    - 制造小的工具函数
    - 每个函数只做一件简单的事情
    - 避免使用全局变量和类成员来传递信息，尽量使用局部变量和参数
   

4. 写可读的代码

    - 使用有意义的函数和变量名字
    - 局部变量应该尽量接近使用它的地方
    - 局部变量名字应该简短
    - 不要重用局部变量
    - 把复杂的逻辑提取出去，做成“帮助函数”
    - 把复杂的表达式提取出去，做成中间变量
    - 在合理的地方换行
   

5. 写简单的代码

    - 避免使用自增减表达式
    - 永远不要省略花括号
    - 合理使用括号，不要盲目依赖操作符优先级
    - 避免使用continue和break.*这一条对switch...case中的break不适用*
   

6. 写直观的代码

    即使嵌套if也不要使用多重的&&和||
   

7. 写无懈可击的代码

    if语句分支最好考虑到极端状况，也就是说最好要有else，在里面处理一些东西。
   

8. 正确处理错误

    异常需要去处理，而不是仅仅的抛出。
   

9. 正确处理null指针

    - 尽量不要产生null指针。尽量不要用null来初始化变量，函数尽量不要返回null
    - 不要`catch NullPointerException`。在可能出现null的地方检查一下，然后处理
    - 不要把null放进“容器数据结构”里面
    - 函数调用者：明确理解null所表示的意义，尽早检查和处理null返回值，减少它的传播。
    - 函数作者：明确声明不接受null参数，当参数是null时立即崩溃。
    - 使用@NotNull和@Nullable标记。
    - 使用Optional类型。*这个目前不需要，因为java8里面很蹩脚*
   

10. 防止过度工程

    - 先把眼前的问题解决掉，解决好，再考虑将来的扩展问题。
    - 先写出可用的代码，反复推敲，再考虑是否需要重用的问题。
    - 先写出可用，简单，明显没有bug的代码，再考虑测试的问题。