简介
Apollo（阿波罗）是携程框架部门研发的分布式配置中心，能够集中化管理应用不同环境、不同集群的配置，配置修改后能够实时推送到应用端，并且具备规范的权限、流程治理等特性，适用于微服务配置管理场景。
Apollo和Spring Cloud Config对比
通过对比，可以看出，生产环境中 Apollo 相比 Spring Cloud Config 更具有优势一些。
安装 Apollo 配置中心
搭建教程
参照我之前写的文章 xxx链接暂时先不上xxx
查看样例配置
搭建完成并启动后，访问http://192.168.137.16:8070，界面如下。
输入用户名 apollo，密码 admin 后登录后，点击SampleApp进入配置界面。
SpringBoot与Apollo整合
创建一个SpringBoot项目
POM文件
<?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>org.example</groupId>
<artifactId>springboot-apollo</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.2.1.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- https://mvnrepository.com/artifact/com.ctrip.framework.apollo/apollo-client -->
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>1.7.0</version>
</dependency>
<!--需要引入该jar才能使bootstrap配置文件生效-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-context</artifactId>
</dependency>
<!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Hoxton.SR1</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
bootstrap.yml文件
server:
port: 8099
spring:
application:
name: springboot-apollo
app:
id: ${spring.application.name}
apollo:
meta: http://192.168.137.16:8080
cacheDir: /opt/data/test
bootstrap:
enabled: true
eagerLoad:
enabled: true
#对于Mac/Linux，文件位置为/opt/settings/server.properties
#对于Windows，文件位置为 项目根目录\opt\settings\server.properties
配置详解:
app.id: 应用的身份信息，是从服务端获取配置的一个重要信息。
apollo.meta:
apollo.cacheDir:本地缓存路径（对于Mac/Linux，文件位置为/opt/settings/server.properties，对于Windows，文件位置为项目根目录:\opt\settings\server.properties）
apollo.bootstrap.enabled:在应用启动阶段，向Spring容器注入被托管的application.properties文件的配置信息。
apollo.bootstrap.eagerLoad.enabled:将Apollo配置加载提到初始化日志系统之前。
application.yml文件
sunny:
name: klm
配置详解:
sunny.name:用于读取动态配置
注意:可能会有人注意到,我为啥要使用bootstrap文件,而且maven依赖也是使用的springcloud依赖,有以下几点原因:
1.bootstrap文件会比application文件优先加载
2.规范上,bootstrap文件是存储不会发生改变的配置,application文件是存储会发生改变的配置的,规范问题。
3.apollo的动态刷新配置,bootstap和application都可以实现动态刷新,所以练习的时候,可以不用跟我一样,都在加个bootstrap了
Controller类
我这里是通过两种方式获取配置文件信息
第一种:基于Spring的形式获取,缺陷是当Apollo文件发生改变,配置文件无法获取到最新的,后面有讲到解决方案
第二种:通过Apollo的形式获取,这种是直接获取通过Apollo配置的key,读取apollo配置了
@RestController
public class ApolloController {
//#################################### 获取配置1 #######################################
@Value("${sunny.name}")
String name;
@GetMapping("/test1")
public String test1() {
System.out.println(name);
return name;
}
//#################################### 获取配置2 #######################################
@ApolloConfig
private Config config;
@GetMapping("/test2")
public String test2() {
String test = config.getProperty("sunny.name", "test");
System.out.println(test);
return test;
}
}
启动类
@SpringBootApplication
public class SpringBootApplicationMain {
public static void main(String[] args) {
SpringApplication.run(SpringBootApplicationMain.class);
}
}
Apollo配置中心配置
管理员基础操作等,具体后面会有了解到的
创建项目
如果是根据我的教程来搭建的Apollo的话,ip就是服务器的地址,端口是8070访问。
填写项目信息
部门:Apollo有默认的,我这里就先用默认的了,当然Apollo还是支持自定义的
AppId: 这里的Appid要跟项目的spring.application.name 名称一致,否则无法读取配置
应用名称:自定义,主要用于apollo控制台显示的
应用负责人: 主要对该应用具体实权操作的人,我这里选择的管理员,当然也可以通过上上上图中的用户管理,额外添加用户,用于负责该应用
点击提交,就如下图
添加配置
可以看到环境中,我这里是有DEV和FAT环境的,默认情况下是DEV环境,当然需要发布环境,可以自定义加入
我这里就将配置加入到DEV环境中
点击新增配置,进入新增配置界面
key:配置文件的属性key
value:配置文件的属性value值
comment:备注
集群环境,我这里选择dev,默认集群名称为default
注意:Apollo控制台默认配置存储是properties格式哦,如果项目中配置文件中是yml文件也是没关系的,apollo会自动映射的
发布配置
前面新增的配置只是持久化apollo数据库中,并未真正发布出去,项目中还无法读取到,所以只有到项目真正需要用到该配置,才需发布
可选填写备注,确认配置无误,则直接点发布即可
[图片上传中...(clipboard.png-12c29c-1597107788593-0)]
如下图,现在就是已经成功发布了
更改格式为yml格式
如果有朋友不习惯用properties格式,Apollo也是支持yml格式进行编辑的
点击创建namespace
选择私有的namespace空间,名字自定义，点击保存
查看变化,默认的是properties格式,下面是我创建的yml格式
查看发布历史
点击查看全部配置,可以看到往期所有的发布历史,如果配置发生误操作,也可以选择性的回滚
测试
在apollo里面我填写的配置内容为:测试修改值,而我配置文件中的内容为:klm
使用网页访问测试接口:http://localhost:8099/test1
项目直接读取Apollo的配置,并未读取本地的配置了
监听配置变化事件
监听配置变化事件只在应用真的关心配置变化，需要在配置变化时得到通知时使用，比如：数据库连接串变化后需要重建连接等。
解决方案:
添加事件监听即可
@Component
@Slf4j
public class ApolloRefreshConfig implements ApplicationContextAware {
ApplicationContext applicationContext;
@Autowired
RefreshScope refreshScope;
//这里指定Apollo的namespace，非常重要，如果不指定，默认只使用application
@ApolloConfigChangeListener(ConfigConsts.NAMESPACE_APPLICATION)
public void onChange(ConfigChangeEvent changeEvent) {
for (String changedKey : changeEvent.changedKeys()) {
log.info("apollo changed namespace:{} Key:{} value:{}", changeEvent.getNamespace(), changedKey, changeEvent.getChange(changedKey));
}
refreshProperties(changeEvent);
}
public void refreshProperties(ConfigChangeEvent changeEvent) {
this.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));
refreshScope.refreshAll();
}
@Override
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
this.applicationContext = applicationContext;
}
}
启动类也需要加入一个Apollo的注解
@EnableApolloConfig
整合到此就结束了
