1. 程式人生 > >Asp.Net Core 輕鬆學-10分鐘使用EFCore連線MSSQL資料庫

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://files.cnblogs.com/files/viter/Ron.MSSQL.zip