Bogus 實戰:使用 Bogus 和 EFCore 生成模擬數據和種子數據【完整教程】

来源:https://www.cnblogs.com/ruipeng/p/18138134
-Advertisement-
Play Games

引言 上一章我們介紹了在xUnit單元測試中用xUnit.DependencyInject來使用依賴註入,上一章我們的Sample.Repository倉儲層有一個批量註入的介面沒有做單元測試,今天用這個示例來演示一下如何用Bogus創建模擬數據 ,和 EFCore 的種子數據生成 Bogus 的優 ...


引言

上一章我們介紹了在xUnit單元測試中用xUnit.DependencyInject來使用依賴註入,上一章我們的Sample.Repository倉儲層有一個批量註入的介面沒有做單元測試,今天用這個示例來演示一下如何用Bogus創建模擬數據 ,和 EFCore 的種子數據生成

Bogus 的優勢

  1. 豐富的數據生成支持:Bogus 提供了廣泛的 API 支持,涵蓋了各種數據類型和用例,使得生成虛假數據變得非常靈活和方便。

  2. 重覆性和可控性:通過設置種子值,可以確保生成的虛假數據是可重覆的,這對於需要一致的測試數據或示例數據非常有用。

  3. 易於使用:Bogus 使用流暢的語法和簡單的方法調用,使得生成虛假數據變得簡單直觀,即使是對庫不熟悉的用戶也可以快速上手。

  4. 內置規則和語義:內置了許多常見數據類別的規則和語義,例如公司名稱、產品名稱、地址等,可以快速生成符合實際場景的數據。

  5. 靈活性:除了內置規則外,還可以通過自定義規則來生成特定的數據,滿足不同場景下的需求。

  6. 社區支持:Bogus 是一個受歡迎的開源庫,擁有活躍的社區支持和維護,可以獲得持續的更新和改進。

Bogus 實戰

簡介

Bogus 是一個簡單的.NET 語言(如 C#F#VB.NET)的假數據生成器。Bogus 本質上是 faker.jsC#移植版本,並受到 FluentValidation 的語法糖的啟發。

使用

創建新的xUnit測試項目dotNetParadise.Bogus

Nuget包安裝Bogus

Install-Package Bogus

PM> NuGet\Install-Package Bogus -Version 35.5.0

和上一篇的配置一樣,測試項目需要添加倉儲層的項目引用,並通過Nuget安裝xUnit.DependencyInject,配置Startup

先看一下我們的Staff實體

public class Staff
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public int? Age { get; set; }
    public List<string>? Addresses { get; set; }
    public DateTimeOffset? Created { get; set; }
}

接下來對我們批量新增的介面進行單元測試,測試數據通過Bogus生成,先看使用在講解用法。

生成500條測試數據保存到 DB

[Fact]
public async Task BatchAddStaffAsync_WhenCalled_ShouldAddStaffToDatabase()
{
    // Arrange
    var staffs = new Faker<Staff>()
        .RuleFor(u => u.Name, f => f.Person.FullName)
        .RuleFor(u => u.Email, f => f.Person.Email)
        .RuleFor(u => u.Age, f => f.Random.Number(18, 60))
        .RuleFor(u => u.Addresses, f => f.MakeLazy(f.Random.Number(1, 3), () => f.Address.FullAddress()))
        .RuleFor(u => u.Created, f => f.Date.PastOffset())
        .Generate(500);

    // Act
    await _staffRepository.BatchAddStaffAsync(staffs, CancellationToken.None);

    // Assert
    var retrievedStaffs = await _staffRepository.GetAllStaffAsync(CancellationToken.None);
    Assert.NotNull(retrievedStaffs); // 確保 Staff 已成功添加到資料庫
    Assert.Equal(500, retrievedStaffs.Count); // 確保正確數量的 Staff 已添加到資料庫
    Assert.True(staffs.All(x => retrievedStaffs.Any(_ => x.Id == _.Id)));
}

看代碼配置跟FluentValidation都是一樣都是通過RuleFor來配置實體的屬性

看一下生成的測試數據

image

Run Tests

image

單元測試成功,有了Bogus之後我們創建一些測試數據就方便多了

Bogus 的用法

locales 國際化

Bogus 支持許多不同的地區設置(locales),這些地區設置可用於生成特定語言或地區的虛假數據。您可以通過設置不同的 locale 參數來使用不同的地區設置。

Bogus 支持以下地區設置(locales

Locale Code Language Locale Code Language
af_ZA Afrikaans fr_CH French (Switzerland)
ar Arabic ge Georgian
az Azerbaijani hr Hrvatski
cz Czech id_ID Indonesia
de German it Italian
de_AT German (Austria) ja Japanese
de_CH German (Switzerland) ko Korean
el Greek lv Latvian
en English nb_NO Norwegian
en_AU English (Australia) ne Nepalese
en_AU_ocker English (Australia Ocker) nl Dutch
en_BORK English (Bork) nl_BE Dutch (Belgium)
en_CA English (Canada) pl Polish
en_GB English (Great Britain) pt_BR Portuguese (Brazil)
en_IE English (Ireland) pt_PT Portuguese (Portugal)
en_IND English (India) ro Romanian
en_NG Nigeria (English) ru Russian
en_US English (United States) sk Slovakian
en_ZA English (South Africa) sv Swedish
es Spanish tr Turkish
es_MX Spanish (Mexico) uk Ukrainian
fa Farsi vi Vietnamese
fi Finnish zh_CN Chinese
fr French zh_TW Chinese (Taiwan)
fr_CA French (Canada) zu_ZA Zulu (South Africa)

有些地區設置可能沒有完整的數據集,比如說,有些語言可能缺少某些數據集,例如中文(zh_CN)可能沒有 lorem 數據集,但韓語(ko)有。在這種情況下,Bogus 會預設使用英文(en)的數據集。換句話說,如果找不到特定語言的數據集,就會退而使用英文的數據集。如果您有興趣幫助貢獻新的地區設置或更新現有的設置,請查看我們的創建地區設置頁面獲取更多信息。

來驗證一下

    [Theory]
    [InlineData(null)]
    [InlineData("zh_CN")]
    public void Locales_ConfigTest(string? locale)
    {
        //default
        var faker = locale is null ? new Faker<Staff>() : new Faker<Staff>(locale);

        faker.RuleFor(u => u.Name, f => f.Person.FullName)
            .RuleFor(u => u.Email, f => f.Person.Email)
            .RuleFor(u => u.Age, f => f.Random.Number(18, 60))
            .RuleFor(u => u.Addresses, f => f.MakeLazy(f.Random.Number(1, 3), () => f.Address.FullAddress()).ToList())
            .RuleFor(u => u.Created, f => f.Date.PastOffset());
        var staff = faker.Generate();
        var consoleType = locale is null ? "default" : locale;
        testOutputHelperAccessor.Output?.WriteLine($"{consoleType}:{JsonConvert.SerializeObject(staff)}");
    }

OutPut

  default:{"Id":0,"Name":"Clyde Price","Email":"[email protected]","Age":39,"Addresses":["46277 Abraham Parkways, South Spencerland, Guadeloupe","6470 Porter Island, Lesliehaven, Chad","10804 Halvorson Brook, Ninaton, Iran"],"Created":"2023-04-30T11:31:35.5106219+08:00"}
    zh_CN:{"Id":0,"Name":"昊焱 尹","Email":"[email protected]","Age":58,"Addresses":["孫橋5號, 珠林市, Costa Rica"],"Created":"2024-02-11T08:16:49.1807504+08:00"}

可以看出預設是en 英文,通過設置locale可以實現國際化的輸出。

生成相同數據集

// 如果您希望生成可重覆的數據集,請設置隨機數種子。
Randomizer.Seed = new Random(8675309);

這段代碼用於設置隨機數生成器的種子,以便生成可重覆的數據集。通過指定一個固定的種子值,可以確保每次運行生成的隨機數據都是相同的,從而實現數據集的重覆性。

這個比較有意思,我們來做個 demo,要求隨機生成五個對象 要求下一次運行生成的還是同一批對象。
BogusSeed 就很容易實現。

   [Fact]
   public void Bogus_Compare_SeedTest()
   {
       // Arrange
       var faker = new Faker<Staff>()
           .RuleFor(u => u.Name, f => f.Person.FullName)
           .RuleFor(u => u.Email, f => f.Person.Email)
           .RuleFor(u => u.Age, f => f.Random.Number(18, 60))
           .RuleFor(u => u.Addresses, f => f.MakeLazy(f.Random.Number(1, 3), () => f.Address.FullAddress()).ToList())
           .RuleFor(u => u.Created, f => f.Date.PastOffset());

       // Act
       var staffs1 = Enumerable.Range(1, 5)
           .Select(_ => faker.UseSeed(_).Generate())
           .ToList();

       OutputStaffInformation(staffs1, "第一次");

       var staffs2 = Enumerable.Range(1, 5)
           .Select(_ => faker.UseSeed(_).Generate())
           .ToList();

       OutputStaffInformation(staffs2, "第二次");

       // Assert
       Assert.True(staffs1.All(staff1 => staffs2.Any(staff2 => staff1.Name == staff2.Name && staff1.Email == staff2.Email)));
   }

   private void OutputStaffInformation(List<Staff> staffs, string iteration)
   {
       foreach (Staff staff in staffs)
       {
           testOutputHelperAccessor.Output?.WriteLine($"{iteration}: name: {staff.Name}, email: {staff.Email}");
       }
   }
  • Arrange 部分初始化了一個 Faker<Staff> 實例,並定義了一系列規則來生成 Staff 對象。
  • Act 部分通過使用不同的種子值,生成了兩組包含 5 個 Staff 對象的列表,並輸出了每個 Staff 對象的姓名和郵箱信息。
  • Assert 部分使用斷言驗證了兩組生成的 Staff 列表中是否存在具有相同姓名和郵箱的對象,即通過 All 和 Any 方法進行比較。

通過使用不同的種子值來生成多組數據,然後斷言這些數據中是否存在相同的姓名和郵箱信息。

image

Bogus Api 支持

Bogus之所以提供這麼方便的假數據生成,得益於封裝了開箱即用的獲取各類數據的方法,如:

Address

  • ZipCode - 獲取郵政編碼。
  • City - 獲取城市名稱。
  • StreetAddress - 獲取街道地址。
  • CityPrefix - 獲取城市首碼。
  • CitySuffix - 獲取城市尾碼。
  • StreetName - 獲取街道名稱。
  • BuildingNumber - 獲取建築編號。
  • StreetSuffix - 獲取街道尾碼。
  • SecondaryAddress - 獲取次要地址,如 '公寓 2' 或 '321 號套房'。
  • County - 獲取縣名。
  • Country - 獲取國家。
  • FullAddress - 獲取完整地址,包括街道、城市、國家。
  • CountryCode - 獲取隨機的 ISO 3166-1 國家代碼。
  • State - 獲取隨機州名。
  • StateAbbr - 獲取州名縮寫。
  • Latitude - 獲取緯度。
  • Longitude - 獲取經度。
  • Direction - 生成基數或序數方向,例如:西北、南、西南、東。
  • CardinalDirection - 生成基數方向,例如:北、南、東、西。
  • OrdinalDirection - 生成序數方向,例如:西北、東南、西南、東北。

Commerce

  • Department - 獲取隨機商務部門。
  • Price - 獲取隨機產品價格。
  • Categories - 獲取隨機產品類別。
  • ProductName - 獲取隨機產品名稱。
  • Color - 獲取隨機顏色。
  • Product - 獲取隨機產品。
  • ProductAdjective - 隨機產品形容詞。
  • ProductMaterial - 隨機產品材料。
  • Ean8 - 獲取隨機的 EAN-8 條形碼號碼。
  • Ean13 - 獲取隨機的 EAN-13 條形碼號碼。

後面的可以查看官網 Api 官網地址在文末...

Bogus 庫提供了豐富的 API 支持,涵蓋了各種數據類型和用例,包括地址、商務、日期、金融、圖片、互聯網、Lorem 文本、姓名、電話等方面的虛假數據生成方法。

image

EFCore 利用 Bogus 生成種子數據

在我們的Sample.Repository中設置種子數據

  • 使用 Bogus 庫生成虛假數據,填充到 Staffs 列表

public class FakeData
{
    public static List<Staff> Staffs = [];

    public static void Init(int count)
    {
        var id = 1;
        var faker = new Faker<Staff>()
            .RuleFor(_ => _.Id, f => id++)
       .RuleFor(u => u.Name, f => f.Person.FullName)
       .RuleFor(u => u.Email, f => f.Person.Email)
       .RuleFor(u => u.Age, f => f.Random.Number(18, 60))
       .RuleFor(u => u.Addresses, f => f.MakeLazy(f.Random.Number(1, 3), () => f.Address.FullAddress()).ToList())
       .RuleFor(u => u.Created, f => f.Date.PastOffset());
        var staffs = faker.Generate(count);
        FakeData.Staffs.AddRange(staffs);
    }
}
  • Program 寫入 1000 條種子數據

using (var context = app.Services.CreateScope().ServiceProvider.GetRequiredService<SampleDbContext>())
{
    context.Database.EnsureCreated();
    FakeData.Init(1000);
    await context.Staffs.AddRangeAsync(FakeData.Staffs);
    await context.SaveChangesAsync();
}

我這地方用的是Microsoft.EntityFrameworkCore.InMemory記憶體資料庫,正常如果使用像Sqlserver,MySQLCodeFirst模式可以在 DbContext 的OnModelCreating配置種子數據。

    protected override void OnModelCreating(ModelBuilder builder)
    {
        base.OnModelCreating(builder);
        //FakeData.Init(1000);
        //builder.Entity<Staff>().HasData(FakeData.Staffs);
    }

來測試一下

通過我們Sample.Api提供的GetAll的方法測試一下種子數據

image

正好一千條測試數據,大功告成。

最後

在軟體開發中,使用 Bogus 可以極大地簡化測試數據的創建過程,同時結合 EFCore 的種子數據功能,可以快速生成並初始化資料庫中的虛假數據。這種方法不僅提高了開發效率,還能確保測試數據的質量和一致性。通過本文的示例和說明,希望您能更加熟悉如何利用 BogusEFCore 來生成模擬數據和種子數據,從而為軟體開發過程提供更好的支持和幫助,我們有大量數據的測試需求時,也不用再為創造數據而煩惱。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 左手編程,右手年華。大家好,我是一點,關註我,帶你走入編程的世界。 公眾號:一點sir,關註領取編程資料 介紹 函數跳轉是要給IDE中非常重要也非常常用的功能,而原生的 Vim 並不提供這個功能,這個確定有點讓人遺憾,按理說這麼常用的功能應該是要提供的。但是沒有關係,有插件可以實現這樣的功能更,藉助 ...
  • 地球人皆知,許多物聯網教程作者的心中都深愛著一燈大師,所以第一個常式總喜歡點燈,高級一點的會來個“一閃一閃亮晶晶”。老周今天要扯的也是和燈有關的,但不單純地點個燈,那樣實在不好玩,缺乏樂趣。老周打算舞個龍燈,哦不,是用 LED 彩色燈帶給伙伴們整點炫酷樂子。 說到這LED彩燈,咱們常見到的有兩類: ...
  • 民爆生產廠區有地面站和民爆車,現場地面站的控制系統為西門子PLC和歐姆龍PLC,民爆車為三菱PLC,地面站通過光纖與本地機房進行數據交互,民爆車的位置及其他數據通過4G與本地機房進行數據交互。本地機房與北京運維中心進行數據交互,實現民爆行業的綜合運維平臺。 ...
  • 一、前言 在項目開發過程中,DataGrid是經常使用到的一個數據展示控制項,而通常表格的最後一列是作為操作列存在,比如會有編輯、刪除等功能按鈕。但WPF的原始DataGrid中,預設只支持固定左側列,這跟大家習慣性操作列放最後不符,今天就來介紹一種簡單的方式實現固定右側列。(這裡的實現方式參考的大佬 ...
  • 前言 .NET生態中有許多依賴註入容器。在大多數情況下,微軟提供的內置容器在易用性和性能方面都非常優秀。外加ASP.NET Core預設使用內置容器,使用很方便。 但是筆者在使用中一直有一個頭疼的問題:服務工廠無法提供請求的服務類型相關的信息。這在一般情況下並沒有影響,但是內置容器支持註冊開放泛型服 ...
  • 一:背景 1. 講故事 上個月有個朋友在微信上找到我,說他們的軟體在客戶那邊隔幾天就要崩潰一次,一直都沒有找到原因,讓我幫忙看下怎麼回事,確實工控類的軟體環境複雜難搞,朋友手上有一個崩潰的dump,剛好丟給我來分析一下。 二:WinDbg分析 1. 程式為什麼會崩潰 windbg 有一個厲害之處在於 ...
  • 如果你在自定義的 Main 方法中直接使用 App 類並啟動應用程式,但發現 App.xaml 中定義的資源沒有被正確載入,那麼問題可能在於如何正確配置 App.xaml 與你的 App 類的交互。 確保 App.xaml 文件中的 x:Class 屬性正確指向你的 App 類。這樣,當你創建 Ap ...
  • 一、前言 在自己的項目中,涉及到實時心率曲線的繪製,項目上的曲線繪製,一般很難找到能直接用的第三方庫,而且有些還是定製化的功能,所以還是自己繪製比較方便。很多人一聽到自己畫就害怕,感覺很難,今天就分享一個完整的實時心率數據繪製心率曲線圖的例子;之前的博客也分享給DrawingVisual繪製曲線的方 ...
一周排行
    -Advertisement-
    Play Games
  • 不廢話,直接代碼 private Stack<Action> actionStack = new Stack<Action>(); private void SetCellValues() { var worksheet = Globals.ThisAddIn.Application.ActiveS ...
  • OpenAPI 規範是用於描述 HTTP API 的標準。該標準允許開發人員定義 API 的形狀,這些 API 可以插入到客戶端生成器、伺服器生成器、測試工具、文檔等中。儘管該標準具有普遍性和普遍性,但 ASP.NET Core 在框架內預設不提供對 OpenAPI 的支持。 當前 ASP.NET ...
  • @DateTimeFormat 和 @JsonFormat 是 Spring 和 Jackson 中用於處理日期時間格式的註解,它們有不同的作用: @DateTimeFormat @DateTimeFormat 是 Spring 框架提供的註解,用於指定字元串如何轉換為日期時間類型,以及如何格式化日 ...
  • 一、背景說明 1.1 效果演示 用python開發的爬蟲採集軟體,可自動抓取抖音評論數據,並且含二級評論! 為什麼有了源碼還開發界面軟體呢?方便不懂編程代碼的小白用戶使用,無需安裝python、無需懂代碼,雙擊打開即用! 軟體界面截圖: 爬取結果截圖: 以上。 1.2 演示視頻 軟體運行演示視頻:見 ...
  • SpringBoot筆記 SpringBoot文檔 官網: https://spring.io/projects/spring-boot 學習文檔: https://docs.spring.io/spring-boot/docs/current/reference/html/ 線上API: http ...
  • 作為後端工程師,多數情況都是給別人提供介面,寫的好不好使你得重視起來。 最近我手頭一些活,需要和外部公司對接,我們需要提供一個介面文檔,這樣可以節省雙方時間、也可以防止後續扯皮。這是就要考驗我的介面是否規範化。 1. 介面名稱清晰、明確 顧名思義,介面是做什麼的,是否準確、清晰?讓使用這一眼就能知道 ...
  • 本文介紹基於Python語言,遍歷文件夾並從中找到文件名稱符合我們需求的多個.txt格式文本文件,並從上述每一個文本文件中,找到我們需要的指定數據,最後得到所有文本文件中我們需要的數據的合集的方法~ ...
  • Java JUC&多線程 基礎完整版 目錄Java JUC&多線程 基礎完整版1、 多線程的第一種啟動方式之繼承Thread類2、多線程的第二種啟動方式之實現Runnable介面3、多線程的第三種實現方式之實現Callable介面4、多線的常用成員方法5、線程的優先順序6、守護線程7、線程的讓出8、線 ...
  • 實時識別關鍵詞是一種能夠將搜索結果提升至新的高度的API介面。它可以幫助我們更有效地分析文本,並提取出關鍵詞,以便進行進一步的處理和分析。 該介面是挖數據平臺提供的,有三種模式:精確模式、全模式和搜索引擎模式。不同的模式在分詞的方式上有所不同,適用於不同的場景。 首先是精確模式。這種模式會儘量將句子 ...
  • 1 為啥要折騰搭建一個專屬圖床? 技術大佬寫博客都用 md 格式,要在多平臺發佈,圖片就得有外鏈 後續如博客遷移,國內博客網站如掘金,簡書,語雀等都做了防盜鏈,圖片無法遷移 2 為啥選擇CloudFlare R2 跳轉:https://dash.cloudflare.com/ 有白嫖額度 免費 CD ...