Faker 虚拟数据填充和源码解析

weapon 发布于2019-07-01 11:16 / 1767人阅读

摘要：是一个虚拟数据的生成器，可以用它填充数据库进行压力测试或者创建优雅的文档。格式器除了以上三个属性，还提供了大量可供选择的模拟数据。

Faker 是一个虚拟数据的生成器，可以用它填充数据库进行压力测试或者创建优雅的 XML 文档。

安装

如果项目支持 composer ,使用以下命令安装。不支持请到 Faker 的 Github 仓库下载源码，放入项目的扩展包文件夹中。

composer require fzaninotto/faker

为了演示功能，我使用以下命令创建了一个新项目：

// 创建新项目文件夹
mkdir data-seeder

cd data-seeder
// 安装 faker 扩展
composer require fzaninotto/faker

基本使用方法

在根目录下创建测试文件 test.php，输入以下代码:

name, "
";
echo $faker->address, "
";
echo $faker->text;

在 CLI 模式下运行脚本， php test.php 查看输出结果。faker 的结果是随机生成的：

Prof. Kailyn Barton
9230 Herzog Groves Suite 005
Gusikowskihaven, CO 60533-4716
Nesciunt voluptas debitis iusto consectetur possimus mollitia in quam. Vel non rem temporibus illo numquam est. Sit fugit sed fugit id eligendi eaque sunt possimus.

faker 的专有名词

faker 中定义了一些专有名词帮助我们理解它的设计思路，明白这些概念对理解他的源码非常有帮助。

格式器（formatters）

除了以上三个属性，faker 还提供了大量可供选择的模拟数据。每个生成器属性（例如上面使用的 name，address 和 lorem）都被叫做 格式器（formatters）。

提供器（providers）

我们需要填充的数据有很多种类，例如

基本的随机数据：整数、浮点数、字母

随机的人物信息：姓名、姓、名等

随机的号码：手机号、电话号

Faker 将每种分类定义为 provider，查看 data-seeder/vendor/fzaninotto/faker/src/Faker/Provider 可以看到各种 provider 的类文件，以及分语言包的文件。

源码解析

faker 扩展包体积虽小，五脏俱全，非常有学习价值。

faker 对象生成

查看 faker 生成器的工厂方法：

const DEFAULT_LOCALE = "en_US";

protected static $defaultProviders = array("Address", "Barcode", "Biased", "Color", "Company", "DateTime", "File", "HtmlLorem", "Image", "Internet", "Lorem", "Miscellaneous", "Payment", "Person", "PhoneNumber", "Text", "UserAgent", "Uuid");

public static function create($locale = self::DEFAULT_LOCALE)
{
    $generator = new Generator();
    foreach (static::$defaultProviders as $provider) {
        $providerClassName = self::getProviderClassname($provider, $locale);
        $generator->addProvider(new $providerClassName($generator));
    }

    return $generator;
}

参数 locale 是语言包，默认为 en_US 美国英语。在 data-seeder/vendor/fzaninotto/faker/src/Faker/Provider 目录中可以查看所有支持的语言包。

默认的 providers（provider 已经在上面提到过），在以上 Provider 目录中可以一一对应的找到。循环数组，将对应的 provider 添加到生成器 $generator。

getProviderClassname

protected static function getProviderClassname($provider, $locale = "")
{
    if ($providerClass = self::findProviderClassname($provider, $locale)) {
        return $providerClass;
    }
    // fallback to default locale
    if ($providerClass = self::findProviderClassname($provider, static::DEFAULT_LOCALE)) {
        return $providerClass;
    }
    // fallback to no locale
    if ($providerClass = self::findProviderClassname($provider)) {
        return $providerClass;
    }
    throw new InvalidArgumentException(sprintf("Unable to find provider "%s" with locale "%s"", $provider, $locale));
}

getProviderClassname 将按照以下逻辑寻找 provider 类，如果不存在于当前文件就到下一级文件查找，找不到就会跑出异常：

用户传入的语言包文件夹 -> 默认的en_US语言包文件夹 -> Provider根目录

addProvider

public function addProvider($provider)
{
    array_unshift($this->providers, $provider);
}

addProvider 就非常简单了，只是把找到的 provider 加入数组头部，数组存储在将要返回的 $generator 对象的属性中。

faker 对象调用

在使用 faker 返回的对象时，有两种方式：调用属性和调用方法。这些调用都会触发魔术方法：

public function format($formatter, $arguments = array())
{
    return call_user_func_array($this->getFormatter($formatter), $arguments);
}

public function __get($attribute)
{
    return $this->format($attribute);
}

public function __call($method, $attributes)
{
    return $this->format($method, $attributes);
}

两者逻辑类似，这里说明相对麻烦一点的 __call 魔术方法，魔术方法会将调用的方法名和参数传入 farmat 方法。

getFormatter

public function getFormatter($formatter)
{
    if (isset($this->formatters[$formatter])) {
        return $this->formatters[$formatter];
    }
    foreach ($this->providers as $provider) {
        if (method_exists($provider, $formatter)) {
            $this->formatters[$formatter] = array($provider, $formatter);

            return $this->formatters[$formatter];
        }
    }
    throw new InvalidArgumentException(sprintf("Unknown formatter "%s"", $formatter));
}

$this->formatters 中存储的就是 faker 专有名词那里提到的 formatter（格式器）相关的信息。为了方便理解，这里以获得数组中一个随机元素为例，说明这些抽象的概念。

$faker->randomElement(["a", "b", "c"]);

当调用此方法时，触发魔术方法，然后遍历每一个 provider 类，查找是否存在此方法。直到在 Base.php 中发现存在此方法，此时要使用的提供器 provider 为 Base.php，格式器 formatter 就是 randomElement() 方法。

然后就需要将 Base 中存在 randomeElement() 的对应关系存储起来，避免下次重新遍历所有 provider，这就是 $this->formatters 实现的原因。

此方法返回对应的 provider 和 formatters 后，通过 call_user_func_array 调用并返回结果。

至此，一个完整的 faker 对象生成和调用的过程就结束了。

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/30038.html

使用 Laravel 数据填充功能生成中文测试数据

摘要：今晚不对，是昨晚，折腾一个的小项目，发现自动填充的中文数据显示起来总不太美观，于是开始琢磨如何填充中文数据进行测试。今晚……不对，是昨晚，折腾一个的小项目，发现自动填充的中文数据显示起来总不太美观，于是开始琢磨如何填充中文数据进行测试。然而一番搜索后惊奇的发现，官方、以及一些非官方的文档均未提及这一功能。期间看到一篇他人的经验文章，虽然可以实现这一需求，却要求修改 vendor 目...

whlong 2019-06-27 16:55 评论0 收藏0
项目工具:两行代码快速生成测试的数据的FakeDataMaker

摘要：开发原因是一个非常小的类库，通过代码生成来提供高性能的反射处理，自动为字段提供访问类，访问类使用字节码操作而不是的反射技术，因此非常快。开发原因 Reflec...

X_AirDu 2021-10-12 10:11 评论0 收藏0
laravel 使用 Faker 数据填充

摘要：导语做开发的时候，添加测试数据是必不可少的，内置了很方便的数据填充，下面是实例。数据填充创建数据填充文件创建完成后，我们可以在方法中手动添加几条测试数据。看下总数总数没有问题，随机看十条数据数据也是正确的。参考资料数据填充文档数据库测试。导语做开发的时候，添加测试数据是必不可少的，laravel 内置了很方便的数据填充，下面是实例。数据迁移先创建数据模型和数据迁移 php a...

hiYoHoo 2019-07-01 12:40 评论0 收藏0
Laravel 中的数据迁移和数据填充

摘要：本文首发于作者这是一篇基础教程，对标文档中的数据迁移和数据填充。那么，中的数据库迁移概念，就是用于解决团队中保证数据库结构一致的方案。和不同，如果多次执行就会进行多次数据填充。好了，数据迁移和数据填充的基本操作也就这些了。 showImg(https://segmentfault.com/img/remote/1460000012252769?w=648&h=422); 本文首发于 h...

mengera88 2019-06-28 14:22 评论0 收藏0
使用Tinker来调试Laravel应用程序的数据以及使用Tinker一些总结

摘要：不过除了使用加密，还可以使用原文链接使用来调试应用程序的数据以及使用一些总结参考资料参考资料使用来调试你的参考资料框架填充中文数据测试数据使用Tinker来调试Laravel应用程序的数据以及使用Tinker一些总结 [toc] 今天我们将讨论如何使用Laravel的一些鲜为人知的功能来快速读取Laravel应用程序中的数据。我们可以使用Laravel的手工内置php artisan...

simon_chen 2019-06-28 18:30 评论0 收藏0