Dapr Cryptography Client

Mon, 01 Jan 0001 00:00:00 +0000

Dapr Cryptography 包允许您执行由 Dapr 边车提供的加密和解密操作。

生命周期管理

DaprEncryptionClient 是 Dapr 客户端的专用版本，专门用于与 Dapr Cryptography API 交互。它可以与 DaprClient 及其他 Dapr 客户端一起注册而不会出现问题。

它维护与网络资源的连接，这些资源以用于与 Dapr 边车通信的 TCP 套接字形式存在。

为了获得最佳性能，请创建一个 DaprEncryptionClient 的长期实例，并在整个应用程序中提供对该共享实例的访问。DaprEncryptionClient 实例是线程安全的，旨在共享使用。

利用依赖注入功能可以辅助实现这一点。注册方法支持将其注册为单例、作用域实例或瞬态（意味着每次注入时都会重新创建），此外还支持注册时使用来自 IConfiguration 或其他注入服务的值，这在每个类中从头创建客户端时是不切实际的。

避免为每次操作都创建一个 DaprEncryptionClient。

通过 `DaprEncryptionClientBuilder` 配置 `DaprEncryptionClient`

可以通过在调用 .Build() 创建客户端本身之前调用 DaprEncryptionClientBuilder 类上的方法来配置 DaprCryptographyClient。每个 DaprEncryptionClientBuilder 的设置是独立的，在调用 .Build() 后无法更改。

var daprEncryptionClient = new DaprEncryptionClientBuilder()
 .UseDaprApiToken("abc123") // 指定用于向 Dapr 边车进行身份验证的 API 令牌
 .Build();

DaprEncryptionClientBuilder 包含以下设置：

Dapr 边车的 HTTP 端点
Dapr 边车的 gRPC 端点
用于配置 JSON 序列化的 JsonSerializerOptions 对象
用于配置 gRPC 的 GrpcChannelOptions 对象
用于向边车验证请求的 API 令牌
用于创建 SDK 使用的 HttpClient 实例的工厂方法
在向边车发出请求时 HttpClient 实例使用的超时时间

SDK 将读取以下环境变量以配置默认值：

如何操作：在 .NET SDK 中创建和使用 Dapr Cryptography

Mon, 01 Jan 0001 00:00:00 +0000

前置条件

安装

要开始使用 Dapr Cryptography 客户端，请从 NuGet 安装 Dapr.Cryptography 包：

dotnet add package Dapr.Cryptography

DaprEncryptionClient 保持对网络资源的访问，这些资源以用于与 Dapr 边车通信的 TCP 套接字形式存在。

依赖注入

AddDaprEncryptionClient() 方法会将 Dapr 客户端注册到依赖注入容器中，这是使用此包的推荐方式。该方法接受一个可选的 options 委托用于配置 DaprEncryptionClient，以及一个 ServiceLifetime 参数，允许您为注册的服务指定不同的生命周期，而不是使用默认的 Singleton 值。

以下示例假设所有默认值都是可接受的，足以注册 DaprEncryptionClient：

services.AddDaprEncryptionClient();

可选的配置委托用于通过在 DaprEncryptionClientBuilder 上指定选项来配置 DaprEncryptionClient，如下例所示：

services.AddSingleton<DefaultOptionsProvider>();
services.AddDaprEncryptionClient((serviceProvider, clientBuilder) => {
 // 注入一个服务以从中获取值
 var optionsProvider = serviceProvider.GetRequiredService<DefaultOptionsProvider>();
 var standardTimeout = optionsProvider.GetStandardTimeout();
 
 // 在客户端构建器上配置值
 clientBuilder.UseTimeout(standardTimeout);
});

手动实例化

除了使用依赖注入外，也可以使用静态客户端构建器构建 DaprEncryptionClient。

为了获得最佳性能，请创建单个长期存在的 DaprEncryptionClient 实例，并在整个应用程序中提供对该共享实例的访问。DaprEncryptionClient 实例是线程安全的，旨在共享。

避免为每次操作创建 DaprEncryptionClient。

可以通过在调用 .Build() 创建客户端之前调用 DaprEncryptionClientBuilder 类上的方法来配置 DaprEncryptionClient。每个 DaprEncryptionClient 的设置是独立的，无法在调用 .Build() 后更改。

Dapr Cryptography .NET SDK on Dapr 文档库