给 PHP 开发者的编程指南－第一部分: 降低复杂程度

admin PHP 暂无评论 931 浏览

本系列的介绍

PHP 是一门自由度很高的编程语言。它是动态语言，对程序员有很大的宽容度。作为 PHP 程序员，要想让你的代码更有效，需要了解不少的规范。很多年来，我读过很多编程方面的书籍，与很多资深程序员也讨论过代码风格的问题。具体哪条规则来自哪本书或者哪个人，我肯定不会都记得，但是本文(以及接下来的另一篇文章) 表达了我对于如何写出更好的代码的观点：能经得起考验的代码，通常是非常易读和易懂的。这样的代码，别人可以更轻松的查找问题，也可以更简单的复用代码。

降低函数体的复杂度

在方法或者函数体里，尽可能的降低复杂性。相对低一些的复杂性，可以便于别人阅读代码。另外，这样做也可以减少代码出问题的可能性，更易修改，有问题也更易修复。

在函数里减少括号数量

尽可能少的使用 if, elseif, else 和 switch 这些语句。它们会增加更多的括号。这会让代码更难懂、更难测试一些（因为每个括号都需要有测试用例覆盖到）。总是有办法来避免这个问题的。

代理决策 ("命令，不用去查询(Tell, don't ask)")

有的时候 if 语句可以移到另一个对象里，这样会更清晰些。例如：

  if($a->somethingIsTrue()) {
   $a->doSomething();
  }

可以改成:

                    $a->doSomething();

这里，具体的判断由 $a 对象的 doSomething() 方法去做了。我们不需要再为此做更多的考虑，只需要安全的调用 doSomething() 即可。这种方式优雅的遵循了命令，不要去查询原则。我建议你深入了解一下这个原则，当你向一个对象查询信息并且根据这些信息做判断的时候都可以适用这条原则。

使用map

有时可以用 map 语句减少 if, elseif 或 else 的使用，例如：

1 if($type==='json') {
2     return $jsonDecoder->decode($body);
3 }elseif($type==='xml') {
4     return $xmlDecoder->decode($body);
5 }else{
6     throw new \LogicException(
7         'Type "'.$type.'" is not supported'
8     );
9 }

可以精简为：

1 $decoders= ...;// a map of type (string) to corresponding Decoder objects
2  
3 if(!isset($decoders[$type])) {
4     thrownew\LogicException(
5         'Type "'.$type.'" is not supported'
6     );
7 }

这样使用 map 的方式也让你的代码遵循扩展开放，关闭修改的原则。

强制类型

很多 if 语句可以通过更严格的使用类型来避免，例如：

1 if($a instanceof A) {
2     // happy path
3     return $a->someInformation();
4 }elseif($a=== null) {
5     // alternative path
6     return 'default information';
7 }

可以通过强制 $a 使用 A 类型来简化：

1 return $a->someInformation();

当然，我们可以通过其他方式来支持 "null" 的情况。这个在后面的文章会提到。

Return early

很多时候，函数里的一个分支并非真正的分支，而是前置或者后置的一些条件，就像这样：

1 // 前置条件
2 if(!$a instanceof A) {
3     throw new \InvalidArgumentException(...);
4 }
5  
6 // happy path
7 return $a->someInformation();

这里 if 语句并不是函数执行的一个分支，它只是对一个前置条件的检查。有时我们可以让 PHP 自身来完成前置条件的检查(例如使用恰当的类型提示)。不过，PHP 也没法完成所有前置条件的检查，所以还是需要在代码里保留一些。为了降低复杂度，我们需要在提前知道代码会出错时、输入错误时、已经知道结果时尽早返回。

尽早返回的效果就是后面的代码没必要像之前那样缩进了:

01 // check precondition
02 if(...) {
03     thrownew...();
04 }
05  
06 // return early
07 if(...) {
08     return...;
09 }
10  
11 // happy path
12 ...
13  
14 return...;

像上面这个模板这样，代码会变动更易读和易懂。

创建小的逻辑单元

如果函数体过长，就很难理解这个函数到底在干什么。跟踪变量的使用、变量类型、变量声明周期、调用的辅助函数等等，这些都会消耗很多脑细胞。如果函数比较小，对于理解函数功能很有帮助（例如，函数只是接受一些输入，做一些处理，再返回结果）。

使用辅助函数

在使用之前的原则减少括号之后，你还可以通过把函数拆分成更小的逻辑单元做到让函数更清晰。你可以把实现一个子任务的代码行看做一组代码，这些代码组直接用空行来分隔。然后考虑如何把它们拆分成辅助方法（即重构中的提炼方法）。

辅助方法一般是 private 的方法，只会被所属的特定类的对象调用。通常它们不需要访问实例的变量，这种情况需要定义为 static 的方法。在我的经验中，private (static)的辅助方法通常会汇总到分离的类中，并且定义成 public (static 或 instance)的方法，至少在测试驱动开发的时候使用一个协作类就是这种情形。

减少临时变量

长的函数通常需要一些变量来保存中间结果。这些临时变量跟踪起来比较麻烦：你需要记住它们是否已经初始化了，是否还有用，现在的值又是多少等等。

上节提到的辅助函数有助于减少临时变量：

1 public function capitalizeAndReverse(array $names) {
2     $capitalized = array_map('ucfirst', $names);
3     $capitalizedAndReversed = array_map('strrev', $capitalized);
4     return $capitalizedAndReversed;
5 }

使用辅助方法，我们可以不用临时变量了：

01 public function capitalizeAndReverse(array $names) {
02     return self::reverse(
03         self::capitalize($names)
04     );
05 }
06  
07 private static function reverse(array $names) {
08     return array_map('strrev', $names);
09 }
10  
11 private static function capitalize(array $names) {
12     return array_map('ucfirst', $names);
13 }

正如你所见，我们把函数变成新函数的组合，这样变得更易懂，也更容易修改。某种方式上，代码还有点符合“扩展开放/修改关闭”，因为我们基本上不需要再修改辅助函数。

由于很多算法需要遍历容器，从而得到新的容器或者计算出一个结果，此时把容器本身当做一个“一等公民”并且附加上相关的行为，这样做是很有意义的：

01 classNames
02 {
03     private $names;
04  
05     public function __construct(array $names)
06     {
07         $this->names = $names;
08     }
09  
10     public function reverse()
11     {
12         return new self(
13             array_map('strrev', $names)
14         );
15     }
16  
17     public function capitalize()
18     {
19         return new self(
20             array_map('ucfirst', $names)
21         );
22     }
23 }
24  
25 $result = (newNames([...]))->capitalize()->reverse();

这样做可以简化函数的组合。

虽然减少临时变量通常会带来好的设计，不过上面的例子中也没必要干掉所有的临时变量。有时候临时变量的用处是很清晰的，作用也是一目了然的，就没必要精简。

    使用简单的类型

追踪变量的当前取值总是很麻烦的，当不清楚变量的类型时尤其如此。而如果一个变量的类型不是固定的，那简直就是噩梦。

    数组只包含同一种类型的值

使用数组作为可遍历的容器时，不管什么情况都要确保只使用同一种类型的值。这可以降低遍历数组读取数据的循环的复杂度：

1 foreach($collection as $value) {
2     // 如果指定$value的类型，就不需要做类型检查
3 }

你的代码编辑器也会为你提供数组值的类型提示：

1 /**
2  * @param DateTime[] $collection
3  */
4 public function doSomething(array $collection) {
5     foreach($collection as $value) {
6         // $value是DateTime类型
7     }
8 }

而如果你不能确定 $value 是 DateTime 类型的话，你就不得不在函数里添加前置判断来检查其类型。beberlei/assert库可以让这个事情简单一些：

1 useAssert\Assertion
2  
3 public function doSomething(array $collection) {
4     Assertion::allIsInstanceOf($collection, \DateTime::class);
5  
6     ...
7 }

如果容器里有内容不是 DateTime 类型，这会抛出一个 InvalidArgumentException 异常。除了强制输入相同类型的值之外，使用断言（assert）也是降低代码复杂度的一种手段，因为你可以不在函数的头部去做类型的检查。

简单的返回值类型

只要函数的返回值可能有不同的类型，就会极大的增加调用端代码的复杂度：

1 $result= someFunction();
2 if($result=== false) {
3     ...
4 }else if(is_int($result)) {
5     ...
6 }

PHP 并不能阻止你返回不同类型的值（或者使用不同类型的参数）。但是这样做只会造成大量的混乱，你的程序里也会到处都充斥着 if 语句。

下面是一个经常遇到的返回混合类型的例子：

1 /**
2  * @param int $id
3  * @return User|null
4  */
5 public function findById($id)
6 {
7     ...
8 }

这个函数会返回 User 对象或者 null，这种做法是有问题的，如果不检查返回值是否合法的 User 对象，我们是不能去调用返回值的方法的。在 PHP 7之前，这样做会造成"Fatal error"，然后程序崩溃。

下一篇文章我们会考虑 null，告诉你如何去处理它们。

可读的表达式

我们已经讨论过不少降低函数的整体复杂度的方法。在更细粒度上我们也可以做一些事情来减少代码的复杂度。

隐藏复杂的逻辑

通常可以把复杂的表达式变成辅助函数。看看下面的代码：

1 if(($a||$b) &&$c) {
2     ...
3 }

可以变得更简单一些，像这样：

1 if(somethingIsTheCase($a,$b,$c)) {
2     ...
3 }

阅读代码时可以清楚的知道这个判断依赖 $a, $b 和 $c 三个变量，而函数名也可以很好的表达判断条件的内容。

使用布尔表达式

if 表达式的内容可以转换成布尔表达式。不过 PHP 也没有强制你必须提供 boolean 值：

1 $a=new\DateTime();
2 ...
3  
4 if($a) {
5     ...
6 }

$a 会自动转换成 boolean 类型。强制类型转换是 bug 的主要来源之一，不过还有一个问题是会对代码的理解带来复杂性，因为这里的类型转换是隐式的。PHP 的隐式转换的替代方案是显式的进行类型转换，例如：

1 if($a instanceof DateTime) {
2     ...
3 }

如果你知道比较的是 bool 类型，就可以简化成这样：

1 if($b=== false) {
2     ...
3 }

使用 ! 操作符则还可以简化：

1 if(!$b) {
2     ...
3 }

不要 Yoda 风格的表达式

Yoda 风格的表达式就像这样：

1 if('hello'===$result) {
2     ...
3 }

这种表达式主要是为了避免下面的错误：

1 if($result='hello') {
2     ...
3 }

这里 'hello' 会赋值给 $result，然后成为整个表达式的值。'hello' 会自动转换成 bool 类型，这里会转换成 true。于是 if 分支里的代码在这里会总是被执行。

使用 Yoda 风格的表达式可以帮你避免这类问题：

1 if('hello'=$result) {
2     ...
3 }

我觉得实际情况下不太会有人出现这种错误，除非他还在学习 PHP 的基本语法。而且，Yoda 风格的代码也有不小的代价：可读性。这样的表达式不太易读，也不太容易懂，因为这不符合自然语言的习惯。

进一步的阅读

如果你打算进一步了解代码及如何对其进行优化，推荐下面这些书：

  • 代码大全，Steve McConnell
  • 代码整洁之道，Robert C. Martin
  • 重构，Martin Fowler

下一篇文章我们会讨论一个引起代码更复杂的特殊的罪魁祸首：null。

相关博文

给 PHP 开发者的编程指南－第一部分: 降低复杂程度
赏
标签: