快速入门：配置

开始使用 Dapr 的配置模块

接下来，我们将介绍 Dapr 的配置模块。配置项通常具有动态特性，并且与应用程序的需求紧密相关。配置项是包含配置信息的键/值对，例如：

应用程序 ID
分区键
数据库名称等

在本快速入门中，您将运行一个使用配置 API 的 order-processor 微服务。该服务将：

从配置存储中获取配置项。
订阅配置更新。

在继续快速入门之前，请选择您偏好的 Dapr SDK 语言版本。

前提条件

您需要准备以下环境：

Docker Desktop

步骤 1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

克隆后，打开一个新终端并运行以下命令，为配置项 orderId1 和 orderId2 设置值。

docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"

步骤 2：运行 `order-processor` 服务

从快速入门克隆目录的根目录，导航到 order-processor 目录。

cd configuration/python/sdk/order-processor

安装依赖项：

pip3 install -r requirements.txt

在 Dapr 边车环境中运行 order-processor 服务。

dapr run --app-id order-processor --resources-path ../../../components/ --app-port 6001 -- python3 app.py

注意：在 Windows 中，您可能需要使用 python app.py 而不是 python3 app.py。

预期输出：

== APP == Configuration for orderId1 : value: "101"
== APP ==
== APP == Configuration for orderId2 : value: "102"
== APP ==
== APP == App unsubscribed from config changes

（可选）步骤 3：更新配置项值

应用程序取消订阅后，尝试更新配置项值。使用以下命令更改 orderId1 和 orderId2 的值：

docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"

再次运行 order-processor 服务：

dapr run --app-id order-processor --resources-path ../../../components/ --app-port 6001 -- python3 app.py

注意：在 Windows 中，您可能需要使用 python app.py 而不是 python3 app.py。

应用程序将显示更新后的配置值：

== APP == Configuration for orderId1 : value: "103"
== APP ==
== APP == Configuration for orderId2 : value: "104"
== APP ==

`order-processor` 服务

order-processor 服务包括以下代码：

从配置存储中获取配置项
订阅配置更新（您之前在 CLI 中进行的操作）
取消订阅配置更新，并在 20 秒不活动后退出应用程序。

获取配置项：

# 从配置存储中获取配置项
for config_item in CONFIGURATION_ITEMS:
    config = client.get_configuration(store_name=DAPR_CONFIGURATION_STORE, keys=[config_item], config_metadata={})
    print(f"Configuration for {config_item} : {config.items[config_item]}", flush=True)

订阅配置更新：

# 订阅配置更改
configuration = await client.subscribe_configuration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS)

取消订阅配置更新并退出应用程序：

# 取消订阅配置更新
unsubscribed = True
for config_item in CONFIGURATION_ITEMS:
    unsub_item = client.unsubscribe_configuration(DAPR_CONFIGURATION_STORE, config_item)
    #...
if unsubscribed == True:
    print("App unsubscribed from config changes", flush=True)

前提条件

您需要准备以下环境：

Docker Desktop

步骤 1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

克隆后，打开一个新终端并运行以下命令，为配置项 orderId1 和 orderId2 设置值。

docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"

步骤 2：运行 `order-processor` 服务

从快速入门克隆目录的根目录，导航到 order-processor 目录。

cd configuration/javascript/sdk/order-processor

安装依赖项：

npm install

在 Dapr 边车环境中运行 order-processor 服务。

dapr run --app-id order-processor --resources-path ../../../components/ --app-protocol grpc --dapr-grpc-port 3500 -- node index.js

预期输出：

== APP == Configuration for orderId1: {"key":"orderId1","value":"101","version":"","metadata":{}}
== APP == Configuration for orderId2: {"key":"orderId2","value":"102","version":"","metadata":{}}
== APP == App unsubscribed to config changes

（可选）步骤 3：更新配置项值

应用程序取消订阅后，尝试更新配置项值。使用以下命令更改 orderId1 和 orderId2 的值：

docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"

再次运行 order-processor 服务：

dapr run --app-id order-processor --resources-path ../../../components/ --app-protocol grpc --dapr-grpc-port 3500 -- node index.js

应用程序将显示更新后的配置值：

== APP == Configuration for orderId1: {"key":"orderId1","value":"103","version":"","metadata":{}}
== APP == Configuration for orderId2: {"key":"orderId2","value":"104","version":"","metadata":{}}

`order-processor` 服务

order-processor 服务包括以下代码：

从配置存储中获取配置项
订阅配置更新（您之前在 CLI 中进行的操作）
取消订阅配置更新，并在 20 秒不活动后退出应用程序。

获取配置项：

// 从配置存储中获取配置项
//...
  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]));
  });

订阅配置更新：

// 订阅配置更新
try {
  const stream = await client.configuration.subscribeWithKeys(
    DAPR_CONFIGURATION_STORE,
    CONFIGURATION_ITEMS,
    (config) => {
      console.log("Configuration update", JSON.stringify(config.items));
    }
  );

取消订阅配置更新并退出应用程序：

// 取消订阅配置更新并在 20 秒后退出应用程序
setTimeout(() => {
  stream.stop();
  console.log("App unsubscribed to config changes");
  process.exit(0);
},

前提条件

您需要准备以下环境：

Dapr CLI 和已初始化的环境。

Docker Desktop

.NET 6、.NET 8 或 .NET 9 已安装

注意： .NET 6 是此版本中 Dapr .NET SDK 包的最低支持版本。仅 .NET 8 和 .NET 9 将在 Dapr v1.16 及更高版本中得到支持。

步骤 1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

克隆后，打开一个新终端并运行以下命令，为配置项 orderId1 和 orderId2 设置值。

docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"

步骤 2：运行 `order-processor` 服务

从快速入门克隆目录的根目录，导航到 order-processor 目录。

cd configuration/csharp/sdk/order-processor

恢复 NuGet 包：

dotnet restore
dotnet build

在 Dapr 边车环境中运行 order-processor 服务。

dapr run --app-id order-processor-http --resources-path ../../../components/ --app-port 7001 -- dotnet run --project .

预期输出：

== APP == Configuration for orderId1: {"Value":"101","Version":"","Metadata":{}}
== APP == Configuration for orderId2: {"Value":"102","Version":"","Metadata":{}}
== APP == App unsubscribed from config changes

（可选）步骤 3：更新配置项值

应用程序取消订阅后，尝试更新配置项值。使用以下命令更改 orderId1 和 orderId2 的值：

docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"

再次运行 order-processor 服务：

dapr run --app-id order-processor-http --resources-path ../../../components/ --app-port 7001 -- dotnet run --project .

应用程序将显示更新后的配置值：

== APP == Configuration for orderId1: {"Value":"103","Version":"","Metadata":{}}
== APP == Configuration for orderId2: {"Value":"104","Version":"","Metadata":{}}

`order-processor` 服务

order-processor 服务包括以下代码：

从配置存储中获取配置项
订阅配置更新（您之前在 CLI 中进行的操作）
取消订阅配置更新，并在 20 秒不活动后退出应用程序。

获取配置项：

// 从配置存储中获取配置
GetConfigurationResponse config = await client.GetConfiguration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);
foreach (var item in config.Items)
{
  var cfg = System.Text.Json.JsonSerializer.Serialize(item.Value);
  Console.WriteLine("Configuration for " + item.Key + ": " + cfg);
}

订阅配置更新：

// 订阅配置更新
SubscribeConfigurationResponse subscribe = await client.SubscribeConfiguration(DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS);

取消订阅配置更新并退出应用程序：

// 取消订阅配置更新并退出应用程序
try
{
  client.UnsubscribeConfiguration(DAPR_CONFIGURATION_STORE, subscriptionId);
  Console.WriteLine("App unsubscribed from config changes");
  Environment.Exit(0);
}

前提条件

您需要准备以下环境：

Dapr CLI 和已初始化的环境。
Java JDK 17（或更高版本）：
- Oracle JDK，或
- OpenJDK
Apache Maven，版本 3.x。

Docker Desktop

步骤 1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

克隆后，打开一个新终端并运行以下命令，为配置项 orderId1 和 orderId2 设置值。

docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"

步骤 2：运行 `order-processor` 服务

从快速入门克隆目录的根目录，导航到 order-processor 目录。

cd configuration/java/sdk/order-processor

安装依赖项：

mvn clean install

在 Dapr 边车环境中运行 order-processor 服务。

dapr run --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar

预期输出：

== APP == Configuration for orderId1: {'value':'101'}
== APP == Configuration for orderId2: {'value':'102'}
== APP == App unsubscribed to config changes

（可选）步骤 3：更新配置项值

应用程序取消订阅后，尝试更新配置项值。使用以下命令更改 orderId1 和 orderId2 的值：

docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"

再次运行 order-processor 服务：

dapr run --app-id order-processor --resources-path ../../../components -- java -jar target/OrderProcessingService-0.0.1-SNAPSHOT.jar

应用程序将显示更新后的配置值：

== APP == Configuration for orderId1: {'value':'103'}
== APP == Configuration for orderId2: {'value':'104'}

`order-processor` 服务

order-processor 服务包括以下代码：

从配置存储中获取配置项
订阅配置更新（您之前在 CLI 中进行的操作）
取消订阅配置更新，并在 20 秒不活动后退出应用程序。

获取配置项：

// 从配置存储中获取配置项
try (DaprPreviewClient client = (new DaprClientBuilder()).buildPreviewClient()) {
    for (String configurationItem : CONFIGURATION_ITEMS) {
        ConfigurationItem item = client.getConfiguration(DAPR_CONFIGURATON_STORE, configurationItem).block();
        System.out.println("Configuration for " + configurationItem + ": {'value':'" + item.getValue() + "'}");
    }

订阅配置更新：

// 订阅配置更改
Flux<SubscribeConfigurationResponse> subscription = client.subscribeConfiguration(DAPR_CONFIGURATON_STORE,
        CONFIGURATION_ITEMS.toArray(String[]::new));

取消订阅配置更新并退出应用程序：

// 取消订阅配置更改
UnsubscribeConfigurationResponse unsubscribe = client
        .unsubscribeConfiguration(subscriptionId, DAPR_CONFIGURATON_STORE).block();
if (unsubscribe.getIsUnsubscribed()) {
    System.out.println("App unsubscribed to config changes");
}

前提条件

您需要准备以下环境：

Docker Desktop

步骤 1：设置环境

克隆快速入门仓库中的示例。

git clone https://github.com/dapr/quickstarts.git

克隆后，打开一个新终端并运行以下命令，为配置项 orderId1 和 orderId2 设置值。

docker exec dapr_redis redis-cli MSET orderId1 "101" orderId2 "102"

步骤 2：运行 `order-processor` 服务

从快速入门克隆目录的根目录，导航到 order-processor 目录。

cd configuration/go/sdk/order-processor

在 Dapr 边车环境中运行 order-processor 服务。

dapr run --app-id order-processor --app-port 6001 --resources-path ../../../components -- go run .

预期输出：

== APP == Configuration for orderId1: {"Value":"101","Version":"","Metadata":null}
== APP == Configuration for orderId2: {"Value":"102","Version":"","Metadata":null}
== APP == dapr configuration subscribe finished.
== APP == App unsubscribed to config changes

（可选）步骤 3：更新配置项值

应用程序取消订阅后，尝试更新配置项值。使用以下命令更改 orderId1 和 orderId2 的值：

docker exec dapr_redis redis-cli MSET orderId1 "103" orderId2 "104"

再次运行 order-processor 服务：

dapr run --app-id order-processor --app-port 6001 --resources-path ../../../components -- go run .

应用程序将显示更新后的配置值：

== APP == Configuration for orderId1: {"Value":"103","Version":"","Metadata":null}
== APP == Configuration for orderId2: {"Value":"104","Version":"","Metadata":null}

`order-processor` 服务

order-processor 服务包括以下代码：

从配置存储中获取配置项
订阅配置更新（您之前在 CLI 中进行的操作）
取消订阅配置更新，并在 20 秒不活动后退出应用程序。

获取配置项：

// 从配置存储中获取配置项
for _, item := range CONFIGURATION_ITEMS {
	config, err := client.GetConfigurationItem(ctx, DAPR_CONFIGURATION_STORE, item)
	//...
	c, _ := json.Marshal(config)
	fmt.Println("Configuration for " + item + ": " + string(c))
}

订阅配置更新：

// 订阅配置更改
err = client.SubscribeConfigurationItems(ctx, DAPR_CONFIGURATION_STORE, CONFIGURATION_ITEMS, func(id string, config map[string]*dapr.ConfigurationItem) {
	// 应用程序首次订阅配置更改时仅返回订阅 ID
	if len(config) == 0 {
		fmt.Println("App subscribed to config changes with subscription id: " + id)
		subscriptionId = id
		return
	}
})

取消订阅配置更新并退出应用程序：

// 取消订阅配置更新并在 20 秒后退出应用程序
select {
case <-ctx.Done():
	err = client.UnsubscribeConfigurationItems(context.Background(), DAPR_CONFIGURATION_STORE, subscriptionId)
    //...
	{
		fmt.Println("App unsubscribed to config changes")
	}

演示

观看此视频演示配置 API 快速入门：

告诉我们您的想法！

我们正在不断改进我们的快速入门示例，并重视您的反馈。您觉得这个快速入门有帮助吗？您有改进建议吗？

加入我们的Discord 频道讨论。

下一步

使用 HTTP 而不是 SDK 使用 Dapr 配置。
- Python
- JavaScript
- .NET
- Java
- Go
了解更多关于配置模块的信息

探索 Dapr 教程 >>

Feedback

Was this page helpful?

Glad to hear it! Please tell us how we can improve.

Sorry to hear that. Please tell us how we can improve.

快速入门：配置

前提条件

步骤 1：设置环境

步骤 2：运行 order-processor 服务

（可选）步骤 3：更新配置项值

order-processor 服务

前提条件

步骤 1：设置环境

步骤 2：运行 order-processor 服务

（可选）步骤 3：更新配置项值

order-processor 服务

前提条件

步骤 1：设置环境

步骤 2：运行 order-processor 服务

（可选）步骤 3：更新配置项值

order-processor 服务

前提条件

步骤 1：设置环境

步骤 2：运行 order-processor 服务

（可选）步骤 3：更新配置项值

order-processor 服务

前提条件

步骤 1：设置环境

步骤 2：运行 order-processor 服务

（可选）步骤 3：更新配置项值

order-processor 服务

演示

告诉我们您的想法！

下一步

Feedback

步骤 2：运行 `order-processor` 服务

`order-processor` 服务

步骤 2：运行 `order-processor` 服务

`order-processor` 服务

步骤 2：运行 `order-processor` 服务

`order-processor` 服务

步骤 2：运行 `order-processor` 服务

`order-processor` 服务

步骤 2：运行 `order-processor` 服务

`order-processor` 服务