Laravel中JSON测试断言失败时如何自定义提示信息？

针对你遇到的Laravel测试断言失败提示不明确的问题，有几种简单的方法可以实现自定义错误消息的需求，下面逐一说明：

方法一：利用Laravel内置支持（Laravel 9+） #

如果你使用的是Laravel 9及以上版本，其实assertJsonCount方法本身就支持第三个参数作为自定义错误消息，完全可以直接按照你想要的方式调用：

$this->post(action([TagController::class, 'search'], '!! Not foundable name !!'))
    ->assertOk()
    ->assertJsonCount(0, 'data', '由于条件不匹配，应无搜索结果返回');

当断言失败时，PHPUnit会优先显示你传入的自定义消息，让你一眼就能定位到是哪个测试步骤出了问题。

方法二：扩展TestResponse类（兼容旧版本） #

如果你的Laravel版本低于9，内置的assertJsonCount没有自定义消息参数，你可以通过扩展TestResponse类来实现这个功能：

1. 首先创建一个自定义的TestResponse类，封装带消息的断言逻辑：

<?php

namespace Tests;

use Illuminate\Testing\TestResponse;
use PHPUnit\Framework\ExpectationFailedException;

class CustomTestResponse extends TestResponse
{
    public function assertJsonCount(int $count, string $key = null, string $message = ''): self
    {
        try {
            // 调用父类的原有断言方法
            parent::assertJsonCount($count, $key);
        } catch (ExpectationFailedException $e) {
            // 如果有自定义消息，就抛出带自定义消息的异常
            if ($message) {
                throw new ExpectationFailedException($message, $e->getComparisonFailure());
            }
            // 没有自定义消息则抛出原异常
            throw $e;
        }

        return $this;
    }
}

2. 然后在你的基础TestCase类中，重写createTestResponse方法，让测试返回我们自定义的响应类：

<?php

namespace Tests;

use Illuminate\Foundation\Testing\TestCase as BaseTestCase;

abstract class TestCase extends BaseTestCase
{
    use CreatesApplication;

    protected function createTestResponse($response)
    {
        return new CustomTestResponse($response);
    }
}

做完这两步后，你就可以像示例中那样，给assertJsonCount添加自定义消息参数了。

方法三：手动断言（快速临时方案） #

如果只是个别测试需要自定义消息，不想动框架扩展，也可以手动获取响应数据后，用assertEquals断言并传入自定义消息：

$response = $this->post(action([TagController::class, 'search'], '!! Not foundable name !!'))
    ->assertOk();

// 手动获取data数组的长度
$dataLength = count($response->json('data'));
// 用assertEquals断言，同时传入自定义消息
$this->assertEquals(0, $dataLength, '由于条件不匹配，应无搜索结果返回');

这种方式不需要任何扩展，适合快速解决单个测试的问题。

内容的提问来源于stack exchange，提问作者netdjw