你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
具有弹性数据库工具和行级安全性的多租户应用程序
适用于：
Azure SQL 数据库
弹性数据库工具和行级别安全性 (RLS) 一起使用时，可通过 Azure SQL 数据库缩放多租户应用程序的数据层。 将这些技术综合在一起，即可生成数据层高度可缩放的应用程序。 该数据层支持多租户分片，并使用 ADO.NET SqlClient 或实体框架。 有关详细信息，请参阅具有 Azure SQL 数据库的多租户 SaaS 应用程序的设计模式。
- 弹性数据库工具可让开发人员使用 .NET 库和 Azure 服务模板通过标准分片做法横向扩展数据层。 使用弹性数据库客户端库管理分片有助于自动化和简化通常与分片关联的许多基础结构任务。
- 行级安全性允许开发人员将多个租户的数据安全地存储在同一数据库中。 RLS 安全策略筛选掉不属于执行查询的租户的行。 将筛选逻辑集中在数据库中可简化维护过程，降低发生安全错误的风险。 替代方法是依赖所有客户端代码来强制实施安全措施，这是很危险的。
将这些功能一起使用，应用程序可以在同一个分片数据库中存储多个租户的数据。 当租户共享数据库时，每个租户的成本会降低。 不过，该应用程序也可为高级租户提供使用单租户分片专用付费版的选择。 单租户隔离的一大优势是更好的性能保证。 在单租户数据库中，没有其他租户来竞争资源。
这样做的目的是使用弹性数据库客户端库数据依赖路由 API，将每个指定的租户自动连接到正确的分片数据库。 只有一个分片包含适用于该指定租户的特定 TenantId 值。 TenantId 是分片键。 建立连接后，就会执行数据库中的 RLS 安全策略，确保指定租户只能访问那些包含其 TenantId 的数据行。
注意
租户标识符可能由多个列组成。 在本讨论中，为方便起见，我们采用单列 TenantId（非正式）。
下载示例项目
先决条件
- 使用 Visual Studio（2012 或更高版本）
- 在 Azure SQL 数据库中创建三个数据库
- 下载示例项目：Azure SQL 的弹性数据库工具 - 多租户分片
- 在 Program.cs 的开头填入数据库的信息
此项目通过添加对多租户分片数据库的支持，扩展了 Azure SQL 的弹性数据库工具 - 实体框架集成中所述的项目。 此项目生成一个简单的控制台应用程序，用于创建博客和文章。 此项目包括四个租户，以及两个多租户分片数据库。 上图说明了此配置。
生成并运行应用程序。 此运行会引导弹性数据库工具的分片映射管理器，并进行以下测试：
- 使用实体框架和 LINQ 创建新博客，并显示每个租户的所有博客文章
- 使用 ADO.NET SqlClient 显示租户的所有博客文章
- 尝试插入错误租户的博客，以验证是否会引发错误
请注意，由于 RLS 尚未在分片数据库中启用，其中的每个测试都会揭露一个问题：租户能够看到不属于他们的博客，并且系统不会阻止应用程序插入错误租户的博客。 本文的余下部分介绍如何通过使用 RLS 强制隔离租户来解决这些问题。 有两个步骤：
- 应用程序层：打开连接后，将应用程序代码修改为始终设置 SESSION_CONTEXT 中的当前 TenantId。 示例项目已通过这种方式设置 TenantId。
- 数据层：在每个分片数据库中创建一个 RLS 安全策略，以根据 SESSION_CONTEXT 中存储的 TenantId 筛选行。 针对每个分片数据库创建一个 策略，否则不会筛选多租户分片中的行。
1. 应用程序层：在 SESSION_CONTEXT 中设置 TenantId
首先，使用弹性数据库客户端库的数据依赖路由 API 连接到分片数据库。 应用程序仍需告知数据库，哪个 TenantId 在使用连接。 TenantId 告知 RLS 安全策略，必须筛选掉哪些属于其他租户的行。 将当前 TenantId 存储在连接的 SESSION_CONTEXT 中。
SESSION_CONTEXT 的替代选项是使用 CONTEXT_INFO。 不过，SESSION_CONTEXT 是较好的选择。 SESSION_CONTEXT 更易于使用，默认情况下返回 NULL，并支持键值对。
Entity Framework
对于使用实体框架的应用程序，最简单的方法是根据使用 EF DbContext 进行数据相关的路由中所述，在 ElasticScaleContext 重写中设置 SESSION_CONTEXT。 创建和执行 SqlCommand，将 SESSION_CONTEXT 中的 TenantId 设置为为连接指定的 shardingKey。 然后，返回通过数据依赖路由进行中转的连接。 这样，只需编写代码一次就能设置 SESSION_CONTEXT。
// ElasticScaleContext.cs
// Constructor for data-dependent routing.
// This call opens a validated connection that is routed to the
// proper shard by the shard map manager.
// Note that the base class constructor call fails for an open connection
// if migrations need to be done and SQL credentials are used.
// This is the reason for the separation of constructors.
// ...
public ElasticScaleContext(ShardMap shardMap, T shardingKey, string connectionStr)
: base(
OpenDDRConnection(shardMap, shardingKey, connectionStr),
true) // contextOwnsConnection
{
}
public static SqlConnection OpenDDRConnection(
ShardMap shardMap,
T shardingKey,
string connectionStr)
{
// No initialization.
Database.SetInitializer<ElasticScaleContext<T>>(null);
// Ask shard map to broker a validated connection for the given key.
SqlConnection conn = null;
try
{
conn = shardMap.OpenConnectionForKey(
shardingKey,
connectionStr,
ConnectionOptions.Validate);
// Set TenantId in SESSION_CONTEXT to shardingKey
// to enable Row-Level Security filtering.
SqlCommand cmd = conn.CreateCommand();
cmd.CommandText =
@"exec sp_set_session_context
@key=N'TenantId', @value=@shardingKey";
cmd.Parameters.AddWithValue("@shardingKey", shardingKey);
cmd.ExecuteNonQuery();
return conn;
}
catch (Exception)
{
if (conn != null)
{
conn.Dispose();
}
throw;
}
}
// ...
现在，每当调用 ElasticScaleContext 时，系统就会自动将 SESSION_CONTEXT 设置为指定的 TenantId：
// Program.cs
SqlDatabaseUtils.SqlRetryPolicy.ExecuteAction(() =>
{
using (var db = new ElasticScaleContext<int>(
sharding.ShardMap, tenantId, connStrBldr.ConnectionString))
{
var query = from b in db.Blogs
orderby b.Name
select b;
Console.WriteLine("All blogs for TenantId {0}:", tenantId);
foreach (var item in query)
{
Console.WriteLine(item.Name);
}
}
});
ADO.NET SqlClient
对于使用 ADO.NET SqlClient 的应用程序，请创建一个围绕 ShardMap.OpenConnectionForKey 方法的包装器函数。 让包装器将 SESSION_CONTEXT 中的 TenantId 自动设置为当前的 TenantId，然后再返回一个连接。 为确保始终设置 SESSION_CONTEXT，应只使用此包装函数打开连接。
// Program.cs
// Wrapper function for ShardMap.OpenConnectionForKey() that
// automatically sets SESSION_CONTEXT with the correct
// tenantId before returning a connection.
// As a best practice, you should only open connections using this method
// to ensure that SESSION_CONTEXT is always set before executing a query.
// ...
public static SqlConnection OpenConnectionForTenant(
ShardMap shardMap, int tenantId, string connectionStr)
{
SqlConnection conn = null;
try
{
// Ask shard map to broker a validated connection for the given key.
conn = shardMap.OpenConnectionForKey(
tenantId, connectionStr, ConnectionOptions.Validate);
// Set TenantId in SESSION_CONTEXT to shardingKey
// to enable Row-Level Security filtering.
SqlCommand cmd = conn.CreateCommand();
cmd.CommandText =
@"exec sp_set_session_context
@key=N'TenantId', @value=@shardingKey";
cmd.Parameters.AddWithValue("@shardingKey", tenantId);
cmd.ExecuteNonQuery();
return conn;
}
catch (Exception)
{
if (conn != null)
{
conn.Dispose();
}
throw;
}
}
// ...
// Example query via ADO.NET SqlClient.
// If row-level security is enabled, only Tenant 4's blogs are listed.
SqlDatabaseUtils.SqlRetryPolicy.ExecuteAction(() =>
{
using (SqlConnection conn = OpenConnectionForTenant(
sharding.ShardMap, tenantId4, connStrBldr.ConnectionString))
{
SqlCommand cmd = conn.CreateCommand();
cmd.CommandText = @"SELECT * FROM Blogs";
Console.WriteLine(@"--
All blogs for TenantId {0} (using ADO.NET SqlClient):", tenantId4);
SqlDataReader reader = cmd.ExecuteReader();
while (reader.Read())
{
Console.WriteLine("{0}", reader["Name"]);
}
}
});
2. 数据层：创建行级安全策略
创建安全策略，以便筛选每个租户可以访问的行
由于应用程序在查询之前会将 SESSION_CONTEXT 设置为当前 TenantId，因此 RLS 安全策略可以筛选查询并排除使用其他 TenantId 的行。
RLS 在 Transact-SQL 中实现。 用户定义的函数用于定义访问逻辑，安全策略可将此函数绑定到任意数量的表。 对于此项目：
该函数将验证应用程序是否已连接到数据库，以及存储在 SESSION_CONTEXT 中的 TenantId 是否与给定行的 TenantId 相匹配。
- 连接的是应用程序而不是某个其他的 SQL 用户。
对于 SELECT、UPDATE 和 DELETE 查询，FILTER 谓词允许符合 TenantId 筛选器条件的行通过。
- BLOCK 谓词阻止系统对不符合筛选器条件的行执行 INSERT 或 UPDATE 操作。
- 如果未设置 SESSION_CONTEXT，此函数会返回 NULL，将无法查看或插入任何行。
若要在所有分片上启用 RLS，请执行以下 T-SQL，只需使用项目中包括的 Visual Studio (SSDT)、SSMS 或 PowerShell 脚本即可。 或者，如果使用弹性数据库作业，则可自动在所有分片上执行此 T-SQL。
CREATE SCHEMA rls; -- Separate schema to organize RLS objects.
GO
CREATE FUNCTION rls.fn_tenantAccessPredicate(@TenantId int)
RETURNS TABLE
WITH SCHEMABINDING
AS
RETURN SELECT 1 AS fn_accessResult
-- Use the user in your application's connection string.
-- Here we use 'dbo' only for demo purposes!
WHERE DATABASE_PRINCIPAL_ID() = DATABASE_PRINCIPAL_ID('dbo')
AND CAST(SESSION_CONTEXT(N'TenantId') AS int) = @TenantId;
GO
CREATE SECURITY POLICY rls.tenantAccessPolicy
ADD FILTER PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.Blogs,
ADD BLOCK PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.Blogs,
ADD FILTER PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.Posts,
ADD BLOCK PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.Posts;
GO
提示
在复杂的项目中，可能需要在数百个表中添加谓词，这可能很单调乏味。 可以通过一个帮助程序存储过程来自动生成安全策略，并在架构的所有表中添加谓词。 有关详细信息，请参阅 Apply Row-Level Security to all tables - helper script（向所有表应用行级安全性 - 帮助器脚本）博客中的文章。
现在，如果再次运行示例应用程序，租户只能看到属于他们的行。 此外，应用程序只能插入当前已连接到分片数据库的租户的行，而不能插入属于其他租户的行。 而且，应用不能更新任何可见行中的 TenantId。 如果应用尝试执行上述任一操作，则会引发 DbUpdateException。
如果以后添加了新表，请通过 ALTER 操作更改安全策略，在新表中添加 FILTER 和 BLOCK 谓词。
ALTER SECURITY POLICY rls.tenantAccessPolicy
ADD FILTER PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.MyNewTable,
ADD BLOCK PREDICATE rls.fn_tenantAccessPredicate(TenantId) ON dbo.MyNewTable;
GO
添加默认约束以自动填充 INSERT 的 TenantId
可以对每个表施加默认约束，以便在插入行时向 TenantId 自动填充当前存储在 SESSION_CONTEXT 中的值。 示例如下。
-- Create default constraints to auto-populate TenantId with the
-- value of SESSION_CONTEXT for inserts.
ALTER TABLE Blogs
ADD CONSTRAINT df_TenantId_Blogs
DEFAULT CAST(SESSION_CONTEXT(N'TenantId') AS int) FOR TenantId;
GO
ALTER TABLE Posts
ADD CONSTRAINT df_TenantId_Posts
DEFAULT CAST(SESSION_CONTEXT(N'TenantId') AS int) FOR TenantId;
GO
现在，应用程序在插入行时不需要指定 TenantId：
SqlDatabaseUtils.SqlRetryPolicy.ExecuteAction(() =>
{
using (var db = new ElasticScaleContext<int>(
sharding.ShardMap, tenantId, connStrBldr.ConnectionString))
{
// The default constraint sets TenantId automatically!
var blog = new Blog { Name = name };
db.Blogs.Add(blog);
db.SaveChanges();
}
});
备注
如果对实体框架项目使用默认约束，则建议不要在 EF 数据模型中包括 TenantId 列。 之所以提供此建议，是因为实体框架查询会自动提供默认值，而这些值会重写在 T-SQL 中创建的使用 SESSION_CONTEXT 的默认约束。 举例来说，要在示例项目中使用默认约束，应该从 DataClasses.cs 中删除 TenantId（并在 Package Manager Console 中运行 Add-Migration），然后使用 T-SQL 来确保该字段仅存在于数据库表中。 这样，在插入数据时，EF 会自动提供不正确的默认值。
（可选）启用“超级用户”来访问所有行
某些应用程序可能需要创建一个可访问所有行的超级用户。 超级用户可以启用跨所有分片上的所有租户进行报告的功能。 超级用户还可以在分片上执行拆分-合并操作，此类操作涉及在数据库之间移动租户行。
若要启用超级用户，请在每个分片数据库中创建新的 SQL 用户（在本例中为 superuser）。 然后，使用允许此用户访问所有行的新谓词函数更改安全策略。 接下来会提供此类函数。
-- New predicate function that adds superuser logic.
CREATE FUNCTION rls.fn_tenantAccessPredicateWithSuperUser(@TenantId int)
RETURNS TABLE
WITH SCHEMABINDING
AS
RETURN SELECT 1 AS fn_accessResult
WHERE
(
DATABASE_PRINCIPAL_ID() = DATABASE_PRINCIPAL_ID('dbo') -- Replace 'dbo'.
AND CAST(SESSION_CONTEXT(N'TenantId') AS int) = @TenantId
)
OR
(
DATABASE_PRINCIPAL_ID() = DATABASE_PRINCIPAL_ID('superuser')
);
GO
-- Atomically swap in the new predicate function on each table.
ALTER SECURITY POLICY rls.tenantAccessPolicy
ALTER FILTER PREDICATE rls.fn_tenantAccessPredicateWithSuperUser(TenantId) ON dbo.Blogs,
ALTER BLOCK PREDICATE rls.fn_tenantAccessPredicateWithSuperUser(TenantId) ON dbo.Blogs,
ALTER FILTER PREDICATE rls.fn_tenantAccessPredicateWithSuperUser(TenantId) ON dbo.Posts,
ALTER BLOCK PREDICATE rls.fn_tenantAccessPredicateWithSuperUser(TenantId) ON dbo.Posts;
GO
维护
- 添加新分片：对所有新分片执行 T-SQL 脚本以启用 RLS，否则，不会筛选针对这些分片的查询。
- 添加新表：每当创建新表时，将 FILTER 和 BLOCK 谓词添加到所有分片上的安全策略， 否则不会筛选对新表的查询。 根据 Apply Row-Level Security automatically to newly created tables（自动向新建的表应用行级安全性）（博客）中所述，此添加操作可以使用 DDL 触发器来自动完成。
总结
可将弹性数据库工具和行级安全性一起使用，以扩大支持多租户和单租户分片的应用程序数据层。 可以使用多租户分片来提高数据存储效率。 如果大量的租户只有几行数据，则此效率提升很显著。 单租户分片可以支持其性能和隔离要求更严格的高级租户。 有关详细信息，请参阅行级安全性参考。
其他资源
- 什么是 Azure 弹性池？
- Scaling out with Azure SQL Database（使用 Azure SQL 数据库进行扩展）
- 包含 Azure SQL 数据库的多租户 SaaS 应用程序的设计模式
- 使用 Microsoft Entra ID（以前称为 Azure Active Directory）和 OpenID Connect 在多租户应用程序中进行身份验证
- Tailspin Surveys 应用程序
问题和功能请求
如有问题，请通过有关 SQL 数据库的 Microsoft 问答页面与我们联系。 可以向 SQL 数据库反馈论坛提交功能请求。
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈