如何在 Entity Framework Core 2 中播种？

Question

我有两张桌子，我想用种子填充它们。

我在 Ubuntu 中使用 ASP.NET Core 2。

如何填充通过外键连接到另一个表的两个表的数据？

流量计有很多注释，注释属于流量计。

我想做这样的事情，但它应该存储在数据库中：

new Flowmeter 
{
    Make = "Simple model name",
    SerialNum = 45, 
    Model = "Lor Avon", 
    Notes = new List<Note>()
    {
        new Note() { Value = 45, CheckedAt = System.DateTime.Now },
        new Note() { Value = 98, CheckedAt = System.DateTime.Now }
    }
}

Answer 1

从Entity Framework Core 2.1开始，现在有一种新的数据播种方法。 在您的DbContext类中覆盖OnModelCreating ：

protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder.Entity<Blog>().HasData(new Blog { BlogId = 1, Url = "http://sample.com" });
}

对于相关实体，使用匿名类并指定相关实体的外键：

modelBuilder.Entity<Post>().HasData(
    new {BlogId = 1, PostId = 1, Title = "First post", Content = "Test 1"},
    new {BlogId = 1, PostId = 2, Title = "Second post", Content = "Test 2"});

重要提示：请注意，在 OnModelCreating 方法和 Update-Database 中输入此数据后，您需要运行添加迁移以更新数据。

官方文档已更新。

Answer 2

这是我针对 EF Core 2.0 的解决方案，改编自https://learn.microsoft.com/en-us/aspnet/core/migration/1x-to-2x/#move-database-initialization-code

在程序.cs中

public class Program
{
    public static void Main(string[] args)
    {
        BuildWebHost(args).Seed().Run();
    }

....

然后是我的播种机课程

public static class DatabaseSeedInitializer
{
    public static IWebHost Seed(this IWebHost host)
    {
        using (var scope = host.Services.CreateScope())
        {
            var serviceProvider = scope.ServiceProvider;

            try
            {
                Task.Run(async () =>
                {
                    var dataseed = new DataInitializer();
                    await dataseed.InitializeDataAsync(serviceProvider);
                }).Wait();

            }
            catch (Exception ex)
            {
                var logger = serviceProvider.GetRequiredService<ILogger<Program>>();
                logger.LogError(ex, "An error occurred seeding the DB.");
            }
        }
        return host;
    }
}

Answer 3

tl;dr ：查看我的dwCheckApi 项目，看看我是如何实现它的。

正如其他人所说，您可以从 JSON 或类似文件中读取种子数据（如果需要，可以通过这种方式对其进行源控制）。

我在我的项目中实现它的方式是在 Startup 类的Configure方法中调用一个方法（仅在开发时）：

if (env.IsDevelopment())
{
  app.EnsureDatabaseIsSeeded(false);
}

它调用以下内容：

public static int EnsureDatabaseIsSeeded(this IApplicationBuilder applicationBuilder,
 bool autoMigrateDatabase)
{
    // seed the database using an extension method
    using (var serviceScope = applicationBuilder.ApplicationServices
   .GetRequiredService<IServiceScopeFactory>().CreateScope())
   {
       var context = serviceScope.ServiceProvider.GetService<DwContext>();
       if (autoMigrateDatabase)
       {
           context.Database.Migrate();
       }
       return context.EnsureSeedData();
   }
}

我的 DbContext 是DwContext类型，它是一个扩展 EF Core DbContext类型的类

EnsureSeedData扩展方法如下所示：

public static int EnsureSeedData(this DwContext context)
{
    var bookCount = default(int);
    var characterCount = default(int);
    var bookSeriesCount = default(int);

    // Because each of the following seed method needs to do a save
    // (the data they're importing is relational), we need to call
    // SaveAsync within each method.
    // So let's keep tabs on the counts as they come back

    var dbSeeder = new DatabaseSeeder(context);
    if (!context.Books.Any())
    {
        var pathToSeedData = Path.Combine(Directory.GetCurrentDirectory(), "SeedData", "BookSeedData.json");
        bookCount = dbSeeder.SeedBookEntitiesFromJson(pathToSeedData).Result;
    }
    if (!context.BookCharacters.Any())
    {
        characterCount = dbSeeder.SeedBookCharacterEntriesFromJson().Result;
    }
    if (!context.BookSeries.Any())
    {
        bookSeriesCount = dbSeeder.SeedBookSeriesEntriesFromJson().Result;
    }

    return bookCount + characterCount + bookSeriesCount;
}

此应用程序旨在显示书籍、角色和系列之间的关系。 这就是为什么有三个播种机。

其中一种播种器方法如下所示：

public async Task<int> SeedBookEntitiesFromJson(string filePath)
{
    if (string.IsNullOrWhiteSpace(filePath))
    {
        throw new ArgumentException($"Value of {filePath} must be supplied to {nameof(SeedBookEntitiesFromJson)}");
    }
    if (!File.Exists(filePath))
    {
        throw new ArgumentException($"The file { filePath} does not exist");
    }
    var dataSet = File.ReadAllText(filePath);
    var seedData = JsonConvert.DeserializeObject<List<Book>>(dataSet);

    // ensure that we only get the distinct books (based on their name)
    var distinctSeedData = seedData.GroupBy(b => b.BookName).Select(b => b.First());

    _context.Books.AddRange(distinctSeedData);
    return await _context.SaveChangesAsync();
}

这里可能有一些代码不是很好，但它可能是您重新开始的起点。

因为播种机仅在开发环境中调用，所以您需要确保您的应用程序以这种方式启动（如果从命令行启动，您可以使用ASPNETCORE_ENVIRONMENT=Development dotnet run来确保它在开发环境中启动）。

这也意味着您将需要一种不同的方法来在生产中播种数据库。 在 dwCheckApi 中，我有一个控制器，可以调用它来为数据库播种（查看DatabaseController 的 SeedData 方法以了解我是如何做到的）。

Answer 4

我不喜欢 Microsoft 文档中所写的 HasData 方法，因为我无法通过这种方式保持迁移干净，因为我的DbContext中的OnModelCreating()开始依赖感觉有点不对的数据，并导致随机数据生成器出现问题。

对我来说，最有效和舒适的方法是为我的每个 DbSet 创建一个种子类，如下所示。 （使用 Bogus 库就像呼吸一样简单）

using Bogus;

        // namespace, class, etc.


        // CategorySeeder seed method
        public int Seed(AppDbContext context)
        {


            var faker = new Faker<Category>()
                .RuleFor(r => r.IsGroup, () => true)
                .RuleFor(r => r.Parent, () => null)
                .RuleFor(r => r.UniversalTimeTicks, () => DateTime.Now.ToUniversalTime().Ticks)
                .RuleFor(r => r.Title, f => "Folder: " + f.Random.Word());

            var folders1 = faker.Generate(5);

            faker.RuleFor(r => r.Parent, () => folders1.OrderBy(r => Guid.NewGuid()).First());
            var folders2 = faker.Generate(10);
            var folders3 = folders1.Concat(folders2).ToArray();

            faker.RuleFor(r => r.Parent, () => folders3.OrderBy(r => Guid.NewGuid()).First());
            faker.RuleFor(r => r.Title, f => f.Random.Word());
            faker.RuleFor(r => r.IsGroup, () => false);

            var elements = faker.Generate(20);

            var allSeeds = elements.Concat(folders3).ToArray();

            context.AddRange(allSeeds);
            context.SaveChanges();
            return allSeeds.Length;
        }

        // ProductSeeder Seed method
        public int Seed(AppDbContext context)
        {
            var faker = new Faker<Product>()
                .RuleFor(r => r.Sku, f => f.Random.AlphaNumeric(8))
                .RuleFor(r => r.Title, f => f.Random.Word())
                .RuleFor(r => r.Category, () => context.Categories.Where(c => !c.IsGroup).OrderBy(o => Guid.NewGuid()).First());

            var prod = faker.Generate(50);
            context.AddRange(prod);
            context.SaveChanges();
            return prod.Count;
        }

然后创建仅在开发环境中工作的服务控制器。

    public class DataGeneratorController : BaseController
    {
        public DataGeneratorController(IServiceProvider sp) : base(sp) { }

        public IActionResult SeedData()
        {
            var lst = new List<string>();

            if (!_dbContext.Categories.Any())
            {
                var count = new CategoryConfiguration().Seed(_dbContext);
                lst.Add($"{count} Categories have been seeded.");
            }

            if (!_dbContext.Products.Any())
            {
                var count = new ProductConfiguration().Seed(_dbContext);
                lst.Add($"{count} Products have been seeded.");
            }

            if (lst.Count == 0)
            {
                lst.Add("Nothing has been seeded.");
            }

            return Json(lst);
        }
    }

并随时从 Insomnia\Postman 调用它。

Answer 5

创建种子数据静态类，如

 public static class SeedData
    {
        public static void Initialize(IServiceProvider serviceProvider)
        {
            var context = serviceProvider.GetRequiredService<YourDbContext>();
            context.Database.EnsureCreated();
            if (!context.Items.Any())
            {
                context.Items.Add(entity: new Item() { Name = "Green Thunder" });
                context.Items.Add(entity: new Item() { Name = "Berry Pomegranate" });
                context.Items.Add(entity: new Item() { Name = "Betty Crocker" });
                context.Items.Add(entity: new Item() { Name = "Pizza Crust Mix" });

                context.SaveChanges();
            }

            if (!context.Shoppings.Any()) {
                context.Shoppings.Add(entity:new Shopping() { Name="Defualt" });
            }
        }
    }

更新您的 program.cs 代码以插入您的种子数据，如下所示

 public class Program
    {
        public static void Main(string[] args)
        {

            //CreateWebHostBuilder(args).Build().Run();
            var host = CreateWebHostBuilder(args).Build();

            using (var scope = host.Services.CreateScope())
            {
                var services = scope.ServiceProvider;

                try
                {
                    var context = services.GetRequiredService<YourDbContext>();
                    context.Database.Migrate(); // apply all migrations
                    SeedData.Initialize(services); // Insert default data
                }
                catch (Exception ex)
                {
                    var logger = services.GetRequiredService<ILogger<Program>>();
                    logger.LogError(ex, "An error occurred seeding the DB.");
                }
            }

            host.Run();
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)
                .UseStartup<Startup>();
    }

Answer 6

如果有人仍然对此主题感兴趣，我们已经创建了一组工具（一个 .net 核心全局工具和一个库）来简化数据播种过程。

长话短说：您可以将当前数据库的内容保存到一些 JSON 或 XML 文件中，然后在您的应用程序中添加几行代码来加载这些文件并将保存在那里的数据导入您的数据库。 该工具集是完全免费和开源的。

详细的分步说明发布在这里。

Answer 7

我在 json 中创建了我的种子，然后将它们批量添加到我的 Asp.net 核心 Startup

非常类似于https://garywoodfine.com/how-to-seed-your-ef-core-database/

尚未找到开箱即用的解决方案。

Answer 8

我遇到了同样的问题，并通过以下方式修复了播种：

首先，我将 garywoodfine 中的public static bool AllMigrationsApplied(this DbContext context)添加到我的模型中。

然后我实现了一个服务范围来为数据库播种 -> 请参阅此博客

然后我创建了一个public static void EnsureSeedData ，其中包含使用 NBuilder 和 Faker 生成测试数据的代码，遵循本博客上的教程

我希望这将帮助人们为他们的项目实施自动化测试种子。 目前我正忙于自己实现这个，当我有时间时，我会发布一些代码示例来说明如何做到这一点。

Answer 9

我将 Entity Framework 3 与“内存数据库”上下文一起使用，并且能够通过执行以下操作来播种数据。

1. 在我的DbContext类中覆盖OnModelCreating 。 例如：

    public class NoteContext : DbContext
    {
        public DbSet<Note> Notes { get; set; }

        public NoteContext(DbContextOptions<NoteContext> options)
            : base(options)
        {
        }

        /// <summary>
        /// Seed data
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            modelBuilder.Entity<Note>().HasData(new[] {
                new Note { NoteId = Guid.NewGuid(), User = "UserA", Message = "Message from UserA" },
                new Note { NoteId = Guid.NewGuid(), User = "UserB", Message = "Message from UserB" }
            });
        }
    }

2. 在使用上下文之前调用context.Database.EnsureCreated() 。 例如：

    [Route("api/[controller]")]
    [ApiController]
    public class NotesController : ControllerBase
    {
        private readonly NoteContext _context;

        public NotesController(NoteContext context)
        {
            _context = context;

            // Seed data
            _context.Database.EnsureCreated();
        }
    ...