浅谈如何提高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 相关文章推荐
PHP在字符断点处截断文字的实现代码
Apr 21 PHP
php中的curl_multi系列函数使用例子
Jul 29 PHP
微信公众平台消息接口校验与消息接口响应实例
Dec 23 PHP
Laravel模板引擎Blade中section的一些标签的区别介绍
Feb 10 PHP
smarty模板引擎之内建函数用法
Mar 30 PHP
PHP设计模式之适配器模式代码实例
May 11 PHP
详解PHP数组赋值方法
Nov 07 PHP
yii实现model添加默认值的方法(2种方法)
Jan 06 PHP
Yii2增删改查之查询 where参数详细介绍
Aug 08 PHP
利用php获得flv视频长度的实例代码
Oct 26 PHP
php7 新增功能实例总结
May 25 PHP
PHP实现本地图片转base64格式并上传
May 29 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下Memcached入门实例解析
2015/01/05 PHP
Laravel 实现Eloquent模型分组查询并返回每个分组的数量 groupBy()
2019/10/23 PHP
从sohu弄下来的flash中展示图片的代码
2007/04/27 Javascript
javascript flash下fromCharCode和charCodeAt方法使用说明
2008/01/12 Javascript
JavaScript中的私有/静态属性介绍
2012/07/26 Javascript
解读JavaScript中 For, While与递归的用法
2013/05/07 Javascript
javascript 面向对象封装与继承
2014/11/27 Javascript
JQuery实现图片轮播效果
2015/09/15 Javascript
详解Backbone.js框架中的模型Model与其集合collection
2016/05/05 Javascript
简单实现js菜单栏切换效果
2017/03/04 Javascript
vue + element-ui实现简洁的导入导出功能
2017/12/22 Javascript
Vue中render函数的使用方法
2018/01/31 Javascript
微信小程序之自定义组件的实现代码(附源码)
2018/08/02 Javascript
小程序扫描普通链接二维码跳转小程序指定界面方法
2019/05/07 Javascript
微信小程序如何使用云开发
2019/05/17 Javascript
ES6 Iterator接口和for...of循环用法分析
2019/07/31 Javascript
swiper4实现移动端导航切换
2020/10/16 Javascript
使用webpack将ES6转化ES5的实现方法
2019/10/13 Javascript
vue 解决computed修改data数据的问题
2019/11/06 Javascript
[03:22]DAC最前线(第二期)—DOTA2亚洲邀请赛主赛场周边及线路探访
2015/01/24 DOTA
[03:37]2015国际邀请赛第四日现场精彩集锦
2015/08/08 DOTA
[01:12:53]完美世界DOTA2联赛PWL S2 Forest vs SZ 第一场 11.25
2020/11/26 DOTA
详解Python3中的Sequence type的使用
2015/08/01 Python
用Python写一段用户登录的程序代码
2018/04/22 Python
Python利用itchat库向好友或者公众号发消息的实例
2019/02/21 Python
Python序列对象与String类型内置方法详解
2019/10/22 Python
如何利用python web框架做文件流下载的实现示例
2020/06/02 Python
用html5绘制折线图的实例代码
2016/03/25 HTML / CSS
HTML5 拖放功能实现代码
2016/07/14 HTML / CSS
KLOOK客路:发现更好玩的世界,预订独一无二的旅行体验
2016/12/16 全球购物
在校生汽车维修实习自我鉴定
2013/09/19 职场文书
三八节标语
2014/06/27 职场文书
一年级班主任工作总结2014
2014/11/08 职场文书
2014年党委工作总结
2014/11/22 职场文书
读书笔记格式
2015/07/02 职场文书
手术室消毒隔离制度
2015/08/05 职场文书