2-1.ASP.NET Core Web API 入門教學 - 資料庫連線設定 Database First,Scaffold-DbContext Build Failed解決方式 | 凱哥寫程式's Blog

本文章重新修改過，為Visual Studio 2022+.NET 8環境

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

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

而接下來的教學基本上都會跟資料庫緊密溝通，所以我會先教如何連線資料庫，並直接使用實際的連線方式進行資料存取。

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

Database First：本課程的所使用的方法，先在SQL Server上(或其他資料庫)建立好資料庫與表格欄位，再到visual studio這邊下建立資料庫物件指令，則會在專案中產生相關對應的資料庫程式檔。
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

有四個地方要自行調整：

伺服器位置：打上你的ip位置。
資料庫：你的資料庫名稱。
帳號：就帳號。
密碼：就密碼。

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

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

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

執行後會出現錯誤

.NET 8之前是不會有這個錯誤的，主要是預設被改變了，所以我們這邊要修改一下預設，以下選擇編輯專案檔

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>enable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <InvariantGlobalization>true</InvariantGlobalization>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
  </ItemGroup>

</Project>

將InvariantGlobalization改成false或整行拿掉(拿掉等同false)，就可以正常運作了

另外我Nullable也會改成disable或整行拿掉(拿掉等同disable)，後面的課程是NET5環境寫的

而NET5預設是disable，所以如果用的是net8這邊預設會是enable，就有可能會跟後面的課程顯示的結果有所差異，改完如下

<Project Sdk="Microsoft.NET.Sdk.Web">

  <PropertyGroup>
    <TargetFramework>net8.0</TargetFramework>
    <Nullable>disable</Nullable>
    <ImplicitUsings>enable</ImplicitUsings>
    <InvariantGlobalization>false</InvariantGlobalization>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.EntityFrameworkCore.SqlServer" Version="8.0.0" />
    <PackageReference Include="Microsoft.EntityFrameworkCore.Tools" Version="8.0.0">
      <PrivateAssets>all</PrivateAssets>
      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
    </PackageReference>
  </ItemGroup>

</Project>

這時候再輸入一次指令就可以成功完成了

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

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

{
  "Logging": {
    "LogLevel": {
      "Default": "Information",
      "Microsoft": "Warning",
      "Microsoft.Hosting.Lifetime": "Information"
    }
  },
  "AllowedHosts": "*",
  "ConnectionStrings": {
    "TodoDatabase": "Data Source=伺服器位置;Database=資料庫;User ID=帳號;Password=密碼;TrustServerCertificate=true"
  }
}

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

builder.Services.AddDbContext<TodoContext>(options =>
options.UseSqlServer(builder.Configuration.GetConnectionString("TodoDatabase")));

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

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

以上就是今天資料庫連線的前置作業教學。~~想要聽多一些廢話的可以看影片~~

新手分享學習成果，若有錯誤，煩請告知修正，感謝🙏

參考資料：

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