写出结构优雅代码的4个技巧

写出结构优雅代码就像成为武林高手一样，需要积累思考勤学苦练。冰冻三尺非一日之寒。成熟的业界套路肯定是没有的，因为代码也有思想流派。现在是百家齐放的时代。code review时，一个不留神就会吵起来。

我在网上找了一下资料基本都是《代码整洁之道》、《重构：改善既有代码的设计》和《代码之美》这三本书里的内容。建议还是自己看书。可以在【编程一生】公众号里回复：666  获取我的经典电子藏书，这三本书都在里面。

下面有一些我自己的总结，前三个别的书中没有。

使用切面将业务逻辑与其他方面解耦

最简洁优雅的代码就是只做一件事的代码。很多与业务无关的逻辑，如日志、事务都可以使用切面。

为了避免抽象，这里详细介绍怎么用切面打印结构化日志。不感兴趣的可以直接跳过，不影响整篇理解。

结构化日志，顾名思义不再是自由格式的日志，而是遵循了一定的结构：每一行日志遵循相同的结构。好处显而易见：简化日志解析，使得日志的后续处理、分析或查询变得方便高效。一般用在需要集中采集到日志服务器上，用来在监控中显示和做数据分析。数仓领域有数据湖的概念，集中采用可以叫做数据入湖。

在分布式环境下，一般都需要结构化日志采集。一旦发生问题，从监控上至少要能定位问题出现在哪台机器上，然后再去机器上查所有日志。

因此，结构化日志一般是方法的开头和结尾都打印，或者只在结尾打印两种方式。因此非常合适用切面处理。问题来了，方法执行结果怎样切面怎么知道呢？

具体代码我之前有上传github，《简明日志规范》里也有相应的介绍，这里只说重点。

首先，在Java等语言的切面中是可以拿到方法的返回结果的，如：

business = pjp.proceed();

business 就是返回结果。

其次，代码中可以进行埋点。定义埋点可以使用面向对象的形式，向对象赋值即可。

但是打印日志打印的最后不是字符串吗？可以使用充血模型在日志构造器中用反射定义对象转格式化日志的通用方法：

整个对象可以使用ThreadLocal保存在线程的生命周期中，切面可以从ThreadLocal中获取数据执行打印。

代码使用时需要特殊赋值的地方直接进行赋值，其他事情不需要关心。效果如下：

完整的代码我择期更新到github上，其实除了最后这个使用的地方，我写的都是通用的，直接拿来用即可。看在女生节的份上，让我犯犯懒，最近先不更新。其实我也不是真的懒，女生节要到了，有很多活动要推掉。上班时间不处理，周末了总得委婉的回复一下。

PS：这种活动我都不参加，请各位编辑、运营小姐姐们不要找我了哈，咱不蹭热度~~

写有风格的代码

在《代码荣辱观-以运用风格为荣，以随意编码为耻》中我有详尽的说明和代码讲解，文章风格与代码风格相得益彰，强烈推荐大家再读一遍。

巧用语法糖

一个巧字，暗示着需要深入的理解。只有学的深，才能用的巧。在《深入理解函数式编程》中我有详尽的说明和代码讲解，这也是自己满意的文章之一，请大家参阅。

《代码整洁之道》中提炼的技巧

书中详细介绍，这里做总结，有兴趣可以自己看书。可在【编程一生】公众号中留言：代码整洁之道。就可以获取完整电子书。

注释

• 不要给不好的名字加注释，一个好的名字比好的注释更重要

• 不要“拐杖注释”，好代码 > 坏代码 + 好注释

• 在文件/类级别使用全局注释来解释所有部分如何工作

• 一定要给常量加注释

• 团队统一定义标记
  

  • TODO  待处理的问题

  • FIXME  已知有问题的代码

  • HACK 不得不采用的粗糙的解决方案

• 在注释中用精心挑选的输入输出例子进行说明

• 注释应该声明代码的高层次意图，而非明显的细节

• 不要在代码中加入代码的著作信息，git可以干的事情不要交给代码

• 源代码中的html注释是一种厌物, 增加阅读难度

• 注释一定要描述离它最近的代码

• 注释一定要与代码对应

• 公共api需要添加注释，其它代码谨慎使用注释

• 典型的烂注释
  

  • 不恰当的信息

  • 废弃的注释

  • 冗余注释

  • 糟糕的注释

  • 注释掉的代码

• 唯一真正好的注释是你想办法不去写的注释
  

  • 不要有循规式注释，比如setter/getter注释

  • 不要添加日志式注释，比如修改时间等信息（git可以做的事情）

  • 注释一定是表达代码之外的东西，代码可以包含的内容，注释中一定不要出现

  • 如果有必要注释，请注释意图（why），而不要去注释实现（how)，大家都会看代码

  • 适当添加警示注释

命名

• 尽可能使用标准命名方法，比如设计模式，通用学术名词等

• 命名要找更有表现力的词
  

  • 使用更专业的词，比如不用get而使用fetch或者download

  • 避免空泛的名字，像tmp

  • 使用具体的名字来细致的描述事物

  • 给变量名带上重要的细节，比如加上单位ms等

  • 为作用域大的名字采用更长的名字，作用域小的使用短名字

  • 变量类型为布尔值表达加上is，has，can，should这样的词会更明确

• 变量名称长短应该与其作用域对应

• 别害怕长名称，长而具有描述性的名称比短而令人费解的名称好

• 函数名称应该说明副作用，名称应该表达函数，变量或类的一切信息，请不要掩盖副作用，比如CreateAndReturnXXX

方法

• 函数不应该有100行那么长，20行封顶最好
  

  • if else while等控制语句其中代码块应该只有一行，也就是一个函数调用语句

  • 函数的锁进层次不应该多于两层

  • 一个函数只做一件事，一个函数不应该能抽象出另外一个函数

• 某个公共函数调用的私有函数紧随其后

• 最理想的参数是零参数，最长不要超过三个入参，尽量不要输出参数
  

  • 如果函数传入三个及以上参数最好将其抽象为类

  • 标识参数十分丑陋，向函数传入布尔值用于区分不同业务的做法很丑陋，应该拆分为多个函数

• 别返回null值，抛出异常或者返回特殊对象，尽量避免NPE

• 别传入null值

异常与错误

• 抽离try catch包含的代码块，其中代码块抽象为一个函数

• 抛出的每个异常，都应当提供足够的环境说明，已便判断错误的来源与处所

• 不要将系统错误归咎于偶然事件

并发

• 分离并发相关代码与其它代码

• 严格限制对可能被共享的数据的访问

• 避免使用一个共享对象的多个同步方法

• 保持同步区域微小，尽可能少设计临界区

单元测试

• 不要怕单元测试的方法名字太长或者繁琐，测试函数的名称就像注释

• 不要追求太高的测试覆盖率，测试代码前面90%通常比后面10%花的时间少

• 使用最简单的并且能够完整运用代码的测试输入

• 给测试函数取一个完整性的描述性名字，比如  Test _

• 测试代码与生产代码一样重要

• 如果测试代码不能保证整洁，你就会很快失去他们

• 每个测试一个断言，单个测试中断言数量应该最小化也就是一个断言

• FIRST原则
  

  • 快速 Fast

  • 独立 Independent  测试应该相互独立

  • 可重复 Repeatable  测试应当在任何环境中重复通过

  • 自足验证 Self-Validating   测试应该有布尔值输出

  • 及时  Timely   最好的方式是TDD

代码结构

• 代码行长度控制在100-120个字符

• 可能用大多数为200行，最长500行的单个文件构造出色的系统

• 关系密切的代码应该相互靠近
  

  • 变量声明应该靠近其使用位置

  • 若某个函数调用了另外一个，应该把他们放在一起，而且调用者应该放在被调用者上面

  • 自上向下展示函数调用依赖顺序

• 应该把解释条件意图的函数抽离出来，尽可能将条件表达为肯定形式

• 不要继承常量，比如接口中定义常量，不要使用继承欺骗编程语言的作用范围规则

• 模块不应了解它所操作对象的内部情况

• DTO（Data Transfer Objects）是一个只有公共变量没有函数的类

• 对象暴露行为，隐藏数据

• 不要使用“尤达表示法” 如 if(null == obj)，现代编译器对if(obj = null)这样的代码会给出警告

• 一般情况使用if else，简单语句使用三目运算符

• 通常来讲提早返回可以减少嵌套并让代码整洁

设计

• 类应该足够短小
  

  • 类应该满足单一权责原则（SRP），类和模块只有一个修改理由

  • 类应该只有少量的实体变量

  • 类应该遵循依赖倒置原则 DIP（Dependency Inversion Principle），类应该依赖于抽象而不是依赖于具体细节

  • 类中的方法越少越好，函数知道的变量越少越好，类拥有的实体变量越少越好

• 通过减少变量的数量和让他们尽量“轻量级”来让代码更有可读性
  

  • 减少变量

  • 缩小变量的作用域

  • 只写一次的变量更好，如常量

• 最好读的代码就是没有代码
  

  • 从项目中消除不必要的功能，不要过度设计

  • 从新考虑需求，解决版本最简单的问题，只要能完成工作就行

  • 经常性地通读标准库的整个API，保持对他们的熟悉程度

• 简单设计
  

  • 运行所有测试

  • 不可重复

  • 表达了程序员的意图

  • 尽可能减少类和方法的数量

  • 以上规则按重要程度排列

• 无论是设计系统或者单独模块，别忘了使用大概可工作的最简单方案

• 整洁的代码只提供一种而非多种做一件事的途径，他只有尽量少的依赖。明确定义并提供尽量少的API

• 减少重复代码，提高表达力，提早构建，简单抽象

参考：
https://www.zhihu.com/question/28492982/answer/448474779

---

因为公众号平台更改了推送规则，如果不想错过内容，记得读完点一下“在看”，加个“星标”，这样每次新文章推送才会第一时间出现在你的订阅列表里。

PDCA方法论，检查自己是否错过更新：每周三晚上8点左右，我都会更新文章，如果你没有收到，记得点开【编程一生】公众号找一下(*^▽^*)