在OpenShift上动态更新Spring Boot应用的配置

﹏ヽ暗。殇╰゛Y 2022-12-25 00:55 215阅读 0赞

### 文章目录 ###

*  在OpenShift上动态更新Spring Boot应用的配置
 *   *  前言
     *  Spring Boot应用改造
     *   *  引入Spring Cloud Kubernetes Config依赖
         *  新建bootstrap.yaml
         *  配置示例
         *  代码示例1: 通过\`@ConfigurationProperties\`动态获取外部配置属性的值
         *  代码示例2: 通过\`@RefreshScope\`和\`@Value\`动态获取外部配置属性的值
         *  本地测试
     *  在OpenShift上配置和测试
     *   *  为\`default\` Service Account授权
         *  创建ConfigMap
         *  测试动态刷新
     *  Troubleshooting
     *   *  修改ConfigMap后没有动态刷新
         *  Spring Boot和Spring Cloud版本不兼容问题
     *  参考文档

# 在OpenShift上动态更新Spring Boot应用的配置 #

## 前言 ##

在[从零开始在OpenShift上开发和部署Spring Boot应用][OpenShift_Spring Boot] 中描述了通过设置DeploymentConfig的环境变量来在运行应用时注入`profile`和数据库配置。

本文描述了在OpenShfit上通过ConfigMap和Spring Cloud Kubernetes Config来动态更新Spring Boot应用的配置，从而可以不用重新构建和部署应用（分离程序和配置，或外部化配置），就可以在应用不停机的情况更新应用的配置。

这种场景可以用来实时更新数据库连接池配置、关闭启动特性开关和调节应用参数等。

> 在不是基于PaaS平台部署的Spring Boot应用一般都使用专门的分布式配置中心，比如Spring Cloud Config Server, Consul, 携程Apollo或阿里Nacos等。

代码示例：[https://github.com/cookcodeblog/spring-db-demo][https_github.com_cookcodeblog_spring-db-demo]

## Spring Boot应用改造 ##

版本：

*  Spring Boot 2.2.6.RELEASE
 *  Spring Cloud Hxton.SR4

### 引入Spring Cloud Kubernetes Config依赖 ###

参见：

*  [https://github.com/spring-cloud/spring-cloud-kubernetes][https_github.com_spring-cloud_spring-cloud-kubernetes]

在Maven的pom文件中引入`spring-cloud-dependencies`的dependency management：

<dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.cloud</groupId>
                    <artifactId>spring-cloud-dependencies</artifactId>
                    <version>Hoxton.SR4</version>
                    <type>pom</type>
                    <scope>import</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>

再引入`spring-cloud-starter-kubernetes-config`依赖：

<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-kubernetes-config</artifactId>
    </dependency>

### 新建bootstrap.yaml ###

Spring Cloud使用bootstrap.yaml作为应用的根配置，且不能被覆盖。

新建bootstrap.yaml：

spring:
      application:
        name: spring-db-demo
      cloud:
        kubernetes:
          reload:
            enabled: true

说明：

*  `spring.application.name`为应用名称，Spring Cloud Kubernetes Config默认根据该应用名称来查找同名的ConfigMap。可以通过`spring.cloud.kubernetes.config.name`来自定义ConfigMap的名称。
 *  `spring.cloud.kubernetes.reload.enabled=true`开启动态刷新，在ConfigMap变更时主动通知应用更新配置。

参见：

*  [https://cloud.spring.io/spring-cloud-kubernetes/spring-cloud-kubernetes.html\#\_kubernetes\_propertysource\_implementations][https_cloud.spring.io_spring-cloud-kubernetes_spring-cloud-kubernetes.html_kubernetes_propertysource_implementations]
 *  [https://github.com/spring-cloud/spring-cloud-kubernetes\#53-propertysource-reload][https_github.com_spring-cloud_spring-cloud-kubernetes_53-propertysource-reload]

### 配置示例 ###

在配置文件中增加属性：`greeting.message`。

本地配置文件`application-local.yaml`：

greeting:
      message: "Wow, your favorite fruit is %s!"

测试环境配置文件`application-test.yaml`：

greeting:
      message: "Oh, you like %s!"

### 代码示例1: 通过`@ConfigurationProperties`动态获取外部配置属性的值 ###

定义MessageProperties类：

@Configuration
    @ConfigurationProperties(prefix = "greeting")
    @Data
    public class MessageProperties { 
        private String message;
    }

定义Controller类：

@RestController
    public class GreetingConfigurationPropertiesController { 
    
        @Autowired
        private MessageProperties properties;
    
        @GetMapping("/api/greeting")
        public Message greeting(@RequestParam(value = "name", defaultValue = "Apple") String name) { 
            Objects.requireNonNull(properties.getMessage(), "Greeting message was not set in the properties");
    
            String message = String.format(properties.getMessage(), name);
            return new Message(message);
        }
    }

### 代码示例2: 通过`@RefreshScope`和`@Value`动态获取外部配置属性的值 ###

定义Controller类：

@RestController
    @RefreshScope
    public class GreetingRefreshScopeController { 
    
        @Value("${greeting.message}")
        private String greetingMessage;
    
        @GetMapping("/api/greeting2")
        public Message greeting2(@RequestParam(value = "name", defaultValue = "Apple") String name) { 
            Objects.requireNonNull(greetingMessage, "Greeting message was not set in the properties");
    
            String message = String.format(greetingMessage, name);
            return new Message(message);
        }
    }

### 本地测试 ###

在本地测试：

*  示例1: `http://localhost:8080/api/greeting?name=Grape`
 *  示例2: `http://localhost:8080/api/greeting2?name=Grape`

## 在OpenShift上配置和测试 ##

### 为`default` Service Account授权 ###

为`default` Service Account授权`view` role 访问当前项目：

oc policy add-role-to-user view -n $(oc project -q) -z default

> The `view` role on the service account is required in order to listen for config map changes.
> 
> A higher level role (such as `edit`) is required for secrets (by default, secrets are not monitored).

参见：

*  [https://github.com/spring-cloud/spring-cloud-kubernetes\#53-propertysource-reload][https_github.com_spring-cloud_spring-cloud-kubernetes_53-propertysource-reload]

### 创建ConfigMap ###

创建和SpringBoot项目中同名的ConfigMap。

默认为`spring.application.name`为应用名称，Spring Cloud Kubernetes Config默认根据该应用名称来查找同名的ConfigMap。可以通过`spring.cloud.kubernetes.config.name`来自定义ConfigMap的名称。

根据`application-test.yaml`来创建名为`spring-db-demo`的ConfigMap：

oc create configmap spring-db-demo --from-file=src/main/resources/application-test.yaml

也可以使用独立的配置文件而不是application-xxx.yaml来生成ConfigMap。比如：

oc create configmap spring-db-demo --from-file=src/main/resources/app-config.yaml

运行`oc describe configmap/spring-db-demo`查看ConfigMap详细信息：

Name:         spring-db-demo
    Namespace:    william-spring-demo
    Labels:       <none>
    Annotations:  <none>
    
    Data
    ====
    application-test.yaml:
    ----
    spring:
      profiles: test
      datasource:
        url: jdbc:mysql://${ DB_HOST}:${ DB_PORT:3306}/${ DB_NAME}?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
        username: ${ DB_USERNAME}
        password: ${ DB_PASSWORD}
        driver-class-name: com.mysql.cj.jdbc.Driver
      jpa:
        show-sql: true
    greeting:
      message: "Only one fruit %s!"
    Events:  <none>

### 测试动态刷新 ###

在OpenShift上，打开Developer / Config Maps，找到`spring-db-demo` ConfigMap，然后编辑`greeting.message`的值。

或运行`oc edit configmap/spring-db-demo` 来编辑ConfigMap。

保存修改。

测试应用是否已动态更新：

*  示例1: `http://<router_url>/api/greeting?name=Grape`
 *  示例2: `http://<router_url>/api/greeting2?name=Grape`

查看`spring-db-demo` pod的日志，可以看到ConfigMap变更后自动触发了应用更新配置：

EventBasedConfigurationChangeDetector : Detected change in config maps
    EventBasedConfigurationChangeDetector : Reloading using strategy: REFRESH
    PropertySourceBootstrapConfiguration : Located property source: [BootstrapPropertySource {name='bootstrapProperties-configmap.spring-db-demo.william-spring-demo'}]

## Troubleshooting ##

### 修改ConfigMap后没有动态刷新 ###

1.  检查应用pod日志是否报错，比如找不到指定的ConfigMap或没有权限。
2.  检查是否设置了`spring.cloud.kubernetes.reload.enabled=true`。
3.  检查应用查找的ConfigMap和OpenShift上配置ConfigMap名字是否相同。
4.  检查是否给`default` Service Account授权`view` role 访问当前项目。
5.  如果应用使用`@Value`来获取配置的属性值，检查是否同时也适用了`@RefreshScope`。

### Spring Boot和Spring Cloud版本不兼容问题 ###

采用兼容的Spring Boot和Spring Cloud版本。

## 参考文档 ##

**OpenShfit:**

*  [Extenalized Configuration for Spring Boot Application][]

**Spring Boot / Spring Cloud:**

*  [https://github.com/spring-cloud/spring-cloud-kubernetes][https_github.com_spring-cloud_spring-cloud-kubernetes]
 *  [https://cloud.spring.io/spring-cloud-kubernetes/spring-cloud-kubernetes.html\#\_kubernetes\_propertysource\_implementations][https_cloud.spring.io_spring-cloud-kubernetes_spring-cloud-kubernetes.html_kubernetes_propertysource_implementations]
 *  [https://github.com/spring-cloud/spring-cloud-kubernetes\#53-propertysource-reload][https_github.com_spring-cloud_spring-cloud-kubernetes_53-propertysource-reload]
 *  [https://projects.spring.io/spring-cloud/spring-cloud.html\#\_refresh\_scope][https_projects.spring.io_spring-cloud_spring-cloud.html_refresh_scope]

[OpenShift_Spring Boot]: https://cookcode.blog.csdn.net/article/details/110259521
[https_github.com_cookcodeblog_spring-db-demo]: https://github.com/cookcodeblog/spring-db-demo
[https_github.com_spring-cloud_spring-cloud-kubernetes]: https://github.com/spring-cloud/spring-cloud-kubernetes
[https_cloud.spring.io_spring-cloud-kubernetes_spring-cloud-kubernetes.html_kubernetes_propertysource_implementations]: https://cloud.spring.io/spring-cloud-kubernetes/spring-cloud-kubernetes.html#_kubernetes_propertysource_implementations
[https_github.com_spring-cloud_spring-cloud-kubernetes_53-propertysource-reload]: https://github.com/spring-cloud/spring-cloud-kubernetes#53-propertysource-reload
[Extenalized Configuration for Spring Boot Application]: https://learn.openshift.com/middleware/courses/middleware-spring-boot/microservices-1
[https_projects.spring.io_spring-cloud_spring-cloud.html_refresh_scope]: https://projects.spring.io/spring-cloud/spring-cloud.html#_refresh_scope