Asp.Net Core 輕松學-10分鍾使用EFCore連接MSSQL數據庫

前言

    在 .Net Core 2.2中 Microsoft.AspNetCore.App 默認內置了EntityFramework Core 包，所以在使用過程中，我們無需再從 NuGet 倉庫單獨應用 EFCore 包；本文並不打算深入的介紹 EFCore 的各種使用方式、原理解析，本文重點在於解決讓初學者在10分鍾內快速使用上 EFCore 的問題。

1. Code First 方式

EFCore 支持 Code First 方式，這個特性允許開發人員基於業務實體模型創建數據庫

1.1 首先創建一個 Asp.Net Core WebApi 項目 Ron.MSSQL，如下

1.2 創建業務實體模型文件夾 Models，添加兩個業務實體 Topic,Post

    public class Topic
    {
        public int Id { get; set; }
        public string Title { get; set; }
        public string Content { get; set; }
        public DateTime CreateTime { get; set; }
        public virtual ICollection<Post> Posts { get; set; }
    }

    public class Post
    {
        public int Id { get; set; }
        public int TopicId { get; set; }
        public string Content { get; set; }
        public DateTime CreateTime { get; set; }
        public virtual Topic Topic { get; set; }
    }

上面定義的兩個實體對象之間通過 Topic.Posts 和 Post.Topic 屬性建立了主外鍵關系，這兩個表的主鍵為 Id，且類型為 int ，這表示在下面的創建數據庫過程中，EFCore 會自動的為這兩個實體對象建立關系和主鍵，並會自動設置 Id 字段為主鍵標識

1.3 編寫數據庫上下文對象，該對象必須繼承自 DbContext

DbContext 內置了很多個構造函數，這里使用配置選項的方式，實現方式也非常簡單，最終，在 ForumContext 類中定義上面的實體業務模型集合即可

    public class ForumContext : DbContext
    {
        public ForumContext(DbContextOptions<ForumContext> options) : base(options)
        {

        }

        public DbSet<Topic> Topics { get; set; }
        public DbSet<Post> Posts { get; set; }
    }

1.4 在 appsettings.json 文件中配置數據庫連接字符串，這里使用的是本機安裝的 SQLExpress，指定數據庫名稱為：Forum

  "ConnectionStrings": {
    "Forum": "server=.\\SQLEXPRESS;uid=sa;pwd=123456;database=Forum;"
  }

1.5 在 Startup.cs 中配置連接字符串，注入上下文對象

        public void ConfigureServices(IServiceCollection services)
        {
            services.AddDbContext<ForumContext>(options =>
            {
                var connectionString = this.Configuration["ConnectionStrings:Forum"];
                options.UseSqlServer(connectionString);
            });

            ...
        }

上面的代碼使用 AddDbContext 方法，並配置了數據庫連接字符串為配置文件中的 "ConnectionStrings:Forum" 節點的值

1.5 在項目的包管理器控制台中使用命令根據實體業務模型創建數據庫

現在，打開項目中的包管理器控制台

• 在控制台中輸入以下兩組命令

Add-Migration Forum_v1
Update-Database

在輸入命令 Add-Migration Forum_v1 后，回車，控制台輸出 To undo this action, use Remove-Migration. 表示命令執行成功；同時可以看到，在項目中多了一個文件夾 Migrations；
注意：此時，數據庫 Forum 並沒有被創建

在 Migrations 文件夾中；當執行 Update-Database 命令后，EFCore 設計工具將根據 Migrations 中的定義去創建數據庫，最終，控制台輸出 Done 表示創建完成

• 查看數據庫

從上圖中可以看到，數據庫創建成功，同時，Forum 數據庫中還多了一個表 __EFMigrationsHistory ，該表存儲的正是我們項目中的 Migrations 的內容，只有兩個字段，對應 20190109031435_Forum_v1.cs 和 當前使用的 EFCore 版本號
如果后續有增加實體，只需要再次執行 Add-Migration 命令即可
如果希望獲得幫助，還可在包管理器控制台執行命令 get-help Add-Migration

1.6 在項目中執行 CURD 操作

至此，數據庫創建完成，為了在控制器中使用 ForumContext 對象，我們在 HomeController 中使用依賴注入的方式獲得 FormContext 對象，以備后續使用

        private ForumContext context;
        public HomeController(ForumContext context)
        {
            this.context = context;
        }

現在，嘗試着在項目中執行一些增刪改查的工作，插入一條 Topic 記錄，在 HomeController 中編寫以下代碼

    [Route("api/[controller]"), ApiController]
    public class HomeController : ControllerBase
    {
        private ForumContext context;
        public HomeController(ForumContext context)
        {
            this.context = context;
        }
        [HttpGet]
        public ActionResult<IEnumerable<Topic>> Get()
        {
            var topics = context.Topics.ToList();

            return topics;
        }

        [HttpPost]
        public void Post([FromBody] TopicViewModel model)
        {
            context.Topics.Add(new Topic()
            {
                Content = model.Content,
                CreateTime = DateTime.Now,
                Title = model.Title
            });
            context.SaveChanges();
        }

        [HttpPut]
        public void Put([FromBody] TopicViewModel model)
        {
            var topic = context.Topics.Where(f => f.Id == model.Id).FirstOrDefault();
            topic.Title = model.Title;
            topic.Content = model.Content;
            context.Topics.Update(topic);
            context.SaveChanges();
        }

        [HttpDelete("{id}")]
        public void Delete(int id)
        {
            var topic = context.Topics.Where(f => f.Id == id).FirstOrDefault();
            context.Topics.Remove(topic);
            context.SaveChanges();
        }
    }

上面的代碼定義了 Get/Post/Put/Delete 接口，這是一個標准的 Resetful API ，通過依次調用模擬對數據庫的 CURD 操作

2. DB First 的使用方式

在很多時候，我們的開發方式是先設計好數據庫模型，然后再生成實體對象，這種方式對於從其它語言遷移到 .Net Core 上非常友好，從現有數據庫中生成實體對象非常簡單，只需要一個命令即可，還是以上面創建好的數據庫 Forum 為例子

2.1 基於現有數據庫生成實體對象，在項目中的包管理器控制台輸入命令，指定使用的是 Microsoft.EntityFrameworkCore.SqlServer 驅動，生成的實體模型輸出到目錄 DbModels 中

Scaffold-DbContext "server=.\SQLEXPRESS;uid=sa;pwd=123456;database=Forum" Microsoft.EntityFrameworkCore.SqlServer -OutPutDir DbModels

2.2 執行結果

如果僅需要生成部分數據表，還可以通過將 -Tables 參數添加到上述命令來指定要為哪些表生成實體。 例如 -Tables Blog,Post。多個數據表以逗號分隔

2.3 項目中生成的實體對象文件夾

通過查看生成的代碼比較，和 Code First 方式基本相同，使用方式完全一致

3. 導航屬性

不管是 Code First 還是 DB First ，在實體對象中，我們都可以看到有個一個導航屬性，比如 Topic.Posts 和 Post.Topic ，該導航屬性定義了前綴 virtual 表示延遲加載此關聯對象，在 Code First 中，導航屬性還起到主外鍵關系定義的作用

結束語

• 本文介紹兩種使用 EF Core 的方式
• 通過一個簡單的 Forum 示例來一步一步的了解了 EFCore 的使用過程

示例代碼下載

https://github.com/lianggx/EasyAspNetCoreDemo/tree/master/Ron.MSSQL