Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

HTTP 测试 ​

介绍 ​

Laravel 提供了一个非常流畅的 API，用于向您的应用程序发起 HTTP 请求并检查响应。例如，看看下面定义的功能测试：

php
<?php

test('应用程序返回成功响应', function () {
    $response = $this->get('/');

    $response->assertStatus(200);
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_the_application_returns_a_successful_response(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

get 方法向应用程序发起 GET 请求，而 assertStatus 方法断言返回的响应应具有给定的 HTTP 状态码。除了这个简单的断言，Laravel 还包含多种断言，用于检查响应头、内容、JSON 结构等。

发起请求 ​

要向您的应用程序发起请求，您可以在测试中调用 get、post、put、patch 或 delete 方法。这些方法并不会实际向您的应用程序发出“真实”的 HTTP 请求。相反，整个网络请求在内部被模拟。

测试请求方法返回的是 Illuminate\Testing\TestResponse 的实例，而不是 Illuminate\Http\Response 实例，该实例提供了 多种有用的断言，允许您检查应用程序的响应：

php
<?php

test('基本请求', function () {
    $response = $this->get('/');

    $response->assertStatus(200);
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_a_basic_request(): void
    {
        $response = $this->get('/');

        $response->assertStatus(200);
    }
}

通常，您的每个测试应该只向应用程序发起一个请求。如果在单个测试方法中执行多个请求，可能会发生意外行为。

lightbulb

为了方便，CSRF 中间件在运行测试时会自动禁用。

自定义请求头 ​

您可以使用 withHeaders 方法在请求发送到应用程序之前自定义请求的头。此方法允许您向请求添加任何自定义头：

php
<?php

test('与头部交互', function () {
    $response = $this->withHeaders([
        'X-Header' => 'Value',
    ])->post('/user', ['name' => 'Sally']);

    $response->assertStatus(201);
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_interacting_with_headers(): void
    {
        $response = $this->withHeaders([
            'X-Header' => 'Value',
        ])->post('/user', ['name' => 'Sally']);

        $response->assertStatus(201);
    }
}

Cookies ​

您可以使用 withCookie 或 withCookies 方法在发起请求之前设置 cookie 值。withCookie 方法接受 cookie 名称和值作为两个参数，而 withCookies 方法接受名称/值对的数组：

php
<?php

test('与 cookies 交互', function () {
    $response = $this->withCookie('color', 'blue')->get('/');

    $response = $this->withCookies([
        'color' => 'blue',
        'name' => 'Taylor',
    ])->get('/');

    //
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_interacting_with_cookies(): void
    {
        $response = $this->withCookie('color', 'blue')->get('/');

        $response = $this->withCookies([
            'color' => 'blue',
            'name' => 'Taylor',
        ])->get('/');

        //
    }
}

会话 / 认证 ​

Laravel 提供了多个助手，用于在 HTTP 测试中与会话进行交互。首先，您可以使用 withSession 方法将会话数据设置为给定数组。这对于在向应用程序发起请求之前加载会话数据非常有用：

php
<?php

test('与会话交互', function () {
    $response = $this->withSession(['banned' => false])->get('/');

    //
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_interacting_with_the_session(): void
    {
        $response = $this->withSession(['banned' => false])->get('/');

        //
    }
}

Laravel 的会话通常用于维护当前认证用户的状态。因此，actingAs 辅助方法提供了一种简单的方法来将给定用户认证为当前用户。例如，我们可以使用 模型工厂 生成并认证一个用户：

php
<?php

use App\Models\User;

test('需要认证的操作', function () {
    $user = User::factory()->create();

    $response = $this->actingAs($user)
                     ->withSession(['banned' => false])
                     ->get('/');

    //
});
php
<?php

namespace Tests\Feature;

use App\Models\User;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_an_action_that_requires_authentication(): void
    {
        $user = User::factory()->create();

        $response = $this->actingAs($user)
                         ->withSession(['banned' => false])
                         ->get('/');

        //
    }
}

您还可以通过将守卫名称作为第二个参数传递给 actingAs 方法来指定应使用哪个守卫来认证给定用户。提供给 actingAs 方法的守卫将在测试期间也成为默认守卫：

php
$this->actingAs($user, 'web')

调试响应 ​

在向您的应用程序发起测试请求后，可以使用 dump、dumpHeaders 和 dumpSession 方法来检查和调试响应内容：

php
<?php

test('基本测试', function () {
    $response = $this->get('/');

    $response->dumpHeaders();

    $response->dumpSession();

    $response->dump();
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_basic_test(): void
    {
        $response = $this->get('/');

        $response->dumpHeaders();

        $response->dumpSession();

        $response->dump();
    }
}

或者，您可以使用 dd、ddHeaders 和 ddSession 方法来转储有关响应的信息，然后停止执行：

php
<?php

test('基本测试', function () {
    $response = $this->get('/');

    $response->ddHeaders();

    $response->ddSession();

    $response->dd();
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_basic_test(): void
    {
        $response = $this->get('/');

        $response->ddHeaders();

        $response->ddSession();

        $response->dd();
    }
}

异常处理 ​

有时您可能需要测试您的应用程序是否抛出了特定的异常。为此，您可以通过 Exceptions facade “伪造”异常处理程序。一旦异常处理程序被伪造，您可以利用 assertReported 和 assertNotReported 方法对请求期间抛出的异常进行断言：

php
<?php

use App\Exceptions\InvalidOrderException;
use Illuminate\Support\Facades\Exceptions;

test('异常被抛出', function () {
    Exceptions::fake();

    $response = $this->get('/order/1');

    // 断言抛出了一个异常...
    Exceptions::assertReported(InvalidOrderException::class);

    // 对异常进行断言...
    Exceptions::assertReported(function (InvalidOrderException $e) {
        return $e->getMessage() === '订单无效。';
    });
});
php
<?php

namespace Tests\Feature;

use App\Exceptions\InvalidOrderException;
use Illuminate\Support\Facades\Exceptions;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的测试示例。
     */
    public function test_exception_is_thrown(): void
    {
        Exceptions::fake();

        $response = $this->get('/');

        // 断言抛出了一个异常...
        Exceptions::assertReported(InvalidOrderException::class);

        // 对异常进行断言...
        Exceptions::assertReported(function (InvalidOrderException $e) {
            return $e->getMessage() === '订单无效。';
        });
    }
}

assertNotReported 和 assertNothingReported 方法可用于断言在请求期间未抛出给定异常或未抛出任何异常：

php
Exceptions::assertNotReported(InvalidOrderException::class);

Exceptions::assertNothingReported();

您可以通过在发起请求之前调用 withoutExceptionHandling 方法完全禁用给定请求的异常处理：

php
$response = $this->withoutExceptionHandling()->get('/');

此外，如果您希望确保您的应用程序未使用 PHP 语言或您应用程序所使用的库中已弃用的功能，您可以在发起请求之前调用 withoutDeprecationHandling 方法。当禁用弃用处理时，弃用警告将被转换为异常，从而导致您的测试失败：

php
$response = $this->withoutDeprecationHandling()->get('/');

assertThrows 方法可用于断言给定闭包中的代码抛出指定类型的异常：

php
$this->assertThrows(
    fn () => (new ProcessOrder)->execute(),
    OrderInvalid::class
);

如果您希望检查并对抛出的异常进行断言，可以将闭包作为第二个参数提供给 assertThrows 方法：

php
$this->assertThrows(
    fn () => (new ProcessOrder)->execute(),
    fn (OrderInvalid $e) => $e->orderId() === 123;
);

测试 JSON APIs ​

Laravel 还提供了多个助手，用于测试 JSON API 及其响应。例如，可以使用 json、getJson、postJson、putJson、patchJson、deleteJson 和 optionsJson 方法发起 JSON 请求，使用各种 HTTP 动词。您还可以轻松地将数据和头传递给这些方法。让我们开始编写一个测试，向 /api/user 发起 POST 请求，并断言返回了预期的 JSON 数据：

php
<?php

test('发起 API 请求', function () {
    $response = $this->postJson('/api/user', ['name' => 'Sally']);

    $response
        ->assertStatus(201)
        ->assertJson([
            'created' => true,
         ]);
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_making_an_api_request(): void
    {
        $response = $this->postJson('/api/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertJson([
                'created' => true,
            ]);
    }
}

此外，JSON 响应数据可以作为数组变量在响应中访问，使您方便地检查 JSON 响应中返回的单个值：

php
expect($response['created'])->toBeTrue();
php
$this->assertTrue($response['created']);
lightbulb

assertJson 方法将响应转换为数组，以验证给定数组是否存在于应用程序返回的 JSON 响应中。因此，如果 JSON 响应中还有其他属性，只要给定片段存在，该测试仍将通过。

断言精确的 JSON 匹配 ​

如前所述，assertJson 方法可用于断言 JSON 响应中存在某个片段。如果您希望验证给定数组 完全匹配 应用程序返回的 JSON，您应该使用 assertExactJson 方法：

php
<?php

test('断言精确的 JSON 匹配', function () {
    $response = $this->postJson('/user', ['name' => 'Sally']);

    $response
        ->assertStatus(201)
        ->assertExactJson([
            'created' => true,
        ]);
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_asserting_an_exact_json_match(): void
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertExactJson([
                'created' => true,
            ]);
    }
}

断言 JSON 路径 ​

如果您希望验证 JSON 响应在指定路径下包含给定数据，您应该使用 assertJsonPath 方法：

php
<?php

test('断言 JSON 路径值', function () {
    $response = $this->postJson('/user', ['name' => 'Sally']);

    $response
        ->assertStatus(201)
        ->assertJsonPath('team.owner.name', 'Darian');
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    /**
     * 一个基本的功能测试示例。
     */
    public function test_asserting_a_json_paths_value(): void
    {
        $response = $this->postJson('/user', ['name' => 'Sally']);

        $response
            ->assertStatus(201)
            ->assertJsonPath('team.owner.name', 'Darian');
    }
}

assertJsonPath 方法还接受一个闭包，可以用来动态确定断言是否通过：

php
$response->assertJsonPath('team.owner.name', fn (string $name) => strlen($name) >= 3);

流畅的 JSON 测试 ​

Laravel 还提供了一种优雅的方式来流畅地测试应用程序的 JSON 响应。要开始，请将一个闭包传递给 assertJson 方法。该闭包将使用 Illuminate\Testing\Fluent\AssertableJson 的实例进行调用，可以用来对应用程序返回的 JSON 进行断言。where 方法可用于对 JSON 的特定属性进行断言，而 missing 方法可用于断言 JSON 中缺少特定属性：

php
use Illuminate\Testing\Fluent\AssertableJson;

test('流畅的 JSON', function () {
    $response = $this->getJson('/users/1');

    $response
        ->assertJson(fn (AssertableJson $json) =>
            $json->where('id', 1)
                 ->where('name', 'Victoria Faith')
                 ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                 ->whereNot('status', 'pending')
                 ->missing('password')
                 ->etc()
        );
});
php
use Illuminate\Testing\Fluent\AssertableJson;

/**
 * 一个基本的功能测试示例。
 */
public function test_fluent_json(): void
{
    $response = $this->getJson('/users/1');

    $response
        ->assertJson(fn (AssertableJson $json) =>
            $json->where('id', 1)
                 ->where('name', 'Victoria Faith')
                 ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                 ->whereNot('status', 'pending')
                 ->missing('password')
                 ->etc()
        );
}

理解 etc 方法 ​

在上面的示例中，您可能注意到我们在断言链的末尾调用了 etc 方法。此方法通知 Laravel 可能在 JSON 对象中存在其他属性。如果不使用 etc 方法，如果 JSON 对象中存在您未进行断言的其他属性，测试将失败。

这种行为的意图是保护您免于无意中在 JSON 响应中暴露敏感信息，强迫您要么明确对属性进行断言，要么通过 etc 方法明确允许额外的属性。

但是，您应该注意，不包括 etc 方法在断言链中并不能确保在 JSON 对象中嵌套的数组中不会添加额外的属性。etc 方法仅确保在调用 etc 方法的嵌套级别中不存在额外的属性。

断言属性的存在和缺失 ​

要断言某个属性存在或缺失，您可以使用 has 和 missing 方法：

php
$response->assertJson(fn (AssertableJson $json) =>
    $json->has('data')
         ->missing('message')
);

此外，hasAll 和 missingAll 方法允许同时断言多个属性的存在或缺失：

php
$response->assertJson(fn (AssertableJson $json) =>
    $json->hasAll(['status', 'data'])
         ->missingAll(['message', 'code'])
);

您可以使用 hasAny 方法来确定给定属性列表中至少有一个属性存在：

php
$response->assertJson(fn (AssertableJson $json) =>
    $json->has('status')
         ->hasAny('data', 'message', 'code')
);

针对 JSON 集合的断言 ​

通常，您的路由将返回一个包含多个项目的 JSON 响应，例如多个用户：

php
Route::get('/users', function () {
    return User::all();
});

在这些情况下，我们可以使用流畅的 JSON 对象的 has 方法对响应中包含的用户进行断言。例如，让我们断言 JSON 响应包含三个用户。接下来，我们将使用 first 方法对集合中的第一个用户进行一些断言。first 方法接受一个闭包，该闭包接收另一个可断言的 JSON 字符串，我们可以用它来对 JSON 集合中的第一个对象进行断言：

php
$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has(3)
             ->first(fn (AssertableJson $json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                     ->missing('password')
                     ->etc()
             )
    );

作用域 JSON 集合断言 ​

有时，您的应用程序的路由将返回分配了命名键的 JSON 集合：

php
Route::get('/users', function () {
    return [
        'meta' => [...],
        'users' => User::all(),
    ];
})

在测试这些路由时，您可以使用 has 方法对集合中的项目数量进行断言。此外，您可以使用 has 方法来作用域一系列断言：

php
$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has('meta')
             ->has('users', 3)
             ->has('users.0', fn (AssertableJson $json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                     ->missing('password')
                     ->etc()
             )
    );

但是，您可以通过提供一个闭包作为第三个参数来对 users 集合进行单个调用。当这样做时，闭包将自动被调用并作用于集合中的第一个项目：

php
$response
    ->assertJson(fn (AssertableJson $json) =>
        $json->has('meta')
             ->has('users', 3, fn (AssertableJson $json) =>
                $json->where('id', 1)
                     ->where('name', 'Victoria Faith')
                     ->where('email', fn (string $email) => str($email)->is('victoria@gmail.com'))
                     ->missing('password')
                     ->etc()
             )
    );

断言 JSON 类型 ​

您可能只想断言 JSON 响应中的属性是某种特定类型。Illuminate\Testing\Fluent\AssertableJson 类提供了 whereType 和 whereAllType 方法来实现这一点：

php
$response->assertJson(fn (AssertableJson $json) =>
    $json->whereType('id', 'integer')
         ->whereAllType([
            'users.0.name' => 'string',
            'meta' => 'array'
        ])
);

您可以使用 | 字符指定多个类型，或者将类型数组作为第二个参数传递给 whereType 方法。如果响应值是列出的任何类型，则断言将成功：

php
$response->assertJson(fn (AssertableJson $json) =>
    $json->whereType('name', 'string|null')
         ->whereType('id', ['string', 'integer'])
);

whereType 和 whereAllType 方法识别以下类型：string、integer、double、boolean、array 和 null。

测试文件上传 ​

Illuminate\Http\UploadedFile 类提供了一个 fake 方法，可以用来生成用于测试的虚拟文件或图像。结合 Storage facade 的 fake 方法，可以大大简化文件上传的测试。例如，您可以结合这两个功能轻松测试头像上传表单：

php
<?php

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;

test('头像可以上传', function () {
    Storage::fake('avatars');

    $file = UploadedFile::fake()->image('avatar.jpg');

    $response = $this->post('/avatar', [
        'avatar' => $file,
    ]);

    Storage::disk('avatars')->assertExists($file->hashName());
});
php
<?php

namespace Tests\Feature;

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_头像可以上传(): void
    {
        Storage::fake('avatars');

        $file = UploadedFile::fake()->image('avatar.jpg');

        $response = $this->post('/avatar', [
            'avatar' => $file,
        ]);

        Storage::disk('avatars')->assertExists($file->hashName());
    }
}

如果您想断言某个文件不存在，可以使用 Storage facade 提供的 assertMissing 方法：

php
Storage::fake('avatars');

// ...

Storage::disk('avatars')->assertMissing('missing.jpg');

虚拟文件自定义 ​

使用 UploadedFile 类提供的 fake 方法创建文件时，您可以指定图像的宽度、高度和大小（以千字节为单位），以更好地测试应用程序的验证规则：

php
UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);

除了创建图像外，您还可以使用 create 方法创建任何其他类型的文件：

php
UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);

如果需要，您可以将 $mimeType 参数传递给该方法，以显式定义应返回的文件 MIME 类型：

php
UploadedFile::fake()->create(
    'document.pdf', $sizeInKilobytes, 'application/pdf'
);

测试视图 ​

Laravel 还允许您在不对应用程序进行模拟 HTTP 请求的情况下渲染视图。为此，您可以在测试中调用 view 方法。view 方法接受视图名称和可选的数据数组。该方法返回一个 Illuminate\Testing\TestView 的实例，该实例提供了几种方法来方便地对视图内容进行断言：

php
<?php

test('欢迎视图可以被渲染', function () {
    $view = $this->view('welcome', ['name' => 'Taylor']);

    $view->assertSee('Taylor');
});
php
<?php

namespace Tests\Feature;

use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_欢迎视图可以被渲染(): void
    {
        $view = $this->view('welcome', ['name' => 'Taylor']);

        $view->assertSee('Taylor');
    }
}

TestView 类提供以下断言方法：assertSee、assertSeeInOrder、assertSeeText、assertSeeTextInOrder、assertDontSee 和 assertDontSeeText。

如果需要，您可以通过将 TestView 实例强制转换为字符串来获取原始的、渲染的视图内容：

php
$contents = (string) $this->view('welcome');

共享错误 ​

某些视图可能依赖于 Laravel 提供的 全局错误包 中共享的错误。要用错误消息填充错误包，您可以使用 withViewErrors 方法：

php
$view = $this->withViewErrors([
    'name' => ['请提供有效的名称。']
])->view('form');

$view->assertSee('请提供有效的名称。');

渲染 Blade 和组件 ​

如果需要，您可以使用 blade 方法来评估和渲染原始 Blade 字符串。与 view 方法一样，blade 方法返回一个 Illuminate\Testing\TestView 的实例：

php
$view = $this->blade(
    '<x-component :name="$name" />',
    ['name' => 'Taylor']
);

$view->assertSee('Taylor');

您可以使用 component 方法来评估和渲染 Blade 组件。component 方法返回一个 Illuminate\Testing\TestComponent 的实例：

php
$view = $this->component(Profile::class, ['name' => 'Taylor']);

$view->assertSee('Taylor');

可用的断言 ​

响应断言 ​

Laravel 的 Illuminate\Testing\TestResponse 类提供了多种自定义断言方法，您可以在测试应用程序时使用。这些断言可以在 json、get、post、put 和 delete 测试方法返回的响应上访问：

assertAcceptedassertBadRequestassertConflictassertCookieassertCookieExpiredassertCookieNotExpiredassertCookieMissingassertCreatedassertDontSeeassertDontSeeTextassertDownloadassertExactJsonassertExactJsonStructureassertForbiddenassertFoundassertGoneassertHeaderassertHeaderMissingassertInternalServerErrorassertJsonassertJsonCountassertJsonFragmentassertJsonIsArrayassertJsonIsObjectassertJsonMissingassertJsonMissingExactassertJsonMissingValidationErrorsassertJsonPathassertJsonMissingPathassertJsonStructureassertJsonValidationErrorsassertJsonValidationErrorForassertLocationassertMethodNotAllowedassertMovedPermanentlyassertContentassertNoContentassertStreamedContentassertNotFoundassertOkassertPaymentRequiredassertPlainCookieassertRedirectassertRedirectContainsassertRedirectToRouteassertRedirectToSignedRouteassertRequestTimeoutassertSeeassertSeeInOrderassertSeeTextassertSeeTextInOrderassertServerErrorassertServiceUnavailableassertSessionHasassertSessionHasInputassertSessionHasAllassertSessionHasErrorsassertSessionHasErrorsInassertSessionHasNoErrorsassertSessionDoesntHaveErrorsassertSessionMissingassertStatusassertSuccessfulassertTooManyRequestsassertUnauthorizedassertUnprocessableassertUnsupportedMediaTypeassertValidassertInvalidassertViewHasassertViewHasAllassertViewIsassertViewMissing

assertBadRequest ​

断言响应具有错误请求（400）HTTP 状态代码：

php
$response->assertBadRequest();

assertAccepted ​

断言响应具有已接受（202）HTTP 状态代码：

php
$response->assertAccepted();

assertConflict ​

断言响应具有冲突（409）HTTP 状态代码：

php
$response->assertConflict();

assertCookie ​

断言响应包含给定的 cookie：

php
$response->assertCookie($cookieName, $value = null);

assertCookieExpired ​

断言响应包含给定的 cookie，并且它已过期：

php
$response->assertCookieExpired($cookieName);

assertCookieNotExpired ​

断言响应包含给定的 cookie，并且它未过期：

php
$response->assertCookieNotExpired($cookieName);

assertCookieMissing ​

断言响应不包含给定的 cookie：

php
$response->assertCookieMissing($cookieName);

assertCreated ​

断言响应具有 201 HTTP 状态代码：

php
$response->assertCreated();

assertDontSee ​

断言给定字符串不包含在应用程序返回的响应中。此断言将自动转义给定字符串，除非您传递第二个参数为 false：

php
$response->assertDontSee($value, $escaped = true);

assertDontSeeText ​

断言给定字符串不包含在响应文本中。此断言将自动转义给定字符串，除非您传递第二个参数为 false。此方法将在进行断言之前将响应内容传递给 strip_tags PHP 函数：

php
$response->assertDontSeeText($value, $escaped = true);

assertDownload ​

断言响应是“下载”。通常，这意味着返回响应的路由返回了 Response::download 响应、BinaryFileResponse 或 Storage::download 响应：

php
$response->assertDownload();

如果您愿意，可以断言可下载的文件被分配了给定的文件名：

php
$response->assertDownload('image.jpg');

assertExactJson ​

断言响应包含给定 JSON 数据的精确匹配：

php
$response->assertExactJson(array $data);

assertExactJsonStructure ​

断言响应包含给定 JSON 结构的精确匹配：

php
$response->assertExactJsonStructure(array $data);

此方法是 assertJsonStructure 的更严格变体。与 assertJsonStructure 相比，如果响应包含任何未明确包含在预期 JSON 结构中的键，则此方法将失败。

assertForbidden ​

断言响应具有禁止（403）HTTP 状态代码：

php
$response->assertForbidden();

assertFound ​

断言响应具有找到（302）HTTP 状态代码：

php
$response->assertFound();

assertGone ​

断言响应具有消失（410）HTTP 状态代码：

php
$response->assertGone();

assertHeader ​

断言响应中存在给定的头部和值：

php
$response->assertHeader($headerName, $value = null);

assertHeaderMissing ​

断言响应中不存在给定的头部：

php
$response->assertHeaderMissing($headerName);

assertInternalServerError ​

断言响应具有“内部服务器错误”（500）HTTP 状态代码：

php
$response->assertInternalServerError();

assertJson ​

断言响应包含给定的 JSON 数据：

php
$response->assertJson(array $data, $strict = false);

assertJson 方法将响应转换为数组，以验证给定数组是否存在于应用程序返回的 JSON 响应中。因此，如果 JSON 响应中还有其他属性，只要给定的片段存在，此测试仍将通过。

assertJsonCount ​

断言响应 JSON 在给定键处具有预期数量的数组项：

php
$response->assertJsonCount($count, $key = null);

assertJsonFragment ​

断言响应中包含给定的 JSON 数据：

php
Route::get('/users', function () {
    return [
        'users' => [
            [
                'name' => 'Taylor Otwell',
            ],
        ],
    ];
});

$response->assertJsonFragment(['name' => 'Taylor Otwell']);

assertJsonIsArray ​

断言响应 JSON 是一个数组：

php
$response->assertJsonIsArray();

assertJsonIsObject ​

断言响应 JSON 是一个对象：

php
$response->assertJsonIsObject();

assertJsonMissing ​

断言响应不包含给定的 JSON 数据：

php
$response->assertJsonMissing(array $data);

assertJsonMissingExact ​

断言响应不包含精确的 JSON 数据：

php
$response->assertJsonMissingExact(array $data);

assertJsonMissingValidationErrors ​

断言响应没有给定键的 JSON 验证错误：

php
$response->assertJsonMissingValidationErrors($keys);
lightbulb

更通用的 assertValid 方法可用于断言响应没有作为 JSON 返回的验证错误 并且 没有错误被闪存到会话存储中。

assertJsonPath ​

断言响应在指定路径处包含给定数据：

php
$response->assertJsonPath($path, $expectedValue);

例如，如果您的应用程序返回以下 JSON 响应：

json
{
  "user": {
    "name": "Steve Schoger"
  }
}

您可以这样断言 user 对象的 name 属性与给定值匹配：

php
$response->assertJsonPath('user.name', 'Steve Schoger');

assertJsonMissingPath ​

断言响应不包含给定路径：

php
$response->assertJsonMissingPath($path);

例如，如果您的应用程序返回以下 JSON 响应：

json
{
    "user": {
        "name": "Steve Schoger"
    }
}

您可以断言它不包含 user 对象的 email 属性：

php
$response->assertJsonMissingPath('user.email');

assertJsonStructure ​

断言响应具有给定的 JSON 结构：

php
$response->assertJsonStructure(array $structure);

例如，如果您的应用程序返回的 JSON 响应包含以下数据：

json
{
    "user": {
        "name": "Steve Schoger"
    }
}

您可以像这样断言 JSON 结构符合您的预期：

php
$response->assertJsonStructure([
    'user' => [
        'name',
    ]
]);

有时，应用程序返回的 JSON 响应可能包含对象数组：

json
{
    "user": [
        {
            "name": "Steve Schoger",
            "age": 55,
            "location": "Earth"
        },
        {
            "name": "Mary Schoger",
            "age": 60,
            "location": "Earth"
        }
    ]
}

在这种情况下，您可以使用 * 字符来断言数组中所有对象的结构：

php
$response->assertJsonStructure([
    'user' => [
        '*' => [
             'name',
             'age',
             'location'
        ]
    ]
]);

assertJsonValidationErrors ​

断言响应具有给定键的 JSON 验证错误。当响应中的验证错误以 JSON 结构返回而不是闪存到会话时，应使用此方法：

php
$response->assertJsonValidationErrors(array $data, $responseKey = 'errors');
lightbulb

更通用的 assertInvalid 方法可用于断言响应具有以 JSON 返回的验证错误 或 错误已闪存到会话存储中。

assertJsonValidationErrorFor ​

断言响应对给定键具有任何 JSON 验证错误：

php
$response->assertJsonValidationErrorFor(string $key, $responseKey = 'errors');

assertMethodNotAllowed ​

断言响应具有方法不允许 (405) HTTP 状态码：

php
$response->assertMethodNotAllowed();

assertMovedPermanently ​

断言响应具有永久移动 (301) HTTP 状态码：

php
$response->assertMovedPermanently();

assertLocation ​

断言响应在 Location 头中具有给定的 URI 值：

php
$response->assertLocation($uri);

assertContent ​

断言给定字符串与响应内容匹配：

php
$response->assertContent($value);

assertNoContent ​

断言响应具有给定的 HTTP 状态码且没有内容：

php
$response->assertNoContent($status = 204);

assertStreamedContent ​

断言给定字符串与流式响应内容匹配：

php
$response->assertStreamedContent($value);

assertNotFound ​

断言响应具有未找到 (404) HTTP 状态码：

php
$response->assertNotFound();

assertOk ​

断言响应具有 200 HTTP 状态码：

php
$response->assertOk();

assertPaymentRequired ​

断言响应具有支付要求 (402) HTTP 状态码：

php
$response->assertPaymentRequired();

assertPlainCookie ​

断言响应包含给定的未加密 cookie：

php
$response->assertPlainCookie($cookieName, $value = null);

assertRedirect ​

断言响应是重定向到给定 URI：

php
$response->assertRedirect($uri = null);

assertRedirectContains ​

断言响应是否重定向到包含给定字符串的 URI：

php
$response->assertRedirectContains($string);

assertRedirectToRoute ​

断言响应是重定向到给定的 命名路由：

php
$response->assertRedirectToRoute($name, $parameters = []);

assertRedirectToSignedRoute ​

断言响应是重定向到给定的 签名路由：

php
$response->assertRedirectToSignedRoute($name = null, $parameters = []);

assertRequestTimeout ​

断言响应具有请求超时 (408) HTTP 状态码：

php
$response->assertRequestTimeout();

assertSee ​

断言给定字符串包含在响应中。此断言将自动转义给定字符串，除非您传递第二个参数为 false：

php
$response->assertSee($value, $escaped = true);

assertSeeInOrder ​

断言给定字符串按顺序包含在响应中。此断言将自动转义给定字符串，除非您传递第二个参数为 false：

php
$response->assertSeeInOrder(array $values, $escaped = true);

assertSeeText ​

断言给定字符串包含在响应文本中。此断言将自动转义给定字符串，除非您传递第二个参数为 false。响应内容将在进行断言之前传递给 strip_tags PHP 函数：

php
$response->assertSeeText($value, $escaped = true);

assertSeeTextInOrder ​

断言给定字符串按顺序包含在响应文本中。此断言将自动转义给定字符串，除非您传递第二个参数为 false。响应内容将在进行断言之前传递给 strip_tags PHP 函数：

php
$response->assertSeeTextInOrder(array $values, $escaped = true);

assertServerError ​

断言响应具有服务器错误 (>= 500 , < 600) HTTP 状态码：

php
$response->assertServerError();

assertServiceUnavailable ​

断言响应具有“服务不可用” (503) HTTP 状态码：

php
$response->assertServiceUnavailable();

assertSessionHas ​

断言会话包含给定的数据：

php
$response->assertSessionHas($key, $value = null);

如果需要，可以将闭包作为第二个参数提供给 assertSessionHas 方法。如果闭包返回 true，则断言将通过：

php
$response->assertSessionHas($key, function (User $value) {
    return $value->name === 'Taylor Otwell';
});

assertSessionHasInput ​

断言会话在 闪存输入数组 中具有给定值：

php
$response->assertSessionHasInput($key, $value = null);

如果需要，可以将闭包作为第二个参数提供给 assertSessionHasInput 方法。如果闭包返回 true，则断言将通过：

php
use Illuminate\Support\Facades\Crypt;

$response->assertSessionHasInput($key, function (string $value) {
    return Crypt::decryptString($value) === 'secret';
});

assertSessionHasAll ​

断言会话包含给定的键/值对数组：

php
$response->assertSessionHasAll(array $data);

例如，如果您的应用程序的会话包含 name 和 status 键，您可以像这样断言它们都存在并具有指定的值：

php
$response->assertSessionHasAll([
    'name' => 'Taylor Otwell',
    'status' => 'active',
]);

assertSessionHasErrors ​

断言会话包含给定 $keys 的错误。如果 $keys 是关联数组，则断言会话包含每个字段（键）的特定错误消息（值）。此方法应在测试将验证错误闪存到会话而不是作为 JSON 返回的路由时使用：

php
$response->assertSessionHasErrors(
    array $keys = [], $format = null, $errorBag = 'default'
);

例如，要断言 name 和 email 字段具有闪存到会话的验证错误消息，您可以像这样调用 assertSessionHasErrors 方法：

php
$response->assertSessionHasErrors(['name', 'email']);

或者，您可以断言给定字段具有特定的验证错误消息：

php
$response->assertSessionHasErrors([
    'name' => 'The given name was invalid.'
]);
lightbulb

更通用的 assertInvalid 方法可用于断言响应具有以 JSON 返回的验证错误 或 错误已闪存到会话存储中。

assertSessionHasErrorsIn ​

断言会话在特定 错误包 中包含给定 $keys 的错误。如果 $keys 是关联数组，则断言会话在错误包中包含每个字段（键）的特定错误消息（值）：

php
$response->assertSessionHasErrorsIn($errorBag, $keys = [], $format = null);

assertSessionHasNoErrors ​

断言会话没有验证错误：

php
$response->assertSessionHasNoErrors();

assertSessionDoesntHaveErrors ​

断言会话对给定键没有验证错误：

php
$response->assertSessionDoesntHaveErrors($keys = [], $format = null, $errorBag = 'default');
lightbulb

更通用的 assertValid 方法可用于断言响应没有以 JSON 返回的验证错误 并且 没有错误闪存到会话存储中。

assertSessionMissing ​

断言会话不包含给定键：

php
$response->assertSessionMissing($key);

assertStatus ​

断言响应具有给定的 HTTP 状态码：

php
$response->assertStatus($code);

assertSuccessful ​

断言响应具有成功的 (>= 200 和 < 300) HTTP 状态码：

php
$response->assertSuccessful();

assertTooManyRequests ​

断言响应具有过多请求 (429) HTTP 状态码：

php
$response->assertTooManyRequests();

assertUnauthorized ​

断言响应具有未授权 (401) HTTP 状态码：

php
$response->assertUnauthorized();

assertUnprocessable ​

断言响应具有不可处理的实体 (422) HTTP 状态码：

php
$response->assertUnprocessable();

assertUnsupportedMediaType ​

断言响应具有不支持的媒体类型 (415) HTTP 状态码：

php
$response->assertUnsupportedMediaType();

assertValid ​

断言响应对给定键没有验证错误。此方法可用于断言响应中返回的验证错误是 JSON 结构或已闪存到会话：

php
// 断言没有验证错误...
$response->assertValid();

// 断言给定键没有验证错误...
$response->assertValid(['name', 'email']);

assertInvalid ​

断言响应对给定键具有验证错误。此方法可用于断言响应中返回的验证错误是 JSON 结构或已闪存到会话：

php
$response->assertInvalid(['name', 'email']);

您还可以断言给定键具有特定的验证错误消息。在这样做时，您可以提供整个消息或仅提供消息的一小部分：

php
$response->assertInvalid([
    'name' => 'The name field is required.',
    'email' => 'valid email address',
]);

assertViewHas ​

断言响应视图包含给定的数据：

php
$response->assertViewHas($key, $value = null);

将闭包作为第二个参数传递给 assertViewHas 方法将允许您检查并对特定的视图数据进行断言：

php
$response->assertViewHas('user', function (User $user) {
    return $user->name === 'Taylor';
});

此外，视图数据可以作为响应上的数组变量访问，方便您检查：

php
expect($response['name'])->toBe('Taylor');
php
$this->assertEquals('Taylor', $response['name']);

assertViewHasAll ​

断言响应视图具有给定的数据列表：

php
$response->assertViewHasAll(array $data);

此方法可用于断言视图简单地包含与给定键匹配的数据：

php
$response->assertViewHasAll([
    'name',
    'email',
]);

或者，您可以断言视图数据存在并具有特定值：

php
$response->assertViewHasAll([
    'name' => 'Taylor Otwell',
    'email' => 'taylor@example.com,',
]);

assertViewIs ​

断言给定视图由路由返回：

php
$response->assertViewIs($value);

assertViewMissing ​

断言给定数据键未在应用程序响应中返回的视图中提供：

php
$response->assertViewMissing($key);

认证断言 ​

Laravel 还提供了多种与认证相关的断言，您可以在应用程序的功能测试中使用。请注意，这些方法在测试类本身上调用，而不是在 Illuminate\Testing\TestResponse 实例上，该实例由 get 和 post 等方法返回。

assertAuthenticated ​

断言用户已认证：

php
$this->assertAuthenticated($guard = null);

assertGuest ​

断言用户未认证：

php
$this->assertGuest($guard = null);

assertAuthenticatedAs ​

断言特定用户已认证：

php
$this->assertAuthenticatedAs($user, $guard = null);

验证断言 ​

Laravel 提供了两种主要的与验证相关的断言，您可以使用它们来确保请求中提供的数据是有效的或无效的。

assertValid ​

断言响应对给定键没有验证错误。此方法可用于断言响应中返回的验证错误是 JSON 结构或已闪存到会话：

php
// 断言没有验证错误...
$response->assertValid();

// 断言给定键没有验证错误...
$response->assertValid(['name', 'email']);

assertInvalid ​

断言响应对给定键具有验证错误。此方法可用于断言响应中返回的验证错误是 JSON 结构或已闪存到会话：

php
$response->assertInvalid(['name', 'email']);

您还可以断言给定键具有特定的验证错误消息。在这样做时，您可以提供整个消息或仅提供消息的一小部分：

php
$response->assertInvalid([
    'name' => 'The name field is required.',
    'email' => 'valid email address',
]);

版权所有 © 2024-2025 laravel.wiki