在 Azure 容器应用 中连接到 Spring 的托管配置服务器

Config Server for Spring 提供了集中位置来向多个应用程序提供配置数据。 本文介绍如何将托管在 Azure 容器应用 中的应用连接到 Java Config Server for Spring 实例。

适用于 Spring Java 组件的配置服务器使用GitHub存储库作为配置设置的源。 配置值通过组件和容器应用之间的绑定提供给容器应用。 当配置服务器中的值发生更改时，它们会自动流向应用程序，而无需重新编译或重新部署应用程序。

在本教程中，学习：

先决条件

• 具有活动订阅的Azure帐户。 如果你没有，可以免费创建一个。
• Azure CLI。

注意事项

在 Azure 容器应用 的 Config Server for Spring 中运行时，请注意以下详细信息：

安装

在开始使用 Config Server for Spring 之前，首先需要创建所需的资源。

此环境用于托管 Config Server for Spring Java 组件和容器应用。

为 Spring Java 组件创建配置服务器

有了容器应用环境后，可创建容器应用并将其绑定到 Config Server for Spring Java 组件。 绑定容器应用时，配置值会自动从 Config Server 组件同步到应用程序。

将容器应用绑定到 Spring Java 组件的配置服务器

容器应用和 Config Server 组件绑定在一起后，配置更改会自动同步到容器应用。

再次访问应用的 URL 时，connectTimeout 的值现在为 10000。 此值来自 $URI 变量中最初设置为配置组件源的 Git 存储库。 具体而言，此值取自存储库的 `connectionTimeout` 属性，并位于 `application.yml` 文件中。

绑定请求将配置设置以环境变量的形式注入应用程序。 从配置服务器提取配置设置时，这些值现在可提供给应用程序代码使用。

在这种情况下，应用程序可使用以下环境变量：

SPRING_CLOUD_CONFIG_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CLOUD_CONFIG_COMPONENT_URI=http://[JAVA_COMPONENT_INTERNAL_FQDN]:80
SPRING_CONFIG_IMPORT=optional:configserver:$SPRING_CLOUD_CONFIG_URI

如果要自定义自己的 SPRING_CONFIG_IMPORT，可以引用环境变量 SPRING_CLOUD_CONFIG_COMPONENT_URI - 例如，可以通过命令行参数（如 Java -Dspring.config.import=optional:configserver:${SPRING_CLOUD_CONFIG_COMPONENT_URI}?fail-fast=true）替代。

还可从应用程序中移除绑定。

（可选）将容器应用从 Spring Java 组件的配置服务器解除绑定

az containerapp update \
    --name $APP_NAME \
    --unbind $JAVA_COMPONENT_NAME \
    --resource-group $RESOURCE_GROUP

再次访问应用的 URL 时，connectTimeout 的值变回 0。

清理资源

本教程中创建的资源对Azure帐单产生影响。 如果不打算长期使用这些服务，请运行以下命令来删除本教程中创建的所有内容。

az group delete --resource-group $RESOURCE_GROUP

配置选项

az containerapp update命令使用--configuration参数控制 Config Server for Spring 的配置方式。 只要多个参数被空格分隔，就可以一次性使用它们。 有关详细信息，请参阅 Spring Cloud Config Server。

下表列出了可用的不同 Git 后端配置值：

以下列表描述了常见配置：

• 日志记录相关配置：

  • logging.level.*
  • logging.group.*
  • 应禁止使用 logging.* 命名空间下的任何其他配置，例如，应禁止使用 logging.file 写入日志文件。

• spring.cloud.config.server.overrides

  • 要无条件地发送到所有客户端的属性源的额外映射。

• spring.cloud.config.override-none

  • 可以通过在远程存储库中设置 spring.cloud.config.override-none=true 标志（默认值为 false）来更改客户端中所有替代的优先级，使它们更像是默认值，让应用程序在环境变量或系统属性中提供自己的值。

• spring.cloud.config.allow-override

  • 如果启用配置起始引导，则可以允许客户端应用程序覆盖来自配置服务器的配置。 通过在来自配置服务器的应用程序配置中放置两个属性来完成覆盖。

• spring.cloud.config.server.health.*

  • 可以将运行状况指示器配置为检查更多应用程序以及自定义配置文件和自定义标签。

• spring.cloud.config.server.accept-empty

  • 如果找不到应用程序，则可以将 spring.cloud.config.server.accept-empty 设置为 false 来让服务器返回 HTTP 404 状态。 此标志默认设置为 true。

• 加密和解密（对称）：

  • encrypt.key
    • 使用对称密钥时很方便，因为它是一个待配置的属性值。
  • spring.cloud.config.server.encrypt.enabled
    • 将此属性设置为 false 以禁用服务器端解密。

刷新​​

使用属性的服务需要在更改发生之前知道它。 Config Server for Spring 的默认通知方法涉及手动触发刷新事件，例如通过调用https://<YOUR_CONFIG_CLIENT_HOST_NAME>/actuator/refresh刷新，但如果有许多应用实例，这就可能不可行。

可以改为让配置客户端根据刷新间隔来轮询更改，从而自动刷新 Config Server 中的值。 使用以下步骤自动刷新 Config Server 中的值：

1. 注册计划任务以按给定的间隔刷新上下文，如以下示例所示：

   @Configuration
   @AutoConfigureAfter({RefreshAutoConfiguration.class, RefreshEndpointAutoConfiguration.class})
   @EnableScheduling
   public class ConfigClientAutoRefreshConfiguration implements SchedulingConfigurer {
       @Value("${spring.cloud.config.refresh-interval:60}")
       private long refreshInterval;
       @Value("${spring.cloud.config.auto-refresh:false}")
       private boolean autoRefresh;
       private final RefreshEndpoint refreshEndpoint;
       public ConfigClientAutoRefreshConfiguration(RefreshEndpoint refreshEndpoint) {
           this.refreshEndpoint = refreshEndpoint;
       }
       @Override
       public void configureTasks(ScheduledTaskRegistrar scheduledTaskRegistrar) {
           if (autoRefresh) {
               // set minimal refresh interval to 5 seconds
               refreshInterval = Math.max(refreshInterval, 5);
               scheduledTaskRegistrar.addFixedRateTask(refreshEndpoint::refresh,  Duration.ofSeconds(refreshInterval));
           }
       }
   }
   

2. 在 application.yml 文件中启用 autorefresh 并设置适当的刷新间隔。 在以下示例中，客户端每隔 60 秒钟轮询一次配置更改，这是可为刷新间隔设置的最小值。

   默认情况下，autorefresh 设置为 false，refresh-interval 设置为 60 秒。

   spring:
       cloud:
           config:
           auto-refresh: true
           refresh-interval: 60
   management:
       endpoints:
           web:
           exposure:
               include:
               - refresh
   

3. 在代码中添加 @RefreshScope。 在以下示例中，变量 connectTimeout 每隔 60 秒钟自动刷新一次：

   @RestController
   @RefreshScope
   public class HelloController {
       @Value("${timeout:4000}")
       private String connectTimeout;
   }
   

使用对称密钥进行加密和解密

服务器端解密

默认启用服务器端加密。 使用以下步骤在应用程序中启用解密：

1. 在你的 Git 存储库中的 .properties 文件中添加加密属性。

   文件应与下面的示例类似：

   message={cipher}f43e3df3862ab196a4b367624a7d9b581e1c543610da353fbdd2477d60fb282f
   

2. 更新 Spring Java 组件的配置服务器，以使用具有加密属性并设置加密密钥的 Git 存储库。

   在运行以下命令之前，请将 <> 括起来的占位符替换为你的值。

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> encrypt.key=randomKey
   

客户端解密

可以按照以下步骤使用属性的客户端解密：

1. 在你的 Git 存储库中的 .properties 文件中添加加密属性。

2. 更新 Config Server for Spring Java 组件，以使用具有加密属性并禁用服务器端解密的 Git 存储库。

   在运行以下命令之前，请将 <> 括起来的占位符替换为你的值。

   az containerapp env java-component config-server-for-spring update \
       --environment <ENVIRONMENT_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --name <JAVA_COMPONENT_NAME> \
       --configuration spring.cloud.config.server.git.uri=<URI> spring.cloud.config.server.encrypt.enabled=false
   

3. 在你的客户端应用中，将解密密钥 ENCRYPT_KEY=randomKey 添加为环境变量。

   或者，如果在 spring-cloud-starter-bootstrap 上包含 classpath，或将 spring.cloud.bootstrap.enabled=true 设置为系统属性，则在 encrypt.key 中设置 bootstrap.properties。

   在运行以下命令之前，请将 <> 括起来的占位符替换为你的值。

   az containerapp update \
       --name <APP_NAME> \
       --resource-group <RESOURCE_GROUP> \
       --set-env-vars "ENCRYPT_KEY=randomKey"
   

   encrypt:
     key: somerandomkey