使用RequestFactories解决LaravelFormRequest测试中的繁琐问题

在 Laravel 项目中，我们经常需要编写测试来验证 FormRequest 的行为。但是，传统的测试方法往往需要我们提供大量的默认数据，即使我们只关心其中一两个字段的验证。这使得测试代码变得冗长、难以阅读，并且增加了编写和维护测试的难度。 Request Factories 库的出现，完美地解决了这个问题。它允许我们使用工厂模式来生成 FormRequest 的数据，从而简化测试代码，提高开发效率。 Composer在线学习地址：学习地址问题：繁琐的 FormRequest 测试

在 laravel 中，formrequest 用于处理 http 请求的验证和授权逻辑。为了确保 formrequest 的正确性，我们需要编写测试来验证各种输入情况。例如，考虑以下场景：

我们有一个 SignupRequest，用于验证用户注册表单。该表单包含多个字段，如 phone、email、name、company 等。如果我们只想测试 phone 字段的验证规则，传统的测试方法需要我们提供所有其他字段的默认值，如下所示：

it('can sign up a user with an international phone number', function () {
    $this->put('/users', [
        'phone' => '+375 154 767 1088',
        'email' => 'foo@bar.com',
        'name' => 'Luke Downing',
        'company' => 'Worksome',
        'bio' => 'Blah blah blah',
        'profile_picture' => UploadedFile::fake()->image('luke.png', 200, 200),
        'accepts_terms_and_conditions' => true,
    ]);

    expect(User::latest()->first()->phone)->toBe('+375 154 767 1088');
});

这段代码存在以下问题：

• 测试代码冗长： 为了测试一个字段，我们需要提供所有其他字段的值。
• 测试代码难以阅读： 大量的默认数据使得测试代码难以理解和维护。
• 需要了解 FormRequest 的细节： 为了编写测试，我们需要了解 FormRequest 中所有字段的验证规则。

解决方案：使用 Request Factories

worksome/request-factories 库提供了一种更简洁、更高效的测试 FormRequest 的方法。它允许我们使用工厂模式来生成 FormRequest 的数据，从而简化测试代码，提高开发效率。

安装

使用 Composer 安装 worksome/request-factories 库：

composer require --dev worksome/request-factories

创建 Request Factory

使用 Artisan 命令创建一个 Request Factory：

php artisan make:request-factory "App\Http\Requests\SignupRequest"

这将在 tests/RequestFactories/SignupRequestFactory.php 创建一个新的 Request Factory。

定义 Factory

在 Request Factory 中，我们需要定义一个 definition 方法，该方法返回一个包含默认数据的数组：

namespace Tests\RequestFactories;

use Worksome\RequestFactories\RequestFactory;

class SignupRequestFactory extends RequestFactory
{
    public function definition(): array
    {
        return [
            'phone' => '01234567890',
            'email' => 'foo@bar.com',
            'name' => 'Luke Downing',
            'company' => 'Worksome',
            'bio' => $this->faker->words(300, true),
            'accepts_terms_and_conditions' => true,
        ];
    }

    public function files(): array
    {
        return [
            'profile_picture' => $this->file()->image('luke.png', 200, 200),
        ];
    }
}

使用 Factory 进行测试

现在，我们可以使用 Request Factory 来简化测试代码：

it('can sign up a user with an international phone number', function () {
    SignupRequest::fake();

    $this->put('/users', ['phone' => '+375 154 767 1088']);

    expect(User::latest()->first()->phone)->toBe('+375 154 767 1088');
});

这段代码更加简洁、易于阅读，并且只需要提供我们需要测试的字段的值。

Request Factories 的优势

• 简化测试代码： Request Factories 允许我们使用工厂模式来生成 FormRequest 的数据，从而简化测试代码。
• 提高测试效率： Request Factories 减少了编写测试所需的时间和精力。
• 提高代码可读性： 简洁的测试代码更容易理解和维护。
• 支持多种测试方法： Request Factories 提供了多种测试方法，可以根据个人喜好选择。
• 易于集成： Request Factories 可以轻松地集成到现有的 Laravel 项目中。

总结

worksome/request-factories 库是一个强大的工具，可以帮助我们更简洁、更高效地测试 Laravel FormRequest。它通过使用工厂模式来生成 FormRequest 的数据，从而简化测试代码，提高开发效率。如果你正在寻找一种更高效的测试 FormRequest 的方法，那么 worksome/request-factories 绝对值得一试。

以上就是使用RequestFactories解决LaravelFormRequest测试中的繁琐问题的详细内容，更多请关注php中文网其它相关文章！