实体框架

对应的官方页面地址

实体框架 (EF) 支持仍处于测试阶段，不适合生产型数据库。

本页面指的是建立一个 Bitwarden 实例来进行开发，如需了解如何测试个人使用的 EF 部署（例如 Bitwarden Unified），请参阅帮助文档。

背景

实体框架 (EF) 是一个 ORM 框架，充当数据库的包装器。它允许我们支持多个（非 MSSQL）数据库，而无需为每个数据库维护迁移和查询脚本。

我们的 EF 实现目前支持 Postgres 和 MySQL。

设置 EF 数据库

这里的工作流程与普通的 MSSQL 实现大致相同：设置 docker 容器、配置用户机密，并按时间顺序针对相关数据库运行脚本文件夹中的脚本。

要求

• 一个正常运行的本地开发服务器

• Docker

• 一种在服务器项目中管理用户机密的方法 - 请参阅用户机密参考

• 数据库管理软件（参阅工具推荐）

• dotnet cli

• dotnet cli 实体框架核心工具

您可以配置多个数据库，并通过改变 globalSettings:databaseProvider 用户机密的值以在它们之间切换。您不需要删除您的连接字符串。

数据库设置

PostgreSQL

在您的服务器存储库的 dev 文件夹中，运行：

docker compose --profile postgres up

MySQL

在您的服务器存储库的 dev 文件夹中，运行：

docker compose --profile mysql up

SQLite

选择数据库文件的位置。您可以使用服务器存储库的 dev 文件夹，为此目的，git 配置为忽略此存储库中的 .db 文件。

用户机密

将以下值添加到您的 API、身份和管理员用户机密中。

PostgreSQL

请务必根据需要更改 root 密码等信息。如果您已经拥有这些机密，请确保更新现有的值，而不是创建一个新的值：

"globalSettings:databaseProvider": "postgres",
"globalSettings:postgreSql:connectionString": "Host=localhost;Username=postgres;Password=example;Database=vault_dev;Include Error Detail=true",

MySQL

请务必根据需要更改 root 密码等信息。如果您已经拥有这些机密，请确保更新现有的值，而不是创建一个新的值：

"globalSettings:databaseProvider": "mysql",
"globalSettings:mySql:connectionString": "server=localhost;uid=root;pwd=example;database=vault_dev",

SQLite

将以下值添加到您的 API、身份和管理员用户机密中。注意，您必须设置数据源路径。使用在数据库设置中选择的文件位置：

"globalSettings:databaseProvider": "sqlite",
"globalSettings:sqlite:connectionString": "Data Source=/path/to/your/server/repo/dev/db/bitwarden.db",

迁移

PostgreSQL

在 dev 文件夹中运行以下命令将数据库更新到最新的迁移：

pwsh migrate.ps1 -postgres

migrate.ps1 中的 -postgres 标志将用于运行 dotnet ef 命令以执行迁移。

您还可以使用以下命令同时为所有数据库提供程序运行迁移：

pwsh migrate.ps1 -all

MySQL

在 dev 文件夹中运行以下命令将数据库更新到最新的迁移：

pwsh migrate.ps1 -mysql

migrate.ps1 中的 -mysql 标志将用于运行 dotnet ef 命令以执行迁移。

您还可以使用以下命令同时为所有数据库提供程序运行迁移：

pwsh migrate.ps1 -all

SQLite

在 dev 文件夹中运行以下命令将数据库更新到最新的迁移：

pwsh migrate.ps1 -sqlite

migrate.ps1 中的 -sqlite 标志将用于运行 dotnet ef 命令以执行迁移。

您还可以使用以下命令同时为所有数据库提供程序运行迁移：

pwsh migrate.ps1 -all

验证（可选）

如果您想验证一切工作是否正常：

• 检查数据库表以确保所有内容均已创建

• 使用 dotnet test 从您的服务器项目的根部运行集成测试。注意：这需要一个已配置好的 MSSQL 数据库。您可能还需要设置其他 EF 提供程序才能通过测试。

测试 EF 更改

由于我们允许使用多个数据库，因此对 EF 资源库/模型的任何更改都必须在所有可能的数据库中进行测试。您可能希望使用与本地开发数据库不同的数据库，因为测试可能会添加或删除数据。要将迁移应用到与全局设置不同的数据库，请从存储库的根目录运行以下命令：

# EntityFramework CLI 参考：https://learn.microsoft.com/en-us/ef/core/cli/dotnet

# 迁移 Postgres 数据库 ex 连接字符串：Host=localhost;Username=postgres;Password=SET_A_PASSWORD_HERE_123;Database=vault_dev_test
dotnet ef database update --startup-project util/PostgresMigrations --connection "[POSTGRES_CONNECTION_STRING]"

# 迁移 MySql 数据库 ex 连接字符串：server=localhost;uid=root;pwd=SET_A_PASSWORD_HERE_123;database=vault_dev_test
dotnet ef database update --startup-project util/MySqlMigrations --connection "[MYSQL_CONNECTION_STRING]"

cd test/Infrastructure.IntegrationTest

# https://learn.microsoft.com/en-us/aspnet/core/security/app-secrets?view=aspnetcore-6.0&tabs=windows#secret-manager
dotnet user-secrets set "Ef:Postgres" "[POSTGRES_CONNECTION_STRING]"
dotnet user-secrets set "Ef:MySql" "[MYSQL_CONNECTION_STRING]"

# 您还可以为正常开发的 MSSQL 数据库设置连接字符串，如下所示
dotnet user-secrets set "Dapper:SqlServer" "[MSSQL_CONNECTION_STRING]"

然后，您可以从 test/Infrastruct.IntegrationTest 文件夹中使用 dotnet test 运行这些测试。