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

发布时间 - 2022-11-28 00:00:00    点击率:

如何在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视频教程】


# php  # laravel  # count  # 子类  # enum  # 字符串  # 数据库  # https  # 重构  # 让我们  # 我们可以  # 应用程序  # 创建一个  # 在这里  # 很好  # 在我们的  # 有一个  # 可以使用  # 我们现在 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Laravel集合Collection怎么用_Laravel集合常用函数详解  如何快速选择适合个人网站的云服务器配置?  HTML透明颜色代码在Angular里怎么设置_Angular透明颜色使用指南【详解】  Laravel PHP版本要求一览_Laravel各版本环境要求对照  如何在万网开始建站?分步指南解析  nodejs redis 发布订阅机制封装实现方法及实例代码  laravel怎么实现图片的压缩和裁剪_laravel图片压缩与裁剪方法  Laravel的Blade指令怎么自定义_创建你自己的Laravel Blade Directives  WEB开发之注册页面验证码倒计时代码的实现  网站优化排名时,需要考虑哪些问题呢?  Laravel队列由Redis驱动怎么配置_Laravel Redis队列使用教程  在线制作视频网站免费,都有哪些好的动漫网站?  如何用wdcp快速搭建高效网站?  Firefox Developer Edition开发者版本入口  Python文件流缓冲机制_IO性能解析【教程】  使用spring连接及操作mongodb3.0实例  如何用已有域名快速搭建网站?  如何挑选最适合建站的高性能VPS主机?  再谈Python中的字符串与字符编码(推荐)  使用Dockerfile构建java web环境  详解Oracle修改字段类型方法总结  googleplay官方入口在哪里_Google Play官方商店快速入口指南  香港服务器部署网站为何提示未备案?  浅析上传头像示例及其注意事项  千库网官网入口推荐 千库网设计创意平台入口  html如何与html链接_实现多个HTML页面互相链接【互相】  Laravel Eloquent访问器与修改器是什么_Laravel Accessors & Mutators数据处理技巧  公司门户网站制作公司有哪些,怎样使用wordpress制作一个企业网站?  高防服务器如何保障网站安全无虞?  如何用ChatGPT准备面试 模拟面试问答与职场话术练习教程  网站制作壁纸教程视频,电脑壁纸网站?  今日头条微视频如何找选题 今日头条微视频找选题技巧【指南】  如何正确下载安装西数主机建站助手?  html5audio标签播放结束怎么触发事件_onended回调方法【教程】  如何打造高效商业网站?建站目的决定转化率  如何在云主机上快速搭建多站点网站?  如何有效防御Web建站篡改攻击?  Java类加载基本过程详细介绍  Laravel如何使用模型观察者?(Observer代码示例)  个人网站制作流程图片大全,个人网站如何注销?  魔方云NAT建站如何实现端口转发?  Android 常见的图片加载框架详细介绍  LinuxShell函数封装方法_脚本复用设计思路【教程】  JavaScript如何实现音频处理_Web Audio API如何工作?  如何在Windows虚拟主机上快速搭建网站?  学生网站制作软件,一个12岁的学生写小说,应该去什么样的网站?  浅谈javascript alert和confirm的美化  Laravel如何处理CORS跨域问题_Laravel项目CORS配置与解决方案  如何使用 jQuery 正确渲染 Instagram 风格的标签列表  Laravel如何创建和注册中间件_Laravel中间件编写与应用流程