3-1.ASP.NET Core Web API 入門教學 - Entity Framework Core資料庫連線,使用Database First

ASP.NET Core Web API 入門教學

才剛開始就要教資料庫連線?會不會太進階?

很多教學上,為避免太複雜,所以在一開始都會用"模擬資料"來模擬存取資料,但我覺得新手時期很容易混淆,新手分不清那些部分是你在做模擬,哪些是你實際上要教的,往往學到最後才恍然大悟,當初為什麼要寫一堆,原來那只是在模擬阿~~~

而接下來的教學基本上都會跟資料庫緊密溝通,所以我會先教如何連線資料庫,並直接使用實際的連線方式進行資料存取,讓新手能夠體驗實際真實環境的運作是怎麼樣,不用學完了之後還對真實環境一片模糊,或者又要另外學資料庫怎麼連線,又怎麼跟之前學的搭配起來,就好比前面有示範LINQ那節,就是模擬方式在做新增修改刪除查詢,如果整個教學都用這樣方式進行,相信最後新手要跟資料庫實際做結合時候,又要費不少苦心去研究,所以我覺得不如一開始就實際學搭配起來的樣子。

雖然一開始就連資料庫可能會有些小坡度,但依照著我的影片學下來,應該是不會有太大問題的XD。


那在Core這邊,會優先使用Entity Framework Core來進行資料庫的連線操作,而使用方式則有以下兩種:

  1. Database First:本課程的所使用的方法,先在SQL Server上(或其他資料庫)建立好資料庫與表格欄位,再到visual studio這邊下建立資料庫物件指令,則會在專案中產生相關對應的資料庫程式檔。
  2. Code First:直接在專案中,以程式的方式撰寫出所需的資料庫與表格欄位,然後再下相關指令,就會將你程式碼所寫的內容,逆向的到SQL Server上(或其他資料庫)建立好對應的資料庫與表格欄位。

那首先要使用Database First,需要先安裝以下二個套件:

  • Microsoft.EntityFrameworkCore.SqlServer
  • Microsoft.EntityFrameworkCore.Tools

到方案總管的相依性>管理NuGet套件

到上圖的導覽搜尋上面幾個套件然後進行安裝

到套件管理器主控台(檢視>其他視窗>套件管理器主控台)下以下指令

Scaffold-DbContext "Server=伺服器位置;Database=資料庫;User ID=帳號;Password=密碼;TrustServerCertificate=true" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models -Force

有四個地方要自行調整:

  1. 伺服器位置:打上你的ip位置。
  2. 資料庫:你的資料庫名稱。
  3. 帳號:就帳號。
  4. 密碼:就密碼。

其中-OutputDir Models指說要將相關檔案產生在這個資料夾底下,-Force則是如果此位置已有相同檔案時覆蓋,就算沒檔案也可以多這個參數。其他指令部分可以參考這裡:這裡

那我個人喜歡帶的參數如下

Scaffold-DbContext "Server=127.0.0.1;Database=Web;User ID=Web;Password=123456;TrustServerCertificate=true" Microsoft.EntityFrameworkCore.SqlServer -OutputDir Models -NoOnConfiguring -UseDatabaseNames -NoPluralize -Force

幾個參數解釋

TrustServerCertificate=true:信任伺服器憑證

-OutputDir Models:將檔案輸出到Models資料夾

-NoOnConfiguring:DbContext不要產生OnConfiguring片段,影片會大概解釋是什麼

-UseDatabaseNames:使用跟資料庫一樣的大小寫命名,不然可能大小寫會被改成別的風格

-NoPluralize:不要加複數s,不然會幫你在命名結尾上加上s

以下輸入完指令後,看到Build succeeded就是成功執行了

執行完後如下圖,且產生出Models資料夾與相關檔案。

接著我們將資料庫的連線字串寫在appsettings.json

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft.AspNetCore": "Warning"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "WebDatabase": "Server=127.0.0.1;Database=Web;User ID=Web;Password=123456;TrustServerCertificate=true"
  }
}

然後我們在Program.cs中加入資料庫物件的DI注入(這以後會講,這邊先這樣照做)。

builder.Services.AddDbContext<WebContext>(options =>
options.UseSqlServer(builder.Configuration.GetConnectionString("WebDatabase")));

其中Configuration.GetConnectionString("WebDatabase")可以從appsettings.json中抓出"WebDatabase:"後面的內容,這部分就是說,請把一些參數的東西寫在appsettings.json裡,然後再用Configuration.GetConnectionString去抓取,而不要直接把連線字串寫死在程式裡,在日後維護或安全的考量上會較為良好。

那日後如果在SQL Server上有資料表行進新增或更新時,只要在重下一次Scaffold-DbContext指令即可。那其中要特別注意的是,在下Scaffold-DbContext指令時,程式不能存有任何編譯上的錯誤,否則將會失敗,如圖。

以上就是資料庫連線的前置作業,接著我們就要來實際測試剛剛的設定到底有沒有成功。

首先先建立一個新的NewsController.cs

namespace WebAPI.Controllers
{
    [Route("api/[controller]")]
    [ApiController]
    public class NewsController : ControllerBase
    {
        private readonly WebContext _webContext;   //先在全域宣告資料庫物件

        public NewsController(WebContext webContext)  //這邊是依賴注入使用我們剛設定好的資料庫物件的寫法
        {
            _webContext = webContext;
        }
    }
}

如果之前有寫過C#跟資料庫連線但沒用過依賴注入的人,可能會覺得很特殊,以前使用宣告資料庫可能會是這樣寫的

using (var _webContext = new WebContext())
{

}

但這要自己管理好生命週期,且更有新手可能連using都不會用,因而時不時有人就踩坑讓系統爆炸

現在用的這種叫依賴注入的寫法,由程式自動幫你管理好生命週期,你儘管用不需要擔心會採什麼坑

所以既然都來到的.NET Core時代,就改用依賴注入的寫法吧

為什麼我特別這麼說,因為發現還是很多人都轉來.NET Core了,還是放不下以前的寫法,其實這並沒有很難

最後我們在Get這邊簡單寫一下回傳News資料表的資料,如下


[HttpGet]
public IEnumerable<News> Get()
{
    return _webContext.News;
}

最後按下啟動不偵錯,看看我們上一節建立的三筆資料有沒有成功被撈出來。

上圖資料都撈出來了,就代表我們這次的設定是沒有問題的

參考資料:

Visual Studio 中的 Entity Framework Core 工具參考-封裝管理員主控台
連接字串
Install Entity Framework Core
Creating a Model for an Existing Database in Entity Framework Core




Copyright © 凱哥寫程式 2022 | Powered by TalllKai ❤