EFCore 的 DbFirst 模式

蘆薈柚子茶發表於2022-04-20
模式

1 前言

EF6 時代，可以通過介面操作，新增資料庫實體。

EF Core 需要通過 CLI 來進行該操作，具體請參考EF Core官方文件：反向工程。


2 前置條件


3 主命令

dotnet ef dbcontext scaffold "[資料庫連線串]" [提供程式]

如：

dotnet ef dbcontext scaffold "server=localhost;database=efcore;uid=sa;pwd=Qwe123456;" Microsoft.EntityFrameworkCore.SqlServer

4 命令引數

4.1 生成指定表（--table）

上述命令，會生成整個資料庫的表，如果需要指定特定的表，需要使用如下：

dotnet ef dbcontext scaffold "[資料庫連線串]" [提供程式] --table table_name1 --table table_name2

4.2 保留資料庫名稱（--use-database-names）

預設情況會修正表/列名，使用該引數儘量保留原名稱。

-UseDatabaseNames    #PMC
--use-database-names #.NET Core CLI

4.3 Fluent API 和資料註釋（--data-annotations）

預設情況下，使用 Fluent API 配置實體型別。使用下面的命令，可以改為使用資料註釋。

-DataAnnotations   #PMC
--data-annotations #.NET Core CLI

Fluent API

entity.Property(e => e.Title)
    .IsRequired()
    .HasMaxLength(160);

資料註釋

[Required]
[StringLength(160)]
public string Title { get; set; }

4.4 指定 DbContext 名稱（--context）

指定將生成的 DbContext 類的名稱

-Context  #PMC
--context #.NET Core CLI

4.5 指定儲存目錄（--context-dir 和 --output-dir）

-ContextDir Data -OutputDir Models     #PMC
--context-dir Data --output-dir Models #.NET Core CLI

4.6 指定名稱空間（--namespace 和 --context-namespace）

-Namespace Your.Namespace -ContextNamespace Your.DbContext.Namespace    #PMC
--namespace Your.Namespace --context-namespace Your.DbContext.Namespace #.NET Core CLI

5 測試

5.1 資料庫準備

由於是 DbFirst，所以這裡我們先建立一個資料庫，名為 efcore

新建一張表 Test

CREATE TABLE [dbo].[Test](
	[Id] [uniqueidentifier] NOT NULL,
	[Name] [nvarchar](128) NULL,
 CONSTRAINT [PK_Test] PRIMARY KEY CLUSTERED 
(
	[Id] ASC
)WITH (PAD_INDEX = OFF, STATISTICS_NORECOMPUTE = OFF, IGNORE_DUP_KEY = OFF, ALLOW_ROW_LOCKS = ON, ALLOW_PAGE_LOCKS = ON) ON [PRIMARY]
) ON [PRIMARY]

5.2 新建一個控制檯程式

這裡命名為：DbFirstTest

mkdir DbFirstTest & cd DbFirstTest #新建資料夾DbFirstTest並切換至該目錄下
dotnet new console -f net6.0       #新建.NET6.0控制檯程式

5.3 引入 Nuget 包

# 引入 EF Core 核心包
dotnet add package Microsoft.EntityFrameworkCore.Design -v 6.0.4
# 引入 SQL Server 提供程式
dotnet add package Microsoft.EntityFrameworkCore.SqlServer -v 6.0.4

5.4 執行 Scaffold 命令

在控制檯程式的根目錄下，執行命令（連線串請自行修改成自己的）：

dotnet ef dbcontext scaffold "server=localhost;database=efcore;uid=sa;pwd=Qwe123456;" Microsoft.EntityFrameworkCore.SqlServer --data-annotations --context EfCoreContext --context-dir Data --output-dir Models

--data-annotations：資料註釋在實體上

--context EfCoreContext：上下文指定命名為 EfCoreContext

--context-dir Data：上下文儲存在根目錄的 Data 資料夾下

--output-dir Models：實體儲存在根目錄的 Models 資料夾下

5.5 測試原始碼

在 Program.cs 新增測試程式碼：

using DbFirstTest.Data;
using DbFirstTest.Models;

EfCoreContext db = new EfCoreContext();
Test test = new Test()
{
    Id = Guid.NewGuid(),
    Name = "Add"
};
db.Tests.Add(test);
db.SaveChanges();
Console.WriteLine("Add Successful！");

在專案根目錄下，執行：

dotnet build #編譯
dotnet run   #執行

執行以後，可以看到，資料庫中新增了相應的記錄。

5.6 原始碼

Gitee：https://gitee.com/lisheng741/testnetcore/tree/master/EFCore/DbFirstTest

Github：https://github.com/lisheng741/testnetcore/tree/master/EFCore/DbFirstTest


參考來源

EF Core官方文件：反向工程

相關文章