Asp.Net Core 輕鬆學-10分鐘使用EFCore鏈接MSSQL數據庫

前言

    在 .Net Core 2.2中 Microsoft.AspNetCore.App 默認內置了EntityFramework Core 包,因此在使用過程當中,咱們無需再從 NuGet 倉庫單獨應用 EFCore 包;本文並不打算深刻的介紹 EFCore 的各類使用方式、原理解析,本文重點在於解決讓初學者在10分鐘內快速使用上 EFCore 的問題。git

1. Code First 方式

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

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 字段爲主鍵標識web

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

DbContext 內置了不少個構造函數,這裏使用配置選項的方式,實現方式也很是簡單,最終,在 ForumContext 類中定義上面的實體業務模型集合便可sql

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 在項目的包管理器控制檯中使用命令根據實體業務模型建立數據庫

如今,打開項目中的包管理器控制檯express

  • 在控制檯中輸入如下兩組命令
Add-Migration Forum_v1
Update-Database

在輸入命令 Add-Migration Forum_v1 後,回車,控制檯輸出 To undo this action, use Remove-Migration. 表示命令執行成功;同時能夠看到,在項目中多了一個文件夾 Migrations;
注意:此時,數據庫 Forum 並無被建立json

在 Migrations 文件夾中;當執行 Update-Database 命令後,EFCore 設計工具將根據 Migrations 中的定義去建立數據庫,最終,控制檯輸出 Done 表示建立完成api

  • 查看數據庫

從上圖中能夠看到,數據庫建立成功,同時,Forum 數據庫中還多了一個表 __EFMigrationsHistory ,該表存儲的正是咱們項目中的 Migrations 的內容,只有兩個字段,對應 20190109031435_Forum_v1.cs 和 當前使用的 EFCore 版本號
若是後續有增長實體,只須要再次執行 Add-Migration 命令便可
若是但願得到幫助,還可在包管理器控制檯執行命令 get-help Add-Migrationapp

1.6 在項目中執行 CURD 操做

至此,數據庫建立完成,爲了在控制器中使用 ForumContext 對象,咱們在 HomeController 中使用依賴注入的方式得到 FormContext 對象,以備後續使用asp.net

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

相關文章
相關標籤/搜索