Foundry 项目使用教程

Foundry 项目使用教程

foundry A model factory library for creating expressive, auto-completable, on-demand dev/test fixtures with Symfony and Doctrine. 项目地址: https://gitcode.com/gh_mirrors/foun/foundry

1. 项目介绍

Foundry 是一个用于创建具有表现力、自动补全和按需开发的测试/开发固定数据的模型工厂库。它专为 Symfony 和 Doctrine 设计，使得创建和使用固定数据变得更加简单和高效。Foundry 支持 doctrine/orm（结合 doctrine/doctrine-bundle）和 doctrine/mongodb-odm（结合 doctrine/mongodb-odm-bundle），或者两者的组合。

2. 项目快速启动

安装

首先，确保你已经安装了 Composer，然后通过 Composer 安装 Foundry：

composer require --dev zenstruck/foundry

配置

在 Symfony 项目中，Foundry 会自动注册为服务。你只需要在 config/bundles.php 中添加以下内容：

return [
    // 其他 bundles
    Zenstruck\Foundry\ZenstruckFoundryBundle::class => ['dev' => true, 'test' => true],
];

创建工厂

创建一个工厂类来生成你的实体对象。例如，如果你有一个 Post 实体，可以创建一个 PostFactory：

namespace App\Factory;

use App\Entity\Post;
use Zenstruck\Foundry\ModelFactory;
use Zenstruck\Foundry\Proxy;

class PostFactory extends ModelFactory
{
    protected function getDefaults(): array
    {
        return [
            'title' => self::faker()->sentence,
            'content' => self::faker()->paragraphs(3, true),
            'createdAt' => self::faker()->dateTimeBetween('-1 year', 'now'),
        ];
    }

    protected function initialize(): self
    {
        // 初始化逻辑
        return $this;
    }

    protected static function getClass(): string
    {
        return Post::class;
    }
}

使用工厂

在你的测试或固定数据加载器中使用工厂：

use App\Factory\PostFactory;

$post = PostFactory::new()
    ->published()
    ->create([
        'slug' => 'post-a',
    ]);

3. 应用案例和最佳实践

应用案例

Foundry 在以下场景中特别有用：

• 测试数据生成：在单元测试和功能测试中生成实体对象，确保测试数据的多样性和覆盖率。
• 开发环境数据填充：在开发环境中快速生成大量数据，方便开发和调试。

最佳实践

• 工厂类的命名：建议使用 EntityNameFactory 的命名方式，保持一致性和可读性。
• 默认值的设置：在 getDefaults 方法中设置实体的默认值，确保生成的对象具有合理的初始状态。
• 初始化逻辑：在 initialize 方法中添加自定义的初始化逻辑，例如设置关联实体或执行特定的业务逻辑。

4. 典型生态项目

Foundry 通常与其他 Symfony 和 Doctrine 生态项目结合使用，例如：

• DoctrineFixturesBundle：用于在开发和测试环境中加载固定数据。
• PHPUnit：用于编写和运行单元测试和功能测试。
• Faker：用于生成随机数据，Foundry 内部集成了 Faker，方便生成各种类型的数据。

通过结合这些工具，Foundry 可以帮助开发者更高效地创建和管理测试和开发数据，提升开发效率和代码质量。

foundry A model factory library for creating expressive, auto-completable, on-demand dev/test fixtures with Symfony and Doctrine. 项目地址: https://gitcode.com/gh_mirrors/foun/foundry