Faker 虛擬資料填充和原始碼解析

Composer · 發表 2019-01-28 18:04:17

摘要： Faker 是一個虛擬資料的生成器，可以用它填充資料庫進行壓力測試或者建立優雅的 XML 文件。安裝如果專案支援composer ,使用以下命令安裝。不支援請到Faker 的 Github 倉庫下載原始碼，放入專案的擴充套件包資料夾中。 co...

Faker 是一個虛擬資料的生成器，可以用它填充資料庫進行壓力測試或者建立優雅的 XML 文件。

安裝

如果專案支援composer ,使用以下命令安裝。不支援請到Faker 的 Github 倉庫下載原始碼，放入專案的擴充套件包資料夾中。

composer require fzaninotto/faker

為了演示功能，我使用以下命令建立了一個新專案：

// 建立新專案資料夾
mkdir data-seeder

cd data-seeder
// 安裝 faker 擴充套件
composer require fzaninotto/faker

基本使用方法

在根目錄下建立測試檔案test.php ，輸入以下程式碼:

<?php

require_once __DIR__ . '/vendor/fzaninotto/faker/src/autoload.php';

$faker = Faker\Factory::create();

echo $faker->name, "\n";
echo $faker->address, "\n";
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 物件生成和呼叫的過程就結束了。