PHPUnit | assertStringContainsString()函数

PHPUnit是PHP中使用最广泛的单元测试框架之一，它有很多实用函数可供开发者使用。其中，assertStringContainsString()函数是用于验证一个字符串是否包含另一个子串的函数。本文将介绍该函数的使用方法和注意事项。

基础使用方法

该函数的基本语法如下：

assertStringContainsString(string $substring, string $string [, string $message = ''])

参数说明：

• $substring：需要查询的子串。
• $string：需要在其中查询子串的字符串。
• $message：可选参数，用于当断言失败时输出的错误信息。

该函数的主要作用在于，在执行某个操作后，验证输出的结果中是否包含某个关键字或子串。

下面是一个简单的例子：

public function testFunction()
{
    $result = some_function();
    $this->assertStringContainsString('success', $result);
}

这个例子表示，测试some_function()函数的输出结果是否包含“success”这个子串。

注意事项

在使用该函数时，需要注意以下几点：

• 该函数大小写不敏感。例如，如果子串为“test”，字符串中存在“Test”也会被认为是包含该子串。
• 如果需要大小写敏感的验证，可以使用assertStringContainsStringCaseSensitive()函数。
• 如果查找的子串在字符串中出现多次，该函数只会验证其是否存在，而不会告诉你出现了几次。如果需要获取其出现次数，可以考虑使用substr_count()等函数进行计数。
• 如果需要验证一个字符串不存在某个子串，可以使用assertStringNotContainsString()函数。

实用技巧

很多时候，在编写单元测试时，常常需要验证某个函数在不同参数下的输出结果是否符合预期。这时可以运用dataProvider技巧，通过给定不同的参数组合，避免重复编写多个测试用例。

下面是一个例子：

/**
 * @dataProvider dataProvider
 */
public function testFunction($input, $expected)
{
    $result = some_function($input);
    $this->assertStringContainsString($expected, $result);
}

public function dataProvider()
{
    return [
        ['param1', 'result1'],
        ['param2', 'result2'],
        ['param3', 'result3'],
    ];
}

这个例子使用了一个dataProvider，通过返回不同的参数组合，避免了编写多个测试用例的冗余代码。

总结

assertStringContainsString()函数是PHPUnit中一个非常实用的函数，可用于验证字符串中是否包含某个子串。在编写单元测试时，我们可以灵活运用该函数，避免繁琐的手动判断和重复编写的测试用例。