Laravel：使用 Faker 播种多个独特的列

Question

简介

伙计们，我有一个关于模型工厂和多个唯一列的问题：

背景

我有一个名为 Image 的模型。此模型具有存储在单独模型 ImageText 中的语言支持。 ImageText 有一个 image_id 列、一个语言列和一个文本列。

ImageText 在 MySQL 中有一个约束，即组合 image_id 并且语言必须是唯一的。

class CreateImageTextsTable extends Migration
{

    public function up()
    {
        Schema::create('image_texts', function ($table) {

            ...

            $table->unique(['image_id', 'language']);

            ...

        });
    }

    ...

现在，我希望每个 Image 在播种完成后有多个 ImageText 模型。使用模型工厂和这个播种机很容易：

factory(App\Models\Image::class, 100)->create()->each(function ($image) {
    $max = rand(0, 10);
    for ($i = 0; $i < $max; $i++) {
        $image->imageTexts()->save(factory(App\Models\ImageText::class)->create());
    }
});

问题

但是，当使用模型工厂和 faker 进行播种时，您经常会看到以下消息：

[PDOException]                                                                                                                 
SQLSTATE[23000]: Integrity constraint violation: 1062 Duplicate entry '76-gn' for key 'image_texts_image_id_language_unique'

这是因为在某个时候，在那个 for 循环中，伪造者会为一张图像随机生成两次相同的语言代码，从而打破 ['image_id'、'language'] 的唯一约束。

您可以将 ImageTextFactory 更新为：

$factory->define(App\Models\ImageText::class, function (Faker\Generator $faker) {

    return [
        'language' => $faker->unique()->languageCode,
        'title' => $faker->word,
        'text' => $faker->text,
    ];
});

但是，你反而会遇到这样的问题，即在创建了足够多的图像文本后，伪造者将运行超出 languageCodes。

当前解

目前通过为 ImageText 使用两个不同的工厂来解决这个问题，其中一个工厂重置语言代码的唯一计数器，播种器在进入 for 循环以创建更多 ImageText 之前调用重置唯一计数器的工厂。但这是代码重复，应该有更好的方法来解决这个问题。

问题

有什么办法可以把你保存的模型送进工厂吗？如果是这样，我可以检查工厂内部以查看当前图像是否已经附加了任何 ImageText，如果没有，则重置 languageCodes 的唯一计数器。我的目标是这样的：

$factory->define(App\Models\ImageText::class, function (Faker\Generator $faker) {

    $firstImageText = empty($image->imageTexts());

    return [
        'language' => $faker->unique($firstImageText)->languageCode,
        'title' => $faker->word,
        'text' => $faker->text,
    ];
});

当然目前给出：

[ErrorException]           
Undefined variable: image

是否有可能以某种方式实现这一点？

Answer 1

我解决了

我搜索了很多解决这个问题的方法，发现很多其他人也遇到过。如果关系的另一端只需要一个元素，it's very straight forward.

"multi column unique restriction" 的添加使事情变得复杂。我找到的唯一解决方案是 "Forget the MySQL restriction and just surround the factory creation with a try-catch for PDO-exceptions"。这感觉像是一个糟糕的解决方案，因为其他 PDOException 也会被捕获，而且它只是感觉不到 "right".

解决方案

为了完成这项工作，我将播种器分为 ImageTableSeeder 和 ImageTextTableSeeder，它们都非常简单。他们的运行命令都是这样的：

public function run()
{
    factory(App\Models\ImageText::class, 100)->create();
}

魔术发生在 ImageTextFactory 内部：

$factory->define(App\Models\ImageText::class, function (Faker\Generator $faker) {

    // Pick an image to attach to
    $image = App\Models\Image::inRandomOrder()->first();
    $image instanceof App\Models\Image ? $imageId = $image->id : $imageId = null;

    // Generate unique imageId-languageCode combination
    $imageIdAndLanguageCode = $faker->unique()->regexify("/^$imageId-[a-z]{2}");
    $languageCode = explode('-', $imageIdAndLanguageCode)[1];

    return [
        'image_id' => $imageId,
        'language' => $languageCode,
        'title' => $faker->word,
        'text' => $faker->text,
    ];
});

就是这样：

$imageIdAndLanguageCode = $faker->unique()->regexify("/^$imageId-[a-z]{2}");

我们在 regexify 表达式中使用 imageId 并添加我们唯一组合中也包含的任何内容，在本例中用“-”字符分隔。这将生成“841-en”、“58-bz”、“96-xx”等结果，其中 imageId 始终是我们数据库中的真实图像，或者为 null。

由于我们将唯一标签与 imageId 一起附加到语言代码，我们知道 image_id 和语言代码的组合将是唯一的。这正是我们需要的！

现在我们可以简单地提取创建的语言代码，或者我们想要生成的任何其他唯一字段，使用：

$languageCode = explode('-', $imageIdAndLanguageCode)[1];

这种方法有以下优点：

无需捕获异常
为了便于阅读，可以将 Factories 和 Seeders 分开
代码紧凑

此处的缺点是您只能生成其中一个键可以表示为正则表达式的组合键。只要可能，这似乎是解决此问题的好方法。

Answer 2

您的解决方案仅适用于可以作为组合进行正则化的事物。在许多用例中，多个单独的 Faker 生成的 numbers/strings/other 对象的组合需要唯一且不能被正则化。

对于这种情况，您可以这样做：

$factory->define(App\Models\YourModel::class, function (Faker\Generator $faker) {
    static $combos;
    $combos = $combos ?: [];
    $faker1 = $faker->something();
    while($faker2 = $faker->somethingElse() && in_array([$faker1, $faker2], $combos) {}
    $combos[] = [$faker1, $faker2];
    return ['field1' => $faker1, 'field2' => $faker2];
});

对于您的具体问题/用例，这里有一个相同的解决方案：

$factory->define(App\Models\ImageText::class, function (Faker\Generator $faker) {

    static $combos;
    $combos = $combos ?: [];

    // Pick an image to attach to
    $image = App\Models\Image::inRandomOrder()->first();
    $image instanceof App\Models\Image ? $imageId = $image->id : $imageId = null;

    // Generate unique imageId-languageCode combination
    while($languageCode = $faker->languageCode && in_array([$imageId, $languageCode], $combos) {}
    $combos[] = [$imageId, $languageCode];

    return [
        'image_id' => $imageId,
        'language' => $languageCode,
        'title' => $faker->word,
        'text' => $faker->text,
    ];
});

Answer 3

这是处理 table 播种机 class 中唯一约束问题的另一种方法。

我将以名为 JobCategory 的模型为例。

对于 JobCategory，列“title”具有唯一约束。

工厂内class:

$factory->define(JobCategory::class, function (Faker $faker) {
    return [
        'title' => $faker->words(3, true),
        'description' => $faker->paragraphs(2, true),
    ];
});

然后，在播种机中class：

class JobCategoryTableSeeder extends Seeder
{
    private $failures = 0;

    /**
     * Run the database seeds.
     *
     * @return void
     */
    public function run() 
    {
        try {
            factory(JobCategory::class, 30)->create();
        } catch(Exception $e) {

            if($this->failures > 5) {
                print_r("Seeder Error. Failure count for current entity: " . $this->failures);
                return;
            }
            
            $this->failures++;
            $this->run(); // retry again until the number of failure is greater than 5
        }
    }
}

解释：

想法是捕获可能由唯一约束失败导致的异常，然后通过递归调用方法重试播种，直到满足退出条件。
我上面的例子，我想创建30条记录，但是由于异常重试，我可能会得到多于或少于30条记录。
我选择了5次重试，你可以使用任意合适的重试次数。

Answer 4

我根据 Rkey 的回答来满足我的需要：

问题
我有两个整数字段一起应该是唯一的，它们是 product_id 和 branch_id.

解决方案
这是我的方法：

获取产品和分支的总数。由于 id 是从 1 生成的，因此 id 的范围应从 1 到 [=46] 中的项目总数=](s).
创建所有可能的唯一值，这些值可以通过创建由字符分隔的字符串从 product_id 和 branch_id 创建，在本例中为 -
使用 randomElements 函数从此集合生成唯一的随机值。
将随机元素拆分回product_id和branch_id

    $branch_count = Branch::all()->count();
    $product_count = Product::all()->count();

    $branch_products = [];
    for ($i = 1; $i <= $branch_count; $i++) {
      for ($j = 1; $j <= $product_count; $j++) {
        array_push($branch_products, $i . "-" . $j);
      }
    }

    $branch_and_product = $this->faker->unique->randomElement($branch_products);

    $branch_and_product = explode('-', $branch_and_product);
    $branch_id = $branch_and_product[0];
    $product_id = $branch_and_product[1];

    return [
      // other fields
      // ...
      "branch_id" =>  $branch_id,
      "product_id" => $product_id
    ];

Answer 5

我正在使用 Laravel 8.x，但我不知道我使用的列函数定义是否适用于以前的版本。

我遇到了同样的问题，但使用了不同的方法。

我这样创建 ImageTextFactory：

<?php

namespace Database\Factories;

use App\Models\ImageText;
use Illuminate\Database\Eloquent\Factories\Factory;

class ImageTextFactory extends Factory
{
    /**
     * The name of the factory's corresponding model.
     *
     * @var string
     */
    protected $model = ImageText::class;

    /**
     * The number of models created till now.
     *
     * @var integer
     */
    protected $created = 0;

    /**
     * Define the model's default state.
     *
     * @return array
     */
    public function definition()
    {
        $this->created++;

        return [
            'language' => function (array $attributes) {
                $count = ImageText::where(
                    'image_id',
                    $attributes['image_id']
                )
                ->count();

                $reset = $this->created == 1 && $count == 0;

                return $this->faker->unique($reset)->languageCode();
            },
            'title' => $this->faker->word(),
            'text' => $this->faker->sentence(),
        ];
    }
}

然后我从播种机调用工厂：

Image::factory()
    ->count(10)
    ->has(
        ImageText::factory()->count(rand(0, 10))
    )->create();

通过定义中的函数，我可以检查之前是否为 image_id 定义了 ImageText 以及生成了多少模型。当为每个 ImageFactory 生成一个 ImageTextFactory 实例时，它会自动将 $created 计数器重置为 0；由于播种者将始终按顺序创建图像，因此一定不会产生问题。

它有一个缺点，如果为已经存在的模型调用工厂，它将从 Faker 生成一个 OverflowException，因为没有新的 id 来重置唯一约束。它应该只用 has 方法生成。

Laravel：使用 Faker 播种多个独特的列

Laravel: Seeding multiple unique columns with Faker

php

mysql

laravel

laravel-5.4

laravel-seeding