PHP单元测试利器 PHPUNIT深入用法(三)_php技巧

冬静姑娘_8834

冬静姑娘_8834

2016-05-17

1080人浏览

原创

在本系列文章的前两篇中php单元测试利器:phpunit初探和php单元测试利器:phpunit深入用法(二)中,分别介绍了phpunit的基本用法和phpunit中的一些重要用法。

在本文中,笔者将为大家介绍phpunit中的两个高级概念和用法,尽管它不一定在你的日常单元测试中都用到,但理解和学会它们的用法对学习phpunit还是十分重要的。

  Phpunit中的Annotations

  如果有其他编程语言经验的开发者,应该对Annotations(注解)不陌生,其实在phpunit中,一个简单的如下面的一段注释也可以认为是Annotations:

php
class
 MyTestClass 
extends
 PHPUnit_Framework_TestCase
{
/*
*
* Testing the answer to “do you love unit tests?”
*/
public
 
function
 testDoYouLoveUnitTests()
{
$love
 
=
 
true
;
$this
->
assertTrue(
$love
);
}
}
?>


   可以看到,其实一段以/** **/为标记的文字,就可以认为是一种Annotations,但Annotations其实不单单是简单的注释,它是与一个程序元素相关联信息或者元数据的标注,它不影响程序的运行,但相关的软件工具或框架能够将其转换成特殊的元数据标记,以方便开发者以更少的代码去提高效率(比如通过。如果你熟悉Java,则会发现在Java SE 5中及象Spring等框架中,都大量使用了Annotations。

  然而,由于php并不象Java那样是编译性语言,因此本身缺乏去解析Annotations的机制,但幸好phpunit去提供了这样的功能,我们以下面的代码为例:

php
class
 MyMathClass
{
/*
*
* Add two given values together and return sum
*/
public
 
function
 addValues(
$a
,
$b
)
{
return
 
$a
+
$b
;
}
}
?>


   上面的只是一个简单的加法的例子,为此,我们使用Annotations去编写一个单元测试,在上两篇文章中,我们采用的是手工编写单元测试的方法,而本文中,将介绍使用phpunit命令行的方法,自动生成单元测试的框架,方法如下:

  首先把上面的类保存为MyMathClass.php,然后在命令行下运行如下命令:

phpunit –skeleton-test MyMathClass

   这时phpunit会自动生成如下的框架单元测试代码:

php
require_once
 
'
/path/to/MyMathClass.php
'
;
/*
*
* Test class for MyMathClass.
* Generated by PHPUnit on 2011-02-07 at 12:22:07.
*/
class
 MyMathClassTest 
extends
 PHPUnit_Framework_TestCase
{
/*
*
* @var MyMathClass
*/
protected
 
$object
;
/*
*
* Sets up the fixture, for example, opens a network connection.
* This method is called before a test is executed.
*/
protected
 
function
 setUp()
{
$this
->
object
 
=
 
new
 MyMathClass;
}
/*
*
* Tears down the fixture, for example, closes a network connection.
* This method is called after a test is executed.
*/
protected
 
function
 tearDown()
{
}
/*
*
* @todo Implement testAddValues().
*/
public
 
function
 testAddValues()
{
//
 Remove the following lines when you implement this test.
$this
->
markTestIncomplete(
'
This test has not been implemented yet.
'
);
}
}
?>

   可以看到,phpunit为我们生成的单元测试代码自动引入了原来的MyMathClass.php,同时也生成了setUp和tearDown方法,但唯一的核心单元测试代码是留给了我们编写。如果想在这个基础上更快速的生成我们想要的单元测试代码,要如何实现呢?没错,就是使用annotations!我们可以在原来的MyMathClass.php中加入如下的annotations。

php
class
 MyMathClass
{
/*
*
* Add two given values together and return sum
* @assert (1,2) == 3
*/
public
 
function
 addValues(
$a
,
$b
)
{
return
 
$a
+
$b
;
}
}
?>

  然后再象上述一样在命令行运行:

  phpunit –skeleton-test MyMathClass

  这个时候会为我们生成如下的单元测试代码:

php
/*
*
* Generated from @assert (1,2) == 3.
*/
public
 
function
 testAddValues()
{
$this
->
assertEquals(
3
,
$this
->
object
->
addValues(
1
,
2
)
);
}
?>

看到了么?我们在原有的类中加入了注解@assert(1,2)==3,则phpunit自动为我们生成了正确的单元测试代码。当然,可以参考phpunit手册,学习到更多的关于@assert注解使用的规则。

  下面再举一个例子来讲解annotations。假设我们的程序中的一个方法,只是仅需要数据的输入,并且不依赖XML或者数据库提供数据源,则为了测试这个方法,我们可能想到的一个方法是在程序中设置一个测试数据集去测试,但这里介绍一个比较简单的方法,就是使用注解@dataProvider,修改MyMathClass.php如下:

php
/*
*
* Data provider for test methods below
*/
public
 
static
 
function
 provider()
{
return
 
array
(
array
(
1
,
2
,
3
)
,
array
(
4
,
2
,
6
)
,
array
(
1
,
5
,
7
)
);
}
/*
*
* Testing addValues returns sum of two values
* @dataProvider provider
*/
public
 
function
 testAddValues(
$a
,
$b
,
$sum
)
{
$this
->
assertEquals(
$sum
,
$this
->
object
->
addValues(
$a
,
$b
)
);
}
?>

   可以看到,这里使用了注解@dataProvider,指明了测试用例的数据提供者是由provider方法返回的一个数组。所以在单元测试时,数组中的第0个元素则会赋值给$a,第1个元素则会赋值给b,第3个元素则会赋值给sum,可以看到,上面的第3个数组提供的数据是不能通过单元测试的,因为1+5不等于7。

  此外,这里还简单介绍两个常用的annotations,比如@expectedException注解可以测试代码中是否正确抛出了异常,比如:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
phprequire_once 
'
PHPUnit/Framework.php
'
; 
class
 ExceptionTest 
extends
 PHPUnit_Framework_TestCase{    
/*
*  
   * @expectedException InvalidArgumentException     
*/
    
public
 
function
 testException()    {  
  }
}
?>

 这里就用注解的方法表示testException中必须抛出的异常类型为InvalidArgumentException。

  另外一个是@cover注解。它的作用是标识phpunit只为类中的哪些方法或作用域生成测试代码,比如:

/*
*
     * @covers SampleClass::publicMethod
     * @covers SampleClass::
     * @covers HelperClass<extended>
     
*/
    
public
 
function
 testMethod()
    {
        
$result
 
=
 SampleClass
::
method();
}</extended>

   则phpunit只为SampleClass类中的publicMethod方法、SampleClass类中的所有非public声明的方法和HelperClass类或者它的其中一个父类产生单元测试代码。

Phpunit中的Mocking

  在介绍Mocking前,先来看下为什么要使用Mocking。举一个数据库查询的例子,比如在某个应用中,如果要测试一个数据库的应用,但假如这个数据库的测试要耗费很多资源以及编写很复杂的单元测试的代码的话,可以尝试使用Mocking技术。举例说明如下:


php
class
 Database
{
public
 
function
 reallyLongTime()
{
$results
 
=
 
array
(
array
(
1
,
'
test
'
,
'
foo value
'
)
);
sleep
(
100
);
return
 
$results
;
}
}
?>

在上面这个例子中,我们模拟了一个数据库的操作,认为它需要运行很长时间。接下来我们编写其单元测试代码如下:

php
require_once
 
'
/path/to/Database.php
'
;
class
 DatabaseTest 
extends
 PHPUnit_Framework_TestCase
{
private
 
$db
 
=
 
null
;
public
 
function
 setUp()
{
$this
->
db 
=
 
new
 Database();
}
public
 
function
 tearDown()
{
unset
(
$this
->
db);
}
/*
*
* Test that the "really long query" always returns values
*/
public
 
function
 testReallyLongReturn()
{
$mock
 
=
 
$this
->
getMock(
'
Database
'
);
$result
 
=
 
array
(
array
(
1
,
'
foo
'
,
'
bar test
'
)
);
$mock
->
expects(
$this
->
any())
->
method(
'
reallyLongTime
'
)
->
will(
$this
->
returnValue(
$result
));
$return
 
=
 
$mock
->
reallyLongTime();
$this
->
assertGreaterThan(
0
,
count
(
$return
));
}
}
?>

   注意看这段代码中有趣的地方,这里,使用了phpunit中的getMock对象方法,这里实际上是模拟生成一个Database类的“伪实例”了,这里生成了$mock这个mock对象实例,以方便接着的单元测试中用到。接下来的这三行代码

$mock
->
expects(
$this
->
any())
->
method(
'
reallyLongTime
'
)
->
will(
$this
->
returnValue(
$result
));


 

   它们的含义为:无论方法reallyLongtime执行了多长时间,始终最后会直接返回$result这个数组的结果。这样,你就可以通过mocking技术很轻易地去实现在单元测试中,绕过某些复杂的逻辑部分,而节省大量的宝贵时间提高测试效率。

  下面的这个例子,讲解的是Mocking技术中的更高级用法Mockbuilder。依然以上面的例子说明:

php
public
 
function
 testReallyLongRunBuilder()
{
$stub
 
=
 
$this
->
getMockBuilder(
'
Database
'
)
->
setMethods(
array
(
'
reallyLongTime
'
))
->
disableAutoload()
->
disableOriginalConstructor()
->
getMock();
$result
 
=
 
array
(
array
(
1
,
'
foo
'
,
'
bar test
'
));
$stub
->
expects(
$this
->
any())
->
method(
'
reallyLongTime
'
)
->
will(
$this
->
returnValue(
$result
));
$this
->
assertGreaterThan(
0
,
count
(
$return
));
}
?>

   通过使用Mockbuilder,我们可以不用通过构造函数的方法去初始化一个mock对象。这段代码跟上一段代码的功能其实是一样的,只不过留意一下新的两个方法: disableAutoload和disableOriginalConstructor,其功能分别是禁止使用php的内置的autoload初始构造方法和禁止调用该类原有的构造函数。最后再看一个例子:

php
/*
*
* Testing enforcing the type to "array" like the "enforceTypes"
* method does via type hinting
*/
public
 
function
 ttestReallyLongRunBuilderConstraint()
{
$stub
 
=
 
$this
->
getMock(
'
Database
'
,
array
(
'
reallyLongTime
'
));
$stub
->
expects(
$this
->
any())
->
method(
'
reallyLongTime
'
)
->
with(
$this
->
isType(
'
array
'
));
$arr
 
=
 
array
(
'
test
'
);
$this
->
assertTrue(
$stub
->
 reallyLongTime (
$arr
));
}
?>

  在这里,我们使用了with方法,其中这个方法中指定了要传入的参数类型为array数组类型,最后这个断言是通过了,因为返回的的确是数组类型。

 以上就是PHP单元测试利器 PHPUNIT深入用法(三)_php技巧的内容,更多相关内容请关注PHP中文网(www.php.cn)!


php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

80

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

Postman接口请求发送教程
Postman接口请求发送教程

详细介绍Postman接口请求的创建与发送方法,涵盖GET和POST请求、URL配置、请求参数、Headers请求头、Body请求体设置以及响应结果查看,帮助用户掌握Postman接口请求的完整操作流程。

2026.11.06

120

10

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

2026.11.05

120

12

DBeaver安全防护教程大全
DBeaver安全防护教程大全

DBeaver安全防护专题,围绕数据库连接安全、账号密码保护和访问权限管理展开,整理SSL/TLS加密连接、SSH隧道、数据库凭据保存及证书验证等配置方法,同时介绍敏感信息保护、远程连接风险和高权限账号使用等注意事项,帮助用户提高数据库日常管理的安全性。

2026.11.05

100

12

DBeaver连接创建与配置教程
DBeaver连接创建与配置教程

本专题聚焦DBeaver数据库连接配置与管理,覆盖从新建连接、选择数据库类型到填写连接参数和验证连接的完整流程。针对MySQL、PostgreSQL、SQL Server等常见数据库,整理相应的连接设置方法,并提供驱动缺失、认证失败和连接异常等问题的排查方向。

2026.11.04

120

16

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习