浅谈如何提高PHP代码质量之单元测试


Posted in PHP onMay 28, 2021

1、单元测试

通过实现单一责任原则(我们的代码应该只关注功能的单个部分),我们将确保在测试期间,我们只会同时关注项目的一小部分

通过使用 Liskov 替换原则和依赖倒置原则,我们的代码不会关心我们是否注入模拟依赖关系,只要它们实现了适当的接口

在单元测试中,我们确实希望用模拟对象替换所有依赖的服务,因此我们一次只测试一个类。但模拟是什么?它们是实现与其他对象相同的接口的对象,但它们的行为是受控的。例如,假设我们在创建一个价格比较服务,我们利用另一个服务来获取当前的汇率。在测试我们的比较器时,我们可以使用一个模拟对象来为特定的货币返回特定的汇率,因此我们的测试既不依赖也不调用真正的服务。

2、应该使用哪个框架?

有几个好的框架可以达到这个目的。最常见的可能是 PHPUnit。在我的工作中,我发现使用行为方法来编写测试会带来更好的结果,并使我更急切地编写测试。对于我们的项目,我们选择 phpspec。

安装过程相当简单 - 只需使用:

$ php composer.phar require --dev phpspec/phpspec

然后,如果你在本文的第一部分中配置了 PHing,那么你可以在 build.xml 中添加构建目标:

<target name="phpspec">
	<exec executable="bin/phpspec" passthru="true" checkreturn="true">
		<arg line="run --format=pretty" />
	</exec>
</target>...
<target name="run" depends="phpcs,phpcpd,phan,phpspec" />

然后,你必须为你想要测试的每个服务类创建一个测试类。让 PHPSpec 非常容易使用的是模型创建。你只需使用严格的输入,就可以将模拟对象声明为测试函数的参数。PHPSpec 会自动为你创建模拟。让我们看一下代码示例:

//spec/Domain/PriceComparatorSpec.php
<?php
namespace spec\Domain;
use Domain\Price;use Domain\PriceConverter;
use PhpSpec\ObjectBehavior;
class PriceComparatorSpec extends ObjectBehavior{
	public function let(PriceConverter $converter)    {       
		$this->beConstructedWith($converter);   
	} 
	public function it_should_return_equal()    {   
		$price1 = new Price(100, 'EUR');     
		$price2 = new Price(100, 'EUR');   
		$this->compare($price1, $price2)->shouldReturn(0);
	}    
	public function it_should_convert_first(PriceConverter $converter) {   
		$price1 = new Price(100, 'EUR');    
		$price2 = new Price(100, 'PLN');    
		$priceConverted = new Price(25, 'EUR');    
		$converter->convert($price2, 'EUR')->willReturn($priceConverted);  
		$this->compare($price1, $price2)->shouldReturn(1); 
	}
}

这里有三个函数:

  • let( ) - 它允许使用依赖来初始化服务
  • 两个 it_* 函数实现测试。其中一种方法是使用模拟 $priceConverter 的方法实现 priceConverter 接口,该接口被注入到测试对象的创建中。

你可以看到创建模拟非常容易。你所需要做的就是将它定义为测试函数的参数,并通过指定在执行代码时应该运行哪些函数来配置 mock。如果需要,你还可以设置返回值。

所有测试的方法都是从 $this 上下文中运行的,你可以使用与模拟相同的语法来轻松地检查它们的结果。

3、如何设置测试?

Phpspec 有一个很好的文档,但是我将尝试向你展示一些在日常实践中有用的基本用例。

构建测试对象

一般来说,设置测试对象的最简单方法是调用 $this->beConstructedWith(…) 方法,该方法将所有应该传递给对象构造函数的 params 作为参数。

如果你的对象应该使用工厂方法来创建,那么你可以使用

this−>beConstructedThrough(this−>beConstructedThrough(methodName,$argumentsArray)方法。

在模拟中匹配运行时参数

你会发现 phpspec 使用一种非常类似于人类的语法来配置模拟。例如,如果你想要检查在运行时是否有一个模拟方法 someMethod 与参数“desired value”被调用,你可以在测试中定义它,如下面的例子:

$mockObject->someMethod("desired value")->shouldBeCalled();

如果你想要测试代码的行为,当一些 mock 的函数返回“some value”时,你可以通过调用来轻松地设置它:

$mockObject->someFunction("some input")->willReturn("some value");

有时我们并不真正关心传递给 mock 的确切参数。然后可以写这段代码:

use Prophecy\Argument\Token\AnyValueToken;
$mockObject->someFunction(new AnyValueToken())->willReturn(true);

有时你会关心一些参数,最好是写一个检查函数,它会告诉你是否正确地调用了一些方法,例如:

use Prophecy\Argument\Token\CallbackToken;
$checker = function (Message $message) use ($to, $text) {  
	return $message->to === $to && $message->text === $text;
};
$msgSender->send(new CallbackToken($messageChecker))->shouldBeCalled()

匹配运行时异常

。在某些情况下,异常是代码接口的一部分。你希望它们在特定的场景被抛出。你可以通过编写以下代码来完成这项工作:

$this->shouldThrow(\DomainException::class)->during('execute', [$command, $responder]);

传给 during() 的第一个参数是将要调用的方法的名称,第二个参数是将传递给我们的方法的参数数组。

4、在哪里可以找到更多的例子?

在本文中,我们只介绍了一些基本的用例。请参考 phpspec 的文档,以找到更多的示例,这些示例将使你的测试代码变得漂亮!

代码覆盖率

PHPSpec 附带了扩展子系统,它允许例如创建代码覆盖率报告。如果您想要检查在测试中执行了多少代码,它们是很有帮助的。

你可以通过以下来安装这个扩展:

$ php composer.phar require --dev leanphp/phpspec-code-coverage

然后通过创建 phpspec 来启用它。yml 文件内容:

1 extensions: LeanPHP\PhpSpec\CodeCoverage\CodeCoverageExtension: ~

默认情况下,这个扩展会使用 PHP 的 Xdebug 扩展生成代码覆盖率信息,但是 PHP 的本机调试器 - phpdbg 会更快速一些:

$ phpdbg -qrr phpspec run

现在,你可以在 build 中更改 phpspec 的构建目标。xml:

<target name="phpspec">
	<exec executable="phpdbg" passthru="true" checkreturn="true">
		<arg line="-qrr bin/phpspec run --format=pretty" />
	</exec>
</target>...
<target name="run" depends="phpcs,phpcpd,phan,phpspec" />

报告在覆盖率 / 目录中生成,作为漂亮的 HTML 页面,可以浏览以检查测试覆盖率。

以上就是浅谈如何提高PHP代码质量之单元测试的详细内容,更多关于如何提高PHP代码质量之单元测试的资料请关注三水点靠木其它相关文章!

PHP 相关文章推荐
1.PHP简介
Oct 09 PHP
模拟OICQ的实现思路和核心程序(一)
Oct 09 PHP
php SQL之where语句生成器
Mar 24 PHP
用php实现的下载css文件中的图片的代码
Feb 08 PHP
PHP 开发环境配置(测试开发环境)
Apr 28 PHP
PHP中使用unset销毁变量并内存释放问题
Jul 05 PHP
php下拉选项的批量操作的实现代码
Oct 14 PHP
php resizeimage 部分jpg文件 生成缩略图失败的原因分析及解决办法
Mar 23 PHP
PHP微信分享开发详解
Jan 14 PHP
简单谈谈PHP面向对象之标识对象
Jun 27 PHP
使用PHP+MySql实现微信投票功能实例代码
Sep 29 PHP
PHP设计模式(四)原型模式Prototype实例详解【创建型】
May 02 PHP
浅谈如何提高PHP代码的质量
May 28 #PHP
详解thinkphp的Auth类认证
May 28 #PHP
如何理解PHP核心特性命名空间
May 28 #PHP
如何用Laravel包含你自己的帮助函数
May 27 #PHP
详解Laravel框架的依赖注入功能
May 27 #PHP
详解PHP Swoole与TCP三次握手
May 27 #PHP
如何用PHP实现分布算法之一致性哈希算法
You might like
php调用方法mssql_fetch_row、mssql_fetch_array、mssql_fetch_assoc和mssql_fetch_objcect读取数据的区别
2012/08/08 PHP
页面利用渐进式JPEG来提升用户体验度
2014/12/01 PHP
JavaScript 用Node.js写Shell脚本[译]
2012/09/20 Javascript
JS通过ajax动态读取xml文件内容的方法
2015/03/24 Javascript
充分发挥Node.js程序性能的一些方法介绍
2015/06/23 Javascript
JavaScript编程中的Promise使用大全
2015/07/28 Javascript
分享js粘帖屏幕截图到web页面插件screenshot-paste
2020/08/21 Javascript
jQuery基础的工厂函数以及定时器的经典实例分析
2016/05/20 Javascript
详解AngularJs ui-router 路由的简单介绍
2017/04/26 Javascript
基于LayUI分页和LayUI laypage分页的使用示例
2017/08/02 Javascript
深入理解 webpack 文件打包机制(小结)
2018/01/08 Javascript
vue中promise的使用及异步请求数据的方法
2018/11/08 Javascript
Vue.js组件使用props传递数据的方法
2019/10/19 Javascript
JavaScript 链表定义与使用方法示例
2020/04/28 Javascript
[02:43]2018DOTA2亚洲邀请赛主赛事首日TOP5
2018/04/04 DOTA
python对象及面向对象技术详解
2016/07/19 Python
简单实现python画圆功能
2018/01/25 Python
Python程序包的构建和发布过程示例详解
2019/06/09 Python
Python matplotlib学习笔记之坐标轴范围
2019/06/28 Python
python获取栅格点和面值的实现
2020/03/10 Python
Django values()和value_list()的使用
2020/03/31 Python
解决Jupyter Notebook开始菜单栏Anaconda下消失的问题
2020/04/13 Python
Python基于当前时间批量创建文件
2020/05/07 Python
python Yaml、Json、Dict之间的转化
2020/10/19 Python
自我介绍演讲稿
2014/01/15 职场文书
英语生日邀请函
2014/01/23 职场文书
咖啡蛋糕店创业计划书
2014/01/28 职场文书
科研课题实施方案
2014/03/18 职场文书
乡镇交通安全实施方案
2014/03/29 职场文书
化学专业毕业生求职信
2014/07/28 职场文书
工作疏忽、懈怠的检讨书
2014/09/11 职场文书
五年级学生期末评语
2014/12/26 职场文书
喋血孤城观后感
2015/06/08 职场文书
高中班主任培训心得体会
2016/01/07 职场文书
使用CSS实现小三角边框原理解析
2021/11/07 HTML / CSS
MySQL数据库之存储过程 procedure
2022/06/16 MySQL