注意
這不是這篇文章的最新版本。 關於目前版本,請參閱本文的 .NET 11 版本。
警告
不再支援此版本的 ASP.NET Core。 如需詳細資訊,請參閱 .NET 和 .NET Core 支持原則。 關於目前版本,請參閱 本文的 .NET 10 版本。
本文說明如何在伺服器端 應用程式中使用 Entity Framework Core ()。
伺服器端 Blazor 是一種具狀態的應用程式架構。 應用程式會與伺服器維持持續連線,且使用者的狀態會以circuit形式保留在伺服器記憶體中。 使用者狀態的其中一個範例,是在電路範圍內的相依性注入 (DI) 服務執行個體中保存的資料。 Blazor 提供的唯一應用程式模型需要使用 Entity Framework Core 時所需的特殊方法。
注意
本文說明伺服器端 Blazor 應用程式中的 EF Core。 Blazor WebAssembly 應用程式運行於 WebAssembly 沙盒中,使應用程式無法進行大多數直接資料庫連線。 在 Blazor WebAssembly 中執行 EF Core 超出本文的範圍。
本指南適用於在 Blazor Web App 中採用互動式伺服器端轉譯 (互動式 SSR) 的元件。
本指導適用於託管的 Blazor WebAssembly 解決方案或 Blazor Server 應用程式的 Server 專案。
生產應用程式所需的安全驗證流程
本文與使用不需要使用者驗證的本機資料庫有關。 正式環境應用程式應該使用可用的最安全驗證流程。 如需已部署測試和生產 Blazor 應用程式驗證的詳細資訊,請參閱 Blazor安全性和 Identity 節點中的文章。
針對 Microsoft Azure 服務,我們建議使用 受控識別身分。 受控身分識別可以安全地向 Azure 服務進行驗證,而無需在應用程式程式碼中儲存認證。 如需詳細資訊,請參閱以下資源:
- 什麼是 Azure 資源受控識別? (Microsoft Entra 文件集)
- Azure 服務說明文件
建置 Blazor 電影資料庫應用程式教學課程
如需建置使用資料庫作業 EF Core 之應用程式的教學課程體驗,請參閱 建置 Blazor 電影資料庫應用程式 (概觀)。 本教學課程說明如何建立 Blazor Web App ,以在電影資料庫中顯示和管理電影。
資料庫存取
EF Core 依賴 DbContext 來設定資料庫存取,並作為 工作單元。 EF Core提供 ASP.NET Core 應用程式適用的 AddDbContext 擴充功能,將內容註冊為範圍服務。 在伺服器端 Blazor 應用程式中,範圍限定服務註冊可能會造成問題,因為執行個體會在使用者迴路內的元件之間共用。 DbContext 不是執行緒安全的,也不是為並行使用而設計的。 現有的存留期不合適,原因如下:
- Singleton 會讓所有應用程式使用者共享狀態,導致不適當的同時使用。
- 預設範圍(Scoped)在同一使用者的元件間也會帶來類似問題。
- 瞬態 則會產生每個請求的新實例;但由於元件壽命可能很長,這導致情境的壽命比預期更長。
下列建議旨在提供在伺服器端 Blazor 應用程式中使用 EF Core 的一致方法。
請考慮針對每個作業使用一個 context。 上下文是專為快速、低負荷實例化而設計:
using var context = new ProductsDatabaseContext(); return await context.Products.ToListAsync();使用旗標來防止多個同時作業:
if (Loading) { return; } try { Loading = true; ... } finally { Loading = false; }將資料庫作業放在
Loading = true;區塊的try行之後。執行緒安全性不是問題,因此載入邏輯不需要鎖定資料庫記錄。 載入邏輯是用來停用 UI 控制項,讓使用者在擷取資料時不會意外選取按鈕或更新欄位。
如果有任何可能讓多個執行緒存取相同的程式碼區塊,注入工廠,並為每個作業建立新的執行個體。 否則,插入和使用上下文通常就已足夠。
針對利用 EF Core 的變更追蹤或並行控制的較長存留期作業,請將 context 的範圍界定為元件的存留期。
新的 DbContext 執行個體
建立新 DbContext 執行個體的最快方式是使用 new 來建立新的執行個體。 不過,在某些情況下,需要解決其他相依性:
- 使用
DbContextOptions來設定內容脈絡。 - 針對每個 DbContext 使用連接字串,例如當您使用 ASP.NET Core 的 Identity 模型 時。 如需詳細資訊,請參閱 多租用(EF Core 文件)。
警告
請勿在用戶端程式代碼中儲存應用程式祕密、連接字串、認證、密碼、個人識別碼(PIN)、私人 C#/.NET 程式代碼或私鑰/令牌,這是一律不安全的。 在測試/預備環境和生產環境中,伺服器端 Blazor 程式碼和 Web API 應該使用安全的驗證流程,以避免將認證憑證存放於專案程式碼或組態檔中。 在本機開發測試之外,建議您避免使用環境變數來儲存敏感數據,因為環境變數不是最安全的方法。 針對本機開發測試,建議使用 Secret Manager tool 來保護敏感資料。 如需詳細資訊,請參閱 安全地維護敏感數據和憑證。
使用相依性建立新 DbContext 的建議方法是使用工廠。 EF Core在 .NET 5 或更新版本中,提供了內建的工廠來建立新的上下文。
在 .NET 5 之前的 .NET 版本中,請使用以下 DbContextFactory:
using System;
using Microsoft.EntityFrameworkCore;
using Microsoft.Extensions.DependencyInjection;
namespace BlazorServerDbContextExample.Data
{
public class DbContextFactory<TContext>
: IDbContextFactory<TContext> where TContext : DbContext
{
private readonly IServiceProvider provider;
public DbContextFactory(IServiceProvider provider)
{
this.provider = provider ?? throw new ArgumentNullException(
$"{nameof(provider)}: You must configure an instance of " +
"IServiceProvider");
}
public TContext CreateDbContext() =>
ActivatorUtilities.CreateInstance<TContext>(provider);
}
}
在上述工廠中:
- ActivatorUtilities.CreateInstance 透過服務提供者滿足任何相依關係。
- IDbContextFactory<TContext>在 .NET 5 或更新版本中可用EF Core,因此上述介面僅需用於 ASP.NET Core 3.x。
下列範例會設定 SQLite,並在管理聯繫人的應用程式中啟用數據記錄。 程式碼會使用擴充方法 (AddDbContextFactory) 來設定適用於 DI 的資料庫工廠,並提供預設選項:
builder.Services.AddDbContextFactory<ContactContext>(opt =>
opt.UseSqlite($"Data Source={nameof(ContactContext.ContactsDb)}.db"));
services.AddDbContextFactory<ContactContext>(opt =>
opt.UseSqlite($"Data Source={nameof(ContactContext.ContactsDb)}.db"));
Factory 會插入元件,以建立新的 DbContext 實例。
將資料庫上下文限制到元件方法
Factory 會插入元件:
@inject IDbContextFactory<ContactContext> DbFactory
使用工廠(DbContext)為方法創建 DbFactory:
private async Task DeleteContactAsync()
{
using var context = DbFactory.CreateDbContext();
if (context.Contacts is not null)
{
var contact = await context.Contacts.FirstAsync(...);
if (contact is not null)
{
context.Contacts?.Remove(contact);
await context.SaveChangesAsync();
}
}
}
將資料庫內容的範圍設定為元件的存留期
您可能想要建立一個在元件生命週期內存在的 DbContext。 這可讓您將其作為工作單位,並利用內建功能,例如變更追蹤和並行衝突解決。
實作 IDisposable 並將處理站插入元件:
@implements IDisposable
@inject IDbContextFactory<ContactContext> DbFactory
建立 DbContext的屬性:
private ContactContext? Context { get; set; }
OnInitializedAsync被覆寫以產生DbContext:
protected override async Task OnInitializedAsync()
{
Context = DbFactory.CreateDbContext();
}
當元件被處置時,也會處置 DbContext。
public void Dispose() => Context?.Dispose();
啟用敏感資料記錄
EnableSensitiveDataLogging 包含應用程式資料於例外訊息與框架日誌中。 記錄的資料可以包含指派給實體執行個體屬性的值,以及傳送至資料庫的命令的參數值。 使用 EnableSensitiveDataLogging 記錄資料是安全性風險,因為可能會在記錄對資料庫執行的 SQL 陳述式時,暴露密碼和其他個人識別資訊 (PII)。
我們建議僅針對本機開發和測試啟用 EnableSensitiveDataLogging:
if (builder.Environment.IsDevelopment())
{
services.AddDbContextFactory<ContactContext>(opt =>
opt.UseSqlite($"Data Source={nameof(ContactContext.ContactsDb)}.db")
.EnableSensitiveDataLogging());
}
else
{
services.AddDbContextFactory<ContactContext>(opt =>
opt.UseSqlite($"Data Source={nameof(ContactContext.ContactsDb)}.db"));
}