Apollo（阿波罗）——携程推出的分布式配置管理中心 & 启动Apollo & SpringBoot集成 & @ConfigurationProperties的使用姿势

旧城等待， 2024-02-05 11:16 24阅读 0赞

![在这里插入图片描述][21dbfe6205c941adb2ac97cdf73a3022.png]

## 前言 ##

Apollo（阿波罗）是一款可靠的分布式配置管理中心，诞生于携程框架研发部，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性，适用于微服务配置管理场景。

本篇博客介绍如何启动Apollo，着重阐述了如何SpringBoot集成，另外介绍了@ConfigurationProperties的使用姿势。

相关的代码开源如下：

*  gitee代码仓库：[https://gitee.com/pet365/spring-boot-apollo][https_gitee.com_pet365_spring-boot-apollo]

#### 目录 ####

*  前言
 *  引出
 *  启动apollo
 *   *  1.下载安装包，准备MySQL
     *  2.windows下通过git bash执行sh脚本
 *  springBoot集成
 *   *  1.官方给出的案例
     *  2.引入依赖，配置，主启动
     *  3.进行配置和读取
     *  关于@ConfigurationProperties自动更新的问题
 *  遇到的问题
 *   *  系统出错，请重试或联系系统负责人
     *  云服务器访问失败
     *  配置不识别apollo，版本的问题
     *  Linux系统部署apollo无法获取【未解决】
 *  总结

## 引出 ##

--------------------

1.如何启动Apollo；  
2.如何SpringBoot集成；  
3.@ConfigurationProperties的使用姿势；

## 启动apollo ##

[https://www.apolloconfig.com/\#/zh/deployment/quick-start][https_www.apolloconfig.com_zh_deployment_quick-start]

[https://github.com/apolloconfig/apollo/wiki][https_github.com_apolloconfig_apollo_wiki]

### 1.下载安装包，准备MySQL ###

Quick Start安装包，大家只需要下载到本地，就可以直接使用，免去了编译、打包过程

![在这里插入图片描述][57b1ed2e90804753852eb0e9dfac2882.png]

> 准备数据库表

![在这里插入图片描述][4bd1ccbb18e2492ba756c5e0d45ad51a.png]

### 2.windows下通过git bash执行sh脚本 ###

> 先编辑好MySQL相关的配置，用户名和密码

![在这里插入图片描述][3ff2603915e84119b69309ea2f00227c.png]

> 解压下载好的文件

![在这里插入图片描述][dd209527e41041f2baf54dea5b2aad81.png]

> 通过git bash进行运行sh脚本

![在这里插入图片描述][0e82727091334245b2b00896a3129697.png]

> ./demo.sh start即可运行

![在这里插入图片描述][232124039d0f4b678c74dcad2a786e48.png]

## springBoot集成 ##

gitee代码仓库：[https://gitee.com/pet365/spring-boot-apollo][https_gitee.com_pet365_spring-boot-apollo]

### 1.官方给出的案例 ###

[https://github.com/apolloconfig/apollo/wiki/Java%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97\#3213-spring-boot%E9%9B%86%E6%88%90%E6%96%B9%E5%BC%8F%E6%8E%A8%E8%8D%90][https_github.com_apolloconfig_apollo_wiki_Java_E5_AE_A2_E6_88_B7_E7_AB_AF_E4_BD_BF_E7_94_A8_E6_8C_87_E5_8D_97_3213-spring-boot_E9_9B_86_E6_88_90_E6_96_B9_E5_BC_8F_E6_8E_A8_E8_8D_90]

![在这里插入图片描述][ee62673a489949e28e86df8141744065.png]

### 2.引入依赖，配置，主启动 ###

> 引入依赖，注意最好引入高版本

![在这里插入图片描述][5989904bb13b4cb08d151fd79a264d6e.png]

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.tianju</groupId>
        <artifactId>springboot-apollo</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <properties>
            <protoc.version>3.11.0</protoc.version>
            <protoc-gen-grpc-java.version>1.17.0</protoc-gen-grpc-java.version>
            <maven-compiler-plugin.version>3.7.0</maven-compiler-plugin.version>
            <grpc.version>1.28.0</grpc.version>
            <java.version>1.8</java.version>
        </properties>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.6.14</version>
            <relativePath/> 
        </parent>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>com.ctrip.framework.apollo</groupId>
                <artifactId>apollo-client</artifactId>
                <version>2.1.0</version>
            </dependency>
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
        </dependencies>
    </project>

> 配置application.yml文件

![在这里插入图片描述][7d12e9559c2246da820f15cb077af2c2.png]

server:
      port: 9999
    
    # 应用id，apollo中保持一致
    app:
      id: spring-boot-logger
    apollo:
      # 是否开启apollo
      bootstrap:
        enabled: true
        # 设置命名空间namespace
        namespaces: application
      # apollo服务器 eureka地址
      meta: http://localhost:8080
    
    mysql:
      username: root
    
    myConfig: test
    
    logging:
      level:
        com.tianju: debug

> 注解@EnableApolloConfig

![在这里插入图片描述][4c2ed0527f664ddeba4a71fac2d93833.png]

package com.tianju;
    
    import com.ctrip.framework.apollo.spring.annotation.EnableApolloConfig;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    @EnableApolloConfig
    public class ApolloApp {
        
        public static void main(String[] args) {
        
            SpringApplication.run(ApolloApp.class);
        }
    }

### 3.进行配置和读取 ###

> 设置APPid

![在这里插入图片描述][e47fe767683b475fa9c952258cc3ec0f.png]

> 进行编辑配置

![在这里插入图片描述][283c5b2d882b4d14b2c3d92c02f2fd4a.png]

> 在表格视图中查看

![在这里插入图片描述][9063250f204d4a6180f092638802bf08.png]

> 配置需要发布后才能生效

![在这里插入图片描述][6729ba8c000b4309bf98ad8cabfe2e37.png]

> 配置发布后，再次访问参数

![在这里插入图片描述][bc9e7fcb64ba4cc09df8691359fc9e61.png]

> 原因是用@ConfigurationProperties 这种姿势，需要处理一下才能动态更新

![在这里插入图片描述][d22dbfba1d8f4e039c8eb5dd4275752f.png]

### 关于@ConfigurationProperties自动更新的问题 ###

需要注意的是，`@ConfigurationProperties`如果需要在Apollo配置变化时自动更新注入的值，需要配合使用[EnvironmentChangeEvent][]或[RefreshScope][]。相关代码实现，可以参考apollo-use-cases项目中的[ZuulPropertiesRefresher.java][]和apollo-demo项目中的[SampleRedisConfig.java][]以及[SpringBootApolloRefreshConfig.java][]

官网给出的案例：[https://github.com/apolloconfig/apollo-use-cases][https_github.com_apolloconfig_apollo-use-cases]

![在这里插入图片描述][89d0ca0ac7eb40a5b11d205a2590a166.png]

package com.tianju.config;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.stereotype.Component;
    
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    @Component
    @ConfigurationProperties(prefix = "mysql")
    public class MySQLPro {
        
    
        private String username;
    
        private String password;
    }

![在这里插入图片描述][0f90a270dee94749844ee12f970e0e98.png]

package com.tianju.config;
    
    import com.ctrip.framework.apollo.Config;
    import com.ctrip.framework.apollo.model.ConfigChangeEvent;
    import com.ctrip.framework.apollo.spring.annotation.ApolloConfig;
    import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.stereotype.Service;
    
    import javax.annotation.PostConstruct;
    import java.util.HashMap;
    import java.util.Map;
    import java.util.Set;
    
    /**
     * 动态获取username
     */
    @Service
    public class MySQLConfigService {
        
    
        private static final Logger logger = LoggerFactory.getLogger(MySQLConfigService.class);
    
        private static final String prefix = "mysql";
    
        @ApolloConfig
        private Config config;
    
        @Autowired
        private MySQLPro mySQLPro;
    
        @ApolloConfigChangeListener
        private void onChange(ConfigChangeEvent changeEvent){
        
            Set<String> keyNames = config.getPropertyNames();
            for (String key : keyNames){
        
                logger.debug("the key is {}",key);
                if (containsIgnoreCase(key, prefix)){
        
                    String username = config.getProperty("mysql.username", "admin-default");
                    String password = config.getProperty("mysql.password", "psdDefault");
                    Map map = new HashMap();
                    map.put("listenerUsername", username);
                    map.put("listerPassword", password);
                    logger.debug("new params is {}",map);
                    mySQLPro.setPassword(password);
                    mySQLPro.setUsername(username);
                }
            }
        }
    
        /**
         * 比较str中是否包含了 searchStr
         * @param str 这里是配置中心所有key
         * @param searchStr 要匹配的key
         * @return
         */
        private static boolean containsIgnoreCase(String str, String searchStr) {
        
            if (str == null || searchStr == null) {
        
                return false;
            }
            int len = searchStr.length();
            int max = str.length() - len;
            for (int i = 0; i <= max; i++) {
        
                // 忽略大小写进行比较
                if (str.regionMatches(true, i, searchStr, 0, len)) {
        
                    return true;
                }
            }
            return false;
        }
    
        public MySQLPro getMySQLPro() {
        
            return mySQLPro;
        }
    }

## 遇到的问题 ##

### 系统出错，请重试或联系系统负责人 ###

![在这里插入图片描述][676971f2fad3483c833d860fb4e95442.png]

![在这里插入图片描述][1bd6d4e97e5f4551a3df4b1f1d4ebbff.png]

### 云服务器访问失败 ###

两个都要设置一下

![在这里插入图片描述][b61fc194a90b4fc3b6a263734a26909f.png]

![在这里插入图片描述][e290fa0edf464fef94fa9f97e0e6ecb1.png]

### 配置不识别apollo，版本的问题 ###

![在这里插入图片描述][17787bfec4bc4d5f87aecc736b4803f2.png]

> 用2.1.0版本

![在这里插入图片描述][735a270aaf5b4feab5347dc87897b9e1.png]

### Linux系统部署apollo无法获取【未解决】 ###

在相同配置的情况下，用本地localhost进行apollo配置中心可以获得配置，而换成阿里云服务器就不行

2023-12-02 22:33:48.457  WARN 12096 --- [figRepository-1] c.c.f.a.i.AbstractConfigRepository       : Sync config failed, will retry. Repository class com.ctrip.framework.apollo.internals.RemoteConfigRepository, reason: Load Apollo Config failed - appId: spring-boot-logger, cluster: default, namespace: application, url: http://172.29.88.152:8080/configs/spring-boot-logger/default/application?ip=192.168.245.1 [Cause: Could not complete get operation [Cause: connect timed out]]
    2023-12-02 22:35:09.719  WARN 12096 --- [ngPollService-1] c.c.f.a.i.RemoteConfigLongPollService    : Long polling failed, will retry in 120 seconds. appId: spring-boot-logger, cluster: default, namespaces: application, long polling url: http://172.29.88.152:8080/notifications/v2?cluster=default&appId=spring-boot-logger&ip=192.168.245.1&notifications=%5B%7B%22namespaceName%22%3A%22application%22%2C%22notificationId%22%3A-1%7D%5D, reason: Could not complete get operation [Cause: connect timed out]
    2023-12-02 22:37:10.729  WARN 12096 --- [ngPollService-1] c.c.f.a.i.RemoteConfigLongPollService    : Long polling failed, will retry in 120 seconds. appId: spring-boot-logger, cluster: default, namespaces: application, long polling url: http://172.29.88.152:8080/notifications/v2?cluster=default&appId=spring-boot-logger&ip=192.168.245.1&notifications=%5B%7B%22namespaceName%22%3A%22application%22%2C%22notificationId%22%3A-1%7D%5D, reason: Could not complete get operation [Cause: connect timed out]
    2023-12-02 22:38:46.453  WARN 12096 --- [figRepository-1] c.c.f.a.i.RemoteConfigRepository         : Load config failed, will retry in 1 SECONDS. appId: spring-boot-logger, cluster: default, namespaces: application
    2023-12-02 22:38:48.466  WARN 12096 --- [figRepository-1] c.c.f.a.i.AbstractConfigRepository       : Sync config failed, will retry. Repository class com.ctrip.framework.apollo.internals.RemoteConfigRepository, reason: Load Apollo Config failed - appId: spring-boot-logger, cluster: default, namespace: application, url: http://172.29.88.152:8080/configs/spring-boot-logger/default/application?ip=192.168.245.1 [Cause: Could not complete get operation [Cause: connect timed out]]
    2023-12-02 22:39:11.753  WARN 12096 --- [ngPollService-1] c.c.f.a.i.RemoteConfigLongPollService    : Long polling failed, will retry in 120 seconds. appId: spring-boot-logger, cluster: default, namespaces: application, long polling url: http://172.29.88.152:8080/notifications/v2?cluster=default&appId=spring-boot-logger&ip=192.168.245.1&notifications=%5B%7B%22namespaceName%22%3A%22application%22%2C%22notificationId%22%3A-1%7D%5D, reason: Could not complete get operation [Cause: connect timed out]
    2023-12-02 22:41:12.775  WARN 12096 --- [ngPollService-1] c.c.f.a.i.RemoteConfigLongPollService    : Long polling failed, will retry in 120 seconds. appId: spring-boot-logger, cluster: default, namespaces: application, long polling url: http://172.29.88.152:8080/notifications/v2?cluster=default&appId=spring-boot-logger&ip=192.168.245.1&notifications=%5B%7B%22namespaceName%22%3A%22application%22%2C%22notificationId%22%3A-1%7D%5D, reason: Could not complete get operation [Cause: connect timed out]

![在这里插入图片描述][5d62124764614be78889d72d97da181e.png]

网上找了各种解决方法，均没有解决问题，目前还不清楚究竟是什么原因

[https://github.com/apolloconfig/apollo/issues][https_github.com_apolloconfig_apollo_issues]

![在这里插入图片描述][92a1970350b543c89d62453045dcd4a3.png]

--------------------

## 总结 ##

1.如何启动Apollo；  
2.如何SpringBoot集成；  
3.@ConfigurationProperties的使用姿势；

[21dbfe6205c941adb2ac97cdf73a3022.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/76693be0841945f585c5e62bd90f9e7b.png
[https_gitee.com_pet365_spring-boot-apollo]: https://gitee.com/pet365/spring-boot-apollo
[https_www.apolloconfig.com_zh_deployment_quick-start]: https://www.apolloconfig.com/#/zh/deployment/quick-start
[https_github.com_apolloconfig_apollo_wiki]: https://github.com/apolloconfig/apollo/wiki
[57b1ed2e90804753852eb0e9dfac2882.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/eeb3633a4b8c49e28ccf9ed9642da21f.png
[4bd1ccbb18e2492ba756c5e0d45ad51a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/f98e1bd20a6e4e9fa18db06589e20bbb.png
[3ff2603915e84119b69309ea2f00227c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/26e2dd2529794b72aac4f99f72f03c51.png
[dd209527e41041f2baf54dea5b2aad81.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/a1114db92e4746eb904fb2a3035a9abf.png
[0e82727091334245b2b00896a3129697.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/65ceb1640e3f4234a16c31968c8e41af.png
[232124039d0f4b678c74dcad2a786e48.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/d8dbcc5fbb7b4e03ae15be4c3f2d44fb.png
[https_github.com_apolloconfig_apollo_wiki_Java_E5_AE_A2_E6_88_B7_E7_AB_AF_E4_BD_BF_E7_94_A8_E6_8C_87_E5_8D_97_3213-spring-boot_E9_9B_86_E6_88_90_E6_96_B9_E5_BC_8F_E6_8E_A8_E8_8D_90]: https://github.com/apolloconfig/apollo/wiki/Java%E5%AE%A2%E6%88%B7%E7%AB%AF%E4%BD%BF%E7%94%A8%E6%8C%87%E5%8D%97#3213-spring-boot%E9%9B%86%E6%88%90%E6%96%B9%E5%BC%8F%E6%8E%A8%E8%8D%90
[ee62673a489949e28e86df8141744065.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c159667feaab43b480f2f9d3155cdc57.png
[5989904bb13b4cb08d151fd79a264d6e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/15cb61d41bcd4264867121cc3e8ca766.png
[7d12e9559c2246da820f15cb077af2c2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/910e53b55614412f8e782df2008c38c7.png
[4c2ed0527f664ddeba4a71fac2d93833.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/03de12a114d943438700d4b715e59ac1.png
[e47fe767683b475fa9c952258cc3ec0f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/9cc2ab2ee6a1461885b3039e386cedc7.png
[283c5b2d882b4d14b2c3d92c02f2fd4a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/b11e23e27f4249098ed36c806ee71e47.png
[9063250f204d4a6180f092638802bf08.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/2f6eb3bcd6a44609a217f350f6cd9f39.png
[6729ba8c000b4309bf98ad8cabfe2e37.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/2df8adc299544d05a3efef38669fd8f8.png
[bc9e7fcb64ba4cc09df8691359fc9e61.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/a1ef26a3ef534e5b8d216d2e7ba43e7d.png
[d22dbfba1d8f4e039c8eb5dd4275752f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/e5eeea27998f4854af63ad46abe9d0ec.png
[EnvironmentChangeEvent]: https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_environment_changes
[RefreshScope]: https://cloud.spring.io/spring-cloud-static/spring-cloud.html#_refresh_scope
[ZuulPropertiesRefresher.java]: https://github.com/ctripcorp/apollo-use-cases/blob/master/spring-cloud-zuul/src/main/java/com/ctrip/framework/apollo/use/cases/spring/cloud/zuul/ZuulPropertiesRefresher.java#L48
[SampleRedisConfig.java]: https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/config/SampleRedisConfig.java
[SpringBootApolloRefreshConfig.java]: https://github.com/ctripcorp/apollo/blob/master/apollo-demo/src/main/java/com/ctrip/framework/apollo/demo/spring/springBootDemo/refresh/SpringBootApolloRefreshConfig.java
[https_github.com_apolloconfig_apollo-use-cases]: https://github.com/apolloconfig/apollo-use-cases
[89d0ca0ac7eb40a5b11d205a2590a166.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/7289c252a48942779be17653e3383f14.png
[0f90a270dee94749844ee12f970e0e98.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/c931d3c340754175a1142d7302d03b0b.png
[676971f2fad3483c833d860fb4e95442.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/3c212b017c724d3abe1fe24984a6c822.png
[1bd6d4e97e5f4551a3df4b1f1d4ebbff.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/627d0460a8f143e7addf7d6fd0877429.png
[b61fc194a90b4fc3b6a263734a26909f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/0ab33dd0bc1047d28215a06e7b487914.png
[e290fa0edf464fef94fa9f97e0e6ecb1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/d5d6f00146934eccaed5a448101af65c.png
[17787bfec4bc4d5f87aecc736b4803f2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/87dcc9da0f92440284e6b946e4cc6e34.png
[735a270aaf5b4feab5347dc87897b9e1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/5b77022fcdaa4d0da26705b9cae75697.png
[5d62124764614be78889d72d97da181e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/7f9206221627401cbd2bdbd804faedc1.png
[https_github.com_apolloconfig_apollo_issues]: https://github.com/apolloconfig/apollo/issues
[92a1970350b543c89d62453045dcd4a3.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/02/05/284fd14f8c144ce79457d7fd6385b8e0.png