Entity?Framework?Core種子數(shù)據(jù)Data-Seeding

更新時間：2022年03月25日 10:09:28 作者：.NET開發(fā)菜鳥

這篇文章介紹了Entity?Framework?Core種子數(shù)據(jù)Data-Seeding的用法，文中通過示例代碼介紹的非常詳細。對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

一、什么是Data-Seeding

Data-Seeding是EntityFrameworkCore 2.1以上版本新增加的特性。在項目剛開始的時候，我們往往是需要初始化一些基礎(chǔ)數(shù)據(jù)到數(shù)據(jù)庫中，通過Data-Seeding特性就可以實現(xiàn)這一功能。本篇文章我們將講解如何進行數(shù)據(jù)初始化。

二、初始化方法

具體的數(shù)據(jù)初始化方法分為如下三種：

模型中配置。這種是通過調(diào)用HasData()方法。
手動遷移時添加。
自定義初始化邏輯。

下面我們分別來講解如何使用這三種方式進行數(shù)據(jù)遷移。

1、模型中配置

這種方式是通過調(diào)用HasData()方法實現(xiàn)的。這種也是我在項目開發(fā)過程中，經(jīng)常使用的。這種方式是在數(shù)據(jù)上下文類中重寫OnModelCreating()方法，我們先看HasData()方法的定義：

可以看到，方法的參數(shù)可以是Blog類型的數(shù)組，具體代碼如下：

using EFCore.Model;
using Microsoft.EntityFrameworkCore;

namespace EFCore.Data
{
    /// <summary>
    /// 數(shù)據(jù)上下文
    /// </summary>
    public class EFDbContext:DbContext
    {
        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Data Source=.;Initial Catalog=EFTest;User ID=sa;Password=123456;");
        }

        public DbSet<Blog> Blogs { get; set; }


        /// <summary>
        /// 重寫OnModelCreating方法
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            // 針對Blog實體添加種子數(shù)據(jù)
            modelBuilder.Entity<Blog>().HasData(
                new Blog()
                {
                    // Id字段要賦值，否則會報錯
                    Id=1,
                    Name="ef core"
                },
                new Blog()
                {
                    Id=2,
                    Name="ASP.NET Core"
                },
                new Blog()
                {
                    Id=3,
                    Name="圖解數(shù)據(jù)結(jié)構(gòu)"
                }
                );
            base.OnModelCreating(modelBuilder);
        }
    }
}

我們注意到：默認情況下會自動設(shè)置Id列為主鍵，并且是自動增長的。但是這里要設(shè)置Id的值，即使Id是自動生成的主鍵，否則會報下圖所示的錯誤：

添加完種子數(shù)據(jù)以后，我們運行程序，查看輸出結(jié)果：

查看數(shù)據(jù)庫：

這樣就生成了數(shù)據(jù)庫和表，而且表里面也有了初始化數(shù)據(jù)。

假如這時候我們想增加一條數(shù)據(jù)，代碼如下：

using EFCore.Model;
using Microsoft.EntityFrameworkCore;

namespace EFCore.Data
{
    /// <summary>
    /// 數(shù)據(jù)上下文
    /// </summary>
    public class EFDbContext:DbContext
    {
        protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        {
            optionsBuilder.UseSqlServer("Data Source=.;Initial Catalog=EFTest;User ID=sa;Password=123456;");
        }

        public DbSet<Blog> Blogs { get; set; }


        /// <summary>
        /// 重寫OnModelCreating方法
        /// </summary>
        /// <param name="modelBuilder"></param>
        protected override void OnModelCreating(ModelBuilder modelBuilder)
        {
            // 針對Blog實體添加種子數(shù)據(jù)
            modelBuilder.Entity<Blog>().HasData(
                new Blog()
                {
                    // Id字段要賦值，否則會報錯
                    Id=1,
                    Name="ef core"
                },
                new Blog()
                {
                    Id=2,
                    Name="ASP.NET Core"
                },
                new Blog()
                {
                    Id=3,
                    Name="圖解數(shù)據(jù)結(jié)構(gòu)"
                },
                // 新增加一條數(shù)據(jù)
                new Blog()
                {
                    Id=4,
                    Name="C#高級編程"
                }
                
                );
            base.OnModelCreating(modelBuilder);
        }
    }
}

這時候還能不能用剛才的方法呢？我們這時在運行程序，查看結(jié)果：

這時候程序執(zhí)行失敗了，而且表里面的數(shù)據(jù)也沒有增加。這說明context.Database.EnsureCreated()方法只有在第一次執(zhí)行的時候才會有效，以后數(shù)據(jù)進行更改后就無效了。那么有什么方式可以實現(xiàn)呢？這時只有通過命令行進行遷移或者通過context.Database.Migrate方法調(diào)用生成的遷移類才能對數(shù)據(jù)的更改有效。

我們把剛才生成的數(shù)據(jù)庫刪掉，新增加的那條數(shù)據(jù)注釋掉，然后使用命令行遷移的方式生成數(shù)據(jù)庫表，首先添加遷移：

然后更新數(shù)據(jù)庫：

更新完數(shù)據(jù)庫以后，我們在HasData()方法里面添加一條數(shù)據(jù)，然后再次執(zhí)行上面的添加遷移和更新數(shù)據(jù)庫的命令，發(fā)現(xiàn)這時候數(shù)據(jù)庫里面會添加新增加的數(shù)據(jù)。

在執(zhí)行完第二次添加遷移命令后，如果不使用更新數(shù)據(jù)庫命令，也可以通過代碼的方式進行遷移，這就是調(diào)用context.Database.Migrate命令，代碼如下：

using EFCore.Data;
using Microsoft.EntityFrameworkCore;
using System;

namespace EFCore.Con
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");

            EFDbContext dbContext = new EFDbContext();
            // 遷移
            dbContext.Database.Migrate();
            //bool tfTrue = dbContext.Database.EnsureCreated();
            //if(tfTrue)
            //{
            //    Console.WriteLine("數(shù)據(jù)庫創(chuàng)建成功!");
            //}
            //else
            //{
            //    Console.WriteLine("數(shù)據(jù)庫創(chuàng)建失敗!");
            //}

            Console.ReadKey();
        }
    }
}

這時會自動調(diào)用最新的遷移文件去更新數(shù)據(jù)庫。

注意：調(diào)用該方法對數(shù)據(jù)的更改只有在遷移時才能生效，也就是說只有通過命令進行遷移或者通過context.Database.Migrate方法調(diào)用生成的遷移類才能對數(shù)據(jù)更改有效。而調(diào)用context.Database.EnsureCreated()方法只有在第一次執(zhí)行的時候才有效，但數(shù)據(jù)進行更改后將無效。

這種方式有兩種限制：

必須指定主鍵的值（即使主鍵由數(shù)據(jù)庫自動生成也要指定值）。
添加的必須是靜態(tài)數(shù)據(jù)，沒有任何的依賴。比如添加的Id主鍵的值在其它表里面有引用就不可以。

2、手動遷移時添加

這種方式在這里不進行講解，有興趣的可以參考微軟的官方文檔。

3、自定義初始化邏輯

執(zhí)行數(shù)據(jù)種子設(shè)定的一種簡單而有效的方法是在主應(yīng)用程序邏輯開始執(zhí)行之前使用使用DbContext.SaveChanges()。代碼如下：

using EFCore.Data;
using EFCore.Model;
using Microsoft.EntityFrameworkCore;
using System;
using System.Linq;

namespace EFCore.Con
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");

            //EFDbContext dbContext = new EFDbContext();
            //// 遷移
            //dbContext.Database.Migrate();
            ////bool tfTrue = dbContext.Database.EnsureCreated();
            ////if(tfTrue)
            ////{
            ////    Console.WriteLine("數(shù)據(jù)庫創(chuàng)建成功!");
            ////}
            ////else
            ////{
            ////    Console.WriteLine("數(shù)據(jù)庫創(chuàng)建失敗!");
            ////}

            #region 使用自定義初始化邏輯
            using(EFDbContext context=new EFDbContext())
            {
                context.Database.EnsureCreated();

                var testBlog = context.Blogs.FirstOrDefault(p => p.Name == "C#");
                if(testBlog == null)
                {
                    // 添加數(shù)據(jù)
                    context.Blogs.Add(new Blog()
                    {
                        Name = "C#"
                    });
                }

                // 保存數(shù)據(jù)
                context.SaveChanges();
            }
            #endregion
            Console.ReadKey();
        }
    }
}

通過這種自定義邏輯的方式也可以添加種子數(shù)據(jù)。如果HasData()方法里面添加了種子數(shù)據(jù)，那么會先把HasData()方法里面的種子數(shù)據(jù)添加到數(shù)據(jù)庫中。如果沒有名稱為C#的數(shù)據(jù)，則還會在添加一條數(shù)據(jù)。

如果有了該數(shù)據(jù)，就不會再添加了。

注意：這種方式新增數(shù)據(jù)的時候就不能再給主鍵Id賦值了，因為是先生成數(shù)據(jù)庫，自動設(shè)置Id為主鍵，在添加數(shù)據(jù)的時候會自動賦值。

三、Data-Seeding本質(zhì)

當調(diào)用HasData()方法首次遷移時，實質(zhì)上是調(diào)用MigrationBuilder類中InsertData方法進行插入。
當調(diào)用HasData()方法更改數(shù)據(jù)（未更改主鍵）時，實質(zhì)上是調(diào)用MigrationBuilder類中UpdateData方法進行更新操作。
當調(diào)用HasData()方法移除數(shù)據(jù)或更改主鍵時，實質(zhì)上是調(diào)用MigrationBuilder類中DeleteData方法進行刪除操作或者刪除和更新操作。