社区 学习 工具库 休闲
搜索
简体中文
首页 > php框架 > Laravel > 如何在Laravel应用程序中使用模型工厂？

如何在Laravel应用程序中使用模型工厂？

青灯夜游
发布： 2022-11-28 20:26:22
转载
1197 人浏览过

如何在Laravel应用程序中使用模型工厂？下面本篇文章给大家介绍一下在测试中使用 Laravel 模型工程的方法，希望对大家有所帮助！

如何在Laravel应用程序中使用模型工厂？

Laravel 模型工厂是你可以在应用程序中进行测试时使用的最佳功能之一。它们提供了一种定义可预测且易于复制的数据的方法，以便你的测试保持一致和可控。

让我们从一个简单的例子开始。我们有一个用于写博客的应用程序，所以很自然地，我们有一个 Post 模型，该模型具有发布、起草或排队的状态。让我们看一下这个例子的 Eloquent 模型：

declare(strict_types=1);

namespace App\Models;

use App\Publishing\Enums\PostStatus;
use Illuminate\Database\Model;

class Post extends Model
{
    protected $fillable = [
        'title',
        'slug',
        'content',
        'status',
        'published_at',
    ];

    protected $casts = [
        'status' => PostStatus::class,
        'published_at' => 'datetime',
    ];
}
登录后复制

正如你在此处看到的，我们有一个用于状态列的 Enum，我们现在将对其进行设计。在这里使用枚举允许我们利用 PHP 8.1 的特性，而不是纯字符串、布尔标志或混乱的数据库枚举。

 declare(strict_types=1);

namespace App\Publishing\Enums;

enum PostStatus: string
{
    case PUBLISHED = 'published';
    case DRAFT = 'draft';
    case QUEUED = 'queued';
}
登录后复制

现在，让我们回到我们在这里讨论的主题：模型工厂。一个简单的工厂看起来很简单：

 declare(strict_types=1);

namespace Database\Factories;

use App\Models\Post;
use App\Publishing\Enums\PostStatus;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Arr;
use Illuminate\Support\Str;

class PostFactory extends Factory
{
    protected $model = Post::class;

    public function definition(): array
    {
        $title = $this->faker->sentence();
        $status = Arr::random(PostStatus::cases());

        return [
            'title' => $title,
            'slug' => Str::slug($title),
            'content' => $this->faker->paragraph(),
            'status' => $status->value,
            'published_at' => $status === PostStatus::PUBLISHED
                ? now()
                : null,
        ];
    }
}
登录后复制

所以在我们的测试中，我们现在可以快速调用我们的 post factory 为我们创建一个 post。让我们看看我们可以如何做到这一点：

 it('can update a post', function () {
    $post = Post::factory()->create();

    putJson(
        route('api.posts.update', $post->slug),
        ['content' => 'test content',
    )->assertSuccessful();

    expect(
        $post->refresh()
    )->content->toEqual('test content');
});
登录后复制
登录后复制

一个足够简单的测试，但是如果我们的业务规则规定你只能根据帖子类型更新特定列，会发生什么？让我们重构我们的测试以确保我们可以做到这一点：

it('can update a post', function () {
    $post = Post::factory()->create([
        'type' => PostStatus::DRAFT->value,
    ]);

    putJson(
        route('api.posts.update', $post->slug),
        ['content' => 'test content',
    )->assertSuccessful();

    expect(
        $post->refresh()
    )->content->toEqual('test content');
});
登录后复制

完美，我们可以将一个参数传递给 create 方法，以确保我们在创建它时设置正确的类型，这样我们的业务规则就不会抱怨。但是这样写有点麻烦，所以让我们稍微重构一下我们的工厂，添加修改状态的方法：

 declare(strict_types=1);

namespace Database\Factories;

use App\Models\Post;
use App\Publishing\Enums\PostStatus;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;

class PostFactory extends Factory
{
    protected $model = Post::class;

    public function definition(): array
    {
        $title = $this->faker->sentence();

        return [
            'title' => $title,
            'slug' => Str::slug($title),
            'content' => $this->faker->paragraph(),
            'status' => PostStatus::DRAFT->value,
            'published_at' => null,
        ];
    }

    public function published(): static
    {
        return $this->state(
            fn (array $attributes): array => [
                'status' => PostStatus::PUBLISHED->value,
                'published_at' => now(),
            ],
        );
    }
}
登录后复制

我们为工厂设置了默认值，以便所有新创建的帖子都是草稿。然后我们添加一个设置要发布的状态的方法，它将使用正确的 Enum 值并设置发布日期 - 在测试环境中更具可预测性和可重复性。让我们看看我们的测试现在是什么样子：

 it('can update a post', function () {
    $post = Post::factory()->create();

    putJson(
        route('api.posts.update', $post->slug),
        ['content' => 'test content',
    )->assertSuccessful();

    expect(
        $post->refresh()
    )->content->toEqual('test content');
});
登录后复制
登录后复制

回到一个简单的测试——所以如果我们有多个测试想要创建一个草稿帖子，他们可以使用工厂。现在让我们为发布的状态编写一个测试，看看是否有错误。

 it('returns an error when trying to update a published post', function () {
    $post = Post::factory()->published()->create();

    putJson(
        route('api.posts.update', $post->slug),
        ['content' => 'test content',
    )->assertStatus(Http::UNPROCESSABLE_ENTITY());

    expect(
        $post->refresh()
    )->content->toEqual($post->content);
});
登录后复制

这次我们正在测试当我们尝试更新已发布的帖子时是否收到验证错误状态。这可确保我们保护我们的内容并在我们的应用程序中强制执行特定的工作流程。

那么如果我们还想确保工厂中的特定内容会发生什么呢？我们可以根据需要添加另一种方法来修改状态：

 declare(strict_types=1);

namespace Database\Factories;

use App\Models\Post;
use App\Publishing\Enums\PostStatus;
use Illuminate\Database\Eloquent\Factories\Factory;
use Illuminate\Support\Str;

class PostFactory extends Factory
{
    protected $model = Post::class;

    public function definition(): array
    {
        return [
            'title' => $title = $this->faker->sentence(),
            'slug' => Str::slug($title),
            'content' => $this->faker->paragraph(),
            'status' => PostStatus::DRAFT->value,
            'published_at' => null,
        ];
    }

    public function published(): static
    {
        return $this->state(
            fn (array $attributes): array => [
                'status' => PostStatus::PUBLISHED->value,
                'published_at' => now(),
            ],
        );
    }

    public function title(string $title): static
    {
        return $this->state(
            fn (array $attributes): array => [
                'title' => $title,
                'slug' => Str::slug($title),
            ],
        );
    }
}
登录后复制

因此，在我们的测试中，我们可以创建一个新测试，以确保我们可以通过我们的 API 更新草稿帖子标题：

 it('can update a draft posts title', function () {
    $post = Post::factory()->title('test')->create();

    putJson(
        route('api.posts.update', $post->slug),
        ['title' => 'new title',
    )->assertSuccessful();

    expect(
        $post->refresh()
    )->title->toEqual('new title')->slug->toEqual('new-title');
});
登录后复制

所以我们可以很好地使用工厂状态来控制我们的测试环境中的东西，给我们尽可能多的控制权。这样做将确保我们始终如一地准备测试，或者很好地反映特定点的应用程序状态。

如果我们需要为我们的测试创建许多模型，我们该怎么办？我们应该怎么做？简单的答案是告诉工厂：

it('lists all posts', function () {
    Post::factory(12)->create();

    getJson(
        route('api.posts.index'),
    )->assertOk()->assertJson(fn (AssertableJson $json) =>
        $json->has(12)->etc(),
    );
});
登录后复制

所以我们正在创建 12 个新帖子，并确保当我们获得索引路由时，我们有 12 个帖子返回。除了将 count 传递给工厂方法，你还可以使用 count 方法：

Post::factory()->count(12)->create();
登录后复制

但是，在我们的应用程序中，有时我们可能希望以特定顺序运行事物。假设我们希望第一个是草稿，但第二个已发布？

 it('shows the correct status for the posts', function () {
    Post::factory()
        ->count(2)
        ->state(new Sequence(
            ['status' => PostStatus::DRAFT->value],
            ['status' => PostStatus::PUBLISHED->value],
        ))->create();

    getJson(
        route('api.posts.index'),
    )->assertOk()->assertJson(fn (AssertableJson $json) =>
        $json->where('id', 1)
            ->where('status' PostStatus::DRAFT->value)
            ->etc();
    )->assertJson(fn (AssertableJson $json) =>
        $json->where('id', 2)
            ->where('status' PostStatus::PUBLISHED->value)
            ->etc();
    );
});
登录后复制

你如何在应用程序中使用模型工厂？你有没有找到任何很酷的方法来使用它们？在 twitter 上告诉我们！

原文地址：https://laravel-news.com/laravel-model-factories

译文地址：https://learnku.com/laravel/t/70290

【相关推荐：laravel视频教程】

以上是如何在Laravel应用程序中使用模型工厂？的详细内容。更多信息请关注PHP中文网其他相关文章！

相关标签：
php laravel
来源：learnku.com
上一篇：laravel9 和 laravels 性能大比拼！ 下一篇：Laravel消息提示扩展推荐：spatie/Laravel-flash
本站声明
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系admin@php.cn
作者最新文章
最新问题
PHP数组从URL参数中获取的行为不如预期 我有一个包含类别ID的URL参数，我想将其视为一个数组，如下所示：http://example.com?cat[]=3,9,13在PHP中，我使用它从URL参数获取数组：$catI...
来自于 2024-04-06 22:09:02
0
1
1428
我应该在 apache 中哪里放置 CustomLog 指令 我正在使用php:7.2-apachedocker。我需要禁用运行状况检查url登录访问日志。基于此链接，他们提到了有关修改Customlog指令的信息。我不是关于需要更改Cust...
来自于 2024-04-06 22:03:59
0
1
990
返回值中变量的格式是什么？ 我是php的新学习者。我发现有一段代码：if($x<time()){return[false,'error'];}逻辑或变量并不重要，但我不明白[false,'error']...
来自于 2024-04-06 21:55:20
0
1
778
使用opentbs生成odt文件时遇到的问题：相同key的值显示在同一行而不是单独的列中。 我正在使用一个名为OpenTbs的库来使用PHP创建odt，我使用它是因为动态生成列和行。我知道如何创建行和列，但我不知道如何组织它们。让我添加一个例子：所以首先我会将其添加到我的...
来自于 2024-04-06 20:18:18
0
1
483
按照ID对MySQL结果进行分组以便循环遍历 我有一个表，其中有mysql中的航班数据。我正在编写一个php代码，它将使用codeigniter3对数据进行分组和显示journey_idair_idFlightDuration...
来自于 2024-04-06 17:27:56
0
1
406
相关专题
更多>
热门推荐
热门教程
更多>
相关教程
热门推荐
最新课程
最新下载
更多>
网站特效
网站源码
网站素材
前端模板