关于PHP 单元测试，你了解多少？（上）

lsekfe

朋友，你听说过安。。。不是，写过单元测试吗。
　　单元测试是开发过程中必不可少的一环，一个项目有良好的单元测试代码，重构的勇气都大很多。这次写一篇小文来介绍一下 PHP 的单元测试工具 PHPUnit 的使用。
　　PHPUnit 的使用并不难，这篇文章主要还是充当一个引子，介绍基本概念和使用，有了这篇文章的基础之后，去看官网的文档就会更加顺风顺水。
　　安装
　　安装 PHPUnit 的方式很简单，使用 composer 可以一行代码就可以安装。

1. composer require --dev phpunit/phpunit

复制代码

安装之后，在 vendor/bin 目录下有一个 phpunit 的可执行文件，这个就是 phpunit 本体了。假设我们项目的目录结构如下：

1. ➜  phpunit tree .
   
2. 
   
3. ├── controller
   
4. ├── model
   
5. ├── service
   
6. ├── test
   
7. └── vendor
   
8. ├── composer.json

复制代码

　其中我们的单元测试代码都放在 test 目录下。使用 composer 来为我们解决 autoload 的问题。

1. {
   
2.   "autoload": {
   
3.     "psr-4": {
   
4.       "Controller\\": "controller/",
   
5.       "Model\\": "model/",
   
6.       "Service\\": "service/",
   
7.       "Test\\": "test/",
   
8.     }
   
9.   },
   
10. }

复制代码

　如果你还不懂 composer 自动加载的使用，可以参考这篇文章。最后执行 composer dumpautoload -o 让自动加载生效。
　　到这里我们的安装就算结束了。如果你使用 phpstorm 进行开发，那么你需要进行如下的配置：

　这里指明了从哪里加载 PHPUnit，由于我们使用 composer 安装，所以，这里的文件选择 composer 生成的 autoload.php 文件即可。

　　使用
　　好了，假设我们现在进行开发，在 service 目录中添加了一个 CalculateService 的文件，并且编写了一个 abs 的函数。

1. namespace Service;
   
2. 
   
3. class CalculateService
   
4. {
   
5.     public function abs($num)
   
6.     {
   
7.         return abs($num);
   
8.     }
   
9. }

复制代码

　现在我们对 abs 函数进行单元测试，PHPUnit 规定了一个测试类必须遵守如下的规定：
　　单元测试类名必须以 Test 结尾，必须继承 \PHPUnit\Framework\TestCase 基类。
　　每个测试函数必须以 test 开头。
　　上面的规定是必须遵守的，如果代码没有遵守规定 PHPUnit 不会把他当做单元测试代码。除了以上的两条，还有一些良好的编码习惯可以参考：
　　单元测试代码都放在 test 目录下。
　　每个单元测试类以被测试的类名开头。例如被测试类为 CalculateService，那么单元测试类应该为 CalculateServiceTest。
　　每个单元测试函数应该为被测试函数名结尾。例如被测试函数为 abs，那么单元测试函数应该为 testAbs。
　　根据上面的规范，编写单元测试代码：

1. class UserServiceTest extends \PHPUnit\Framework\TestCase
   
2. {
   
3.     public function testAbs()
   
4.     {
   
5.         $userService = new \Service\CalculateService();
   
6.         $this->assertEquals(4, $userService->abs(4));
   
7.     }
   
8. }

复制代码

在上面的测试代码中，调用了我们要测试的函数 abs，然后断言 $userService->abs(4) 的结果为 4。在 phpstorm 中直接在 testAbs 函数处右键选择 run UserServiceTest 执行：

发现在控制台会输出如下内容

1. Time: 17 ms, Memory: 4.00MB
   
2. 
   
3. OK (1 test, 1 assertion)

复制代码

表明 abs 通过了 $userService->abs(4) == 4 的测试用例。这里注意一点，这里并不表明 abs 函数已经通过测试，一个良好的测试应该包含多个测试用例来覆盖尽可能多的可能性。、