EFCore 的 DbFirst 模式


1 前言

EF6 時代,可以通過界面操作,添加數據庫實體。

EF Core 需要通過 CLI 來進行該操作,具體請參考EF Core官方文檔:反向工程

當然,EF Core 也有界面化操作的工具,EF Core Power Tools,具體請見最后介紹。


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


6 EF Core Power Tools

開源的 EF Core 界面工具,可以作為一個 vs 的插件,在 vs 里運作。

項目 Github 地址:https://github.com/ErikEJ/EFCorePowerTools/

VS 插件下載:https://marketplace.visualstudio.com/items?itemName=ErikEJ.EFCorePowerTools

在 VS 插件市場下載以后,安裝即可。

本人的 vs 版本是 vs2022,安裝以后,右鍵項目多了一個選項【EF Core工具】,點擊【反向工程】即可進行 DbFirst 的相關操作了。

界面化操作比較直觀,這里不在贅述。

image


參考來源

EF Core官方文檔:反向工程


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM