配置概述

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

在开发应用程序时，配置是一个常见的任务。通常，我们会使用配置存储来管理这些配置数据。配置项通常具有动态特性，并且与应用程序的需求紧密相关。

例如，应用程序的配置可能包括：

密钥名称
各种标识符
分区或消费者ID
数据库名称等

通常，配置项以键/值对的形式存储在状态存储或数据库中。开发人员或运维人员可以在运行时更改配置存储中的应用程序配置。一旦进行了更改，服务会被通知以加载新的配置。

从应用程序API的角度来看，配置数据是只读的，配置存储的更新通过运维工具进行。使用Dapr的配置API，您可以：

获取以只读键/值对形式返回的配置项
订阅配置项的变更通知

注意

配置API不应与Dapr sidecar和控制平面配置混淆，后者用于在Dapr sidecar实例或已安装的Dapr控制平面上设置策略和参数。

试用配置

快速入门

想要测试Dapr配置API？通过以下快速入门来了解配置API的实际应用：

快速入门	描述
配置快速入门	使用配置API获取配置项或订阅配置更改。

直接在应用中开始使用配置API

想要跳过快速入门？没问题。您可以直接在应用程序中尝试配置构建模块以读取和管理配置数据。在Dapr安装完成后，您可以从配置操作指南开始使用配置API。

观看演示

观看使用Dapr配置构建模块的演示

下一步

请参阅以下指南：

操作指南：从配置存储读取应用程序配置

操作指南：从存储中管理配置

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

本示例使用Redis配置存储组件来演示如何检索配置项。

注意

如果您还没有试过，请尝试配置快速入门，快速了解如何使用配置API。

在存储中创建配置项

在支持的配置存储中创建一个配置项。这可以是一个简单的键值项，使用您选择的任何键。本示例使用Redis配置存储组件。

使用Docker运行Redis

docker run --name my-redis -p 6379:6379 -d redis:6

保存一个配置项

使用Redis CLI，连接到Redis实例：

redis-cli -p 6379

保存一个配置项：

MSET orderId1 "101||1" orderId2 "102||1"

配置Dapr配置存储

将以下组件文件保存到您机器上的默认组件文件夹。您可以将其用作Dapr组件YAML：

对于Kubernetes使用kubectl。
使用Dapr CLI运行时。

注意

由于Redis配置组件与Redis statestore.yaml组件具有相同的元数据，如果您已经有Redis statestore.yaml，可以直接复制或修改Redis状态存储组件类型。

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
 name: configstore
spec:
 type: configuration.redis
 metadata:
 - name: redisHost
 value: localhost:6379
 - name: redisPassword
 value: <PASSWORD>

检索配置项

获取配置项

以下示例展示了如何使用Dapr配置API获取已保存的配置项。

//依赖项
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Dapr.Client;

//代码
namespace ConfigurationApi
{
 public class Program
 {
 private static readonly string CONFIG_STORE_NAME = "configstore";

 public static async Task Main(string[] args)
 {
 using var client = new DaprClientBuilder().Build();
 var configuration = await client.GetConfiguration(CONFIG_STORE_NAME, new List<string>() { "orderId1", "orderId2" });
 Console.WriteLine($"Got key=\n{configuration[0].Key} -> {configuration[0].Value}\n{configuration[1].Key} -> {configuration[1].Value}");
 }
 }
}

//依赖项
import io.dapr.client.DaprClientBuilder;
import io.dapr.client.DaprClient;
import io.dapr.client.domain.ConfigurationItem;
import io.dapr.client.domain.GetConfigurationRequest;
import io.dapr.client.domain.SubscribeConfigurationRequest;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;

//代码
private static final String CONFIG_STORE_NAME = "configstore";

public static void main(String[] args) throws Exception {
 try (DaprClient client = (new DaprClientBuilder()).build()) {
 List<String> keys = new ArrayList<>();
 keys.add("orderId1");
 keys.add("orderId2");
 GetConfigurationRequest req = new GetConfigurationRequest(CONFIG_STORE_NAME, keys);
 try {
 Mono<List<ConfigurationItem>> items = client.getConfiguration(req);
 items.block().forEach(ConfigurationClient::print);
 } catch (Exception ex) {
 System.out.println(ex.getMessage());
 }
 }
}

#依赖项
from dapr.clients import DaprClient
#代码
with DaprClient() as d:
 CONFIG_STORE_NAME = 'configstore'
 keys = ['orderId1', 'orderId2']
 #Dapr启动时间
 d.wait(20)
 configuration = d.get_configuration(store_name=CONFIG_STORE_NAME, keys=[keys], config_metadata={})
 print(f"Got key={configuration.items[0].key} value={configuration.items[0].value} version={configuration.items[0].version}")

package main

import (
	"context"
 "fmt"

	dapr "github.com/dapr/go-sdk/client"
)

func main() {
	ctx := context.Background()
	client, err := dapr.NewClient()
	if err != nil {
		panic(err)
	}
	items, err := client.GetConfigurationItems(ctx, "configstore", ["orderId1","orderId2"])
	if err != nil {
		panic(err)
	}
 for key, item := range items {
 fmt.Printf("get config: key = %s value = %s version = %s",key,(*item).Value, (*item).Version)
 }
}

import { CommunicationProtocolEnum, DaprClient } from "@dapr/dapr";

// JS SDK尚不支持通过HTTP协议的配置API
const protocol = CommunicationProtocolEnum.GRPC;
const host = process.env.DAPR_HOST ?? "localhost";
const port = process.env.DAPR_GRPC_PORT ?? 3500;

const DAPR_CONFIGURATION_STORE = "configstore";
const CONFIGURATION_ITEMS = ["orderId1", "orderId2"];

async function main() {
 const client = new DaprClient(host, port, protocol);
 // 从配置存储中获取配置项
 try {
 const config = await client.configuration.get(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);
 Object.keys(config.items).forEach((key) => {
 console.log("Configuration for " + key + ":", JSON.stringify(config.items[key]));
 });
 } catch (error) {
 console.log("Could not get config item, err:" + error);
 process.exit(1);
 }
}

main().catch((e) => console.error(e));

启动一个Dapr sidecar：

配置 on Dapr 文档库