Davids实战笔记：Spring Boot整合Apollo

红太狼 2023-02-22 03:58 17阅读 0赞

### 文章目录 ###

*   *  Spring Boot整合Apollo
     *   *  下载编译Apollo源码
         *  使用IDE打开Apollo
         *  准备工作
         *   *  配置数据库
             *  修改配置文件
             *  启动Apollo
         *  客户端获取配置
         *  总结

## Spring Boot整合Apollo ##

因为Spring Cloud Config需要配置一些东西才能热加载配置，而且没有图形界面，也没有灰度发布，诸多原因再加上Apollo开源了，所以很多公司还是比较青睐Apollo，所以今天花了半天时间研究了一下，试了一下本地模式，感觉还是挺不错的，废话不多说了。[官网传送门][Link 1]

### 下载编译Apollo源码 ###

当前最新版本为Apollo 1.6.1-Release，老规矩找个喜欢的文件夹clone。

// clone source code
    git clone https://github.com/ctripcorp/apollo.git
    
    // compile source code
    cd apollo/
    mvn install -Dmaven.test.skip=true
    mvn idea:idea
    或
    mvn eclipse:eclipse

### 使用IDE打开Apollo ###

![Apollo源码结构][Apollo]

### 准备工作 ###

想让Apollo跑起来需要配置最基础的3个模块，config、admin、portal，配置数据库信息和apollo-meta，我是用的本地MySQL 5.7。

#### 配置数据库 ####

在script下面的sql文件夹有两个sql文件，分别是config和portal需要用到的表，直接打开客户端运行脚本就可以了，不用多做介绍，执行完之后准备下一步，修改配置文件。  
![配置数据库][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70]

#### 修改配置文件 ####

3个工程的配置文件需要修改加上数据库配置  
![修改配置][20200701220746491.png]

# application.yml
    datasource:
      url: jdbc:mysql://localhost:3306/apolloconfigdb?characterEncoding=utf8
      username: root
      password: 888888

# apollo-env.properties因为我只配置了dev，所以把其他的注释掉了
    local.meta=http://localhost:8080
    dev.meta=http://localhost:8080
    #dev.meta=${dev_meta}
    #fat.meta=${fat_meta}
    #uat.meta=${uat_meta}
    #lpt.meta=${lpt_meta}
    #pro.meta=${pro_meta}

#### 启动Apollo ####

1.  启动服务：修改完配置之后就可以启动Apollo了，按顺序启动服务`config -> admin -> portal`，启动完成之后就可以通过localhost:8070访问Apollo控制台了。  
    ![控制台][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 1]
2.  创建项目：AppId要唯一，需要配置到客户端，应用名称填写客户端ApplicationName。  
    ![创建项目][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 2]
3.  新增配置：key就是我们用@Value(“key”)，所用到的，value就是我们配置值可以添加备注，然后我们默认选择DEV。  
    ![添加配置项][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 3]
4.  发布：点击发布按钮即可完成发布  
    ![Apollo控制台][Apollo 1]

### 客户端获取配置 ###

源码中有demo部分，但不是我们常用的形式，所以就不以源码demo说了，我们IDEA创建一个最最最基础的Spring Boot project，添加上spring-boot-starter-web，和apollo-client，比较直观。

1.  添加maven依赖

<dependency>
      	<groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.ctrip.framework.apollo</groupId>
        <artifactId>apollo-client</artifactId>
        <version>1.6.0</version>
    </dependency>

1.  添加application.yml：添加`application.yml`配置，注意application-name和app-id，要与apollo保持一致。虽然application-name不一致也不影响，但是还是建议统一一下比较好。因为Apollo使用了8080，所以我这里改成8888。

server:
      port: 8888
    
    spring:
      application:
        name: ddd-demo
    
    apollo:
      bootstrap:
        eagerLoad:
          enabled: true
        enabled: true
        namespaces: application
      meta: http://localhost:8080
    app:
      id: ddd

配置文件中的namespaces与下图对应，可以添加多个以英文逗号隔开。  
![配置对应信息][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 4]

1.  编写配置类：我这边用了两种方式来获取配置，一种是直接在需要的地方@Value，另一种是配置类。

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Configuration;
    
    import lombok.Data;
    
    @Data
    @Configuration
    public class TestApolloConfig {
        
    
        @Value("${apollo}")
        private String apollo;
    
    }

1.  编写Controller：然后写了一个Controller，方便测试

@RestController
    @RequestMapping("apollo")
    public class ApolloController {
        
    
        @Value("${apollo}")
        private String apollo;
    
        @Resource
        private TestApolloConfig testApolloConfig;
    
        @GetMapping("test")
        public String test() {
        
            String apollo1 = testApolloConfig.getApollo();
            return "TestApolloConfig：" + apollo1 + "；@Value：" + this.apollo;
        }
    
    }

1.  启动完成  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 5]
2.  开始访问：`http://localhost:8888/apollo/test`  
    ![返回结果][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 6]
3.  结果是对的，现在修改一下看会不会实时生效。`修改配置项 -> 保存 -> 重新发布`  
    ![修改配置项][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 7]  
    ![需要重新发布][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 8]  
    ![动态修改配置][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 9]  
    ![发布成功][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 10]
4.  刷新一下`http://localhost:8888/apollo/test`，成功。  
    ![修改成功][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 11]

### 总结 ###

最简单的实践完成了，看了一下客户端更新配置的源码，远程获取配置的核心类`RemoteConfigRepository`，在构造的时候启动了`schedulePeriodicRefresh`，周期性获取，默认间隔实践是2s，在`ConfigUtil`中默认。  
`private long longPollingInitialDelayInMills = 2000;//2 seconds`  
后面专门再写一篇博客简单分析一下原理，Apollo配置动态加载的核心思路还是比较清晰的。

// 构造时初始化了一堆东西
    public RemoteConfigRepository(String namespace) {
        
      m_namespace = namespace;
      m_configCache = new AtomicReference<>();
      m_configUtil = ApolloInjector.getInstance(ConfigUtil.class);
      m_httpUtil = ApolloInjector.getInstance(HttpUtil.class);
      m_serviceLocator = ApolloInjector.getInstance(ConfigServiceLocator.class);
      remoteConfigLongPollService = ApolloInjector.getInstance(RemoteConfigLongPollService.class);
      m_longPollServiceDto = new AtomicReference<>();
      m_remoteMessages = new AtomicReference<>();
      m_loadConfigRateLimiter = RateLimiter.create(m_configUtil.getLoadConfigQPS());
      m_configNeedForceRefresh = new AtomicBoolean(true);
      m_loadConfigFailSchedulePolicy = new ExponentialSchedulePolicy(m_configUtil.getOnErrorRetryInterval(),
          m_configUtil.getOnErrorRetryInterval() * 8);
      gson = new Gson();
      this.trySync();
      this.schedulePeriodicRefresh();
      this.scheduleLongPollingRefresh();
    }

[Link 1]: https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E4%BB%8B%E7%BB%8D
[Apollo]: https://img-blog.csdnimg.cn/20200701214754838.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200701215355876.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[20200701220746491.png]: https://img-blog.csdnimg.cn/20200701220746491.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200701221234768.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200701221334307.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200701221723132.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[Apollo 1]: https://img-blog.csdnimg.cn/20200701221125610.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 4]: https://img-blog.csdnimg.cn/20200701224648543.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 5]: https://img-blog.csdnimg.cn/20200701222919308.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 6]: https://img-blog.csdnimg.cn/20200701223306288.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 7]: https://img-blog.csdnimg.cn/2020070122344137.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 8]: https://img-blog.csdnimg.cn/20200701223455600.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 9]: https://img-blog.csdnimg.cn/20200701223617528.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 10]: https://img-blog.csdnimg.cn/20200701223632648.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18_size_16_color_FFFFFF_t_70 11]: https://img-blog.csdnimg.cn/20200701223707818.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0Rhdmlkc18=,size_16,color_FFFFFF,t_70