SpringBoot整合Apollo配置中心快速使用
一、简介
1.Apollo 是什么?Apollo(阿波罗)是携程框架部门研发的分布式配置中心。服务端基于Spring Boot和Spring Cloud开发。
2.为什么要使用Apollo?
- 安全性:配置跟随源代码保存在代码库中,容易造成配置泄漏
- 时效性:普通方式配置,修改配置,需要重启服务才能生效
- 局限性:无法支持动态调整:例如日志开关、功能开关
二、使用
1. 测试项目搭建
注:本文主要介绍SpringBoot 整合 Apollo 实现动态配置
1.1 添加Maven依赖
<dependency><groupId>com.ctrip.framework.apollo</groupId><artifactId>apollo-client</artifactId><version>1.3.0</version>
</dependency>
1.2 配置文件
# apollo集成
# apollo 配置应用的 appid
app.id=springboot-apollo-demo1
# apollo meta-server地址,一般同config-server地址
apollo.meta=http://192.168.0.153:8080
#启用apollo配置开关
apollo.bootstrap.enabled=true
apollo.bootstrap.eagerLoad.enabled=true
# apollo 使用配置的命名空间,多个以逗号分隔
apollo.bootstrap.namespaces = application
配置说明:
- app.id:在配置中心配置的应用身份信息。
- apollo.bootstrap.enabled:在应用启动阶段是否向Spring容器注入被托管的properties文件配置信息。
- apollo.bootstrap.eagerLoad.enabled:将Apollo配置加载提到初始化日志系统之前。
- apollo.bootstrap.namespaces:配置的命名空间,多个逗号分隔,一个namespace相当于一个配置文件。
- **apollo.meta:**当前环境服务配置地址,生产环境建议至少双节点,可以填写多个逗号分隔,使用一个单独的域,如 http://config.xxx.com(由nginx等软件负载平衡器支持),而不是多个IP地址,因为服务器可能会扩展或缩小。
图示说明:
1.3 添加启动类
@SpringBootApplication(exclude = {DataSourceAutoConfiguration.class, DataSourceTransactionManagerAutoConfiguration.class})
public class SpringbootApolloApplication {public static void main(String[] args) {SpringApplication.run(SpringbootApolloApplication.class, args);}
}
1.4 添加配置开关类
基于@Value注解配置
@Component
public class ValueStyleProperty {@Value("${apollo.value.demoKey1}")private String demoKey1;@Value("${apollo.value.demoKey2}")private String demoKey2;//省略 get/set 方法
}
1.5 添加测试controller
/*** value注解方式,获取属性** @author mengqiang*/
@RestController
@RequestMapping("/value-style")
public class ValuePropertyController {@Autowiredprivate ValueStyleProperty keyProperty;@Value("${server.port}")private String port;@Value("${apollo.bootstrap.namespaces:'application'}")private String namespaces;@GetMapping("/get")public Map<String, Object> getProperty() {Map<String, Object> map = new LinkedHashMap<>();map.put("port", port);map.put("namespaces", namespaces);map.put("demoKey1", keyProperty.getDemoKey1());map.put("demoKey2", keyProperty.getDemoKey2());return map;}}
2. Apollo配置中心的配置
2.1 创建项目
2.2 填写配置信息
配置说明:
- 部门:选择应用所在的部门。(可自定义部门)
- 应用AppId:用来标识应用身份的唯一id,格式为string,需与application.properties中配置的app.id一致。
- 应用名称:应用名,仅用于界面展示。
- 应用负责人:选择的人默认会成为该项目的管理员,具备项目权限管理、集群创建、Namespace创建等权限。
项目配置主页截图
2.3 添加配置
2.3.1 表格形式单个添加
注:不能批量操作
2.3.2 文本形式批量添加
注:可实现批量操作
2.4 发布配置
注:配置只有发布后才会生效
点击发布按钮
2.5 多环境同步配置
注意事项:
- 通过同步配置功能,可以使多个环境、集群间的配置保持一致
- 需要注意的是,同步完之后需要发布后才会对应用生效
点击同步配置
选择需要同步的配置,以及目标环境
点击同步
目标环境查看
3. 项目启动与测试
3.1 初始启动读取测试
3.2 自动更新属性测试
发布后控制台变化
测试输出值变化
4.常见整合问题
4.1@ConfigurationProperties注解整合Apollo不生效问题
示例配置类
/*** 公共开关,key值 属性配置** @author mengqiang*/
@Component
@ConfigurationProperties(prefix = "apollo.first.config")
public class ConfigFirstProperty {/*** 测试数字*/private Integer oneNumber;/*** 测试字符串*/private String oneStr;/*** 启用标记*/private Boolean oneEnableFlag;/*** 税率 默认 0.03*/private BigDecimal oneTaxRate = new BigDecimal("0.03");//省略 get/set 方法}
解决方案
添加监听配置
import com.ctrip.framework.apollo.model.ConfigChange;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;/*** Apollo 配置监听*/
@Configuration
public class ApolloConfigListener implements ApplicationContextAware {/*** 日志*/private static final Logger LOGGER = LoggerFactory.getLogger(ApolloConfigListener.class);private ApplicationContext applicationContext;/*** 配置监听* ApolloConfigChangeListener > value 属性默认 命名空间 "application"** 示例: @ApolloConfigChangeListener(value = {"application", "test_space"})*/@ApolloConfigChangeListenerprivate void onChange(ConfigChangeEvent changeEvent) {LOGGER.info("【Apollo-config-change】start");for (String key : changeEvent.changedKeys()) {ConfigChange change = changeEvent.getChange(key);LOGGER.info("key={} , propertyName={} , oldValue={} , newValue={} ", key, change.getPropertyName(), change.getOldValue(), change.getNewValue());}// 更新相应的bean的属性值,主要是存在@ConfigurationProperties注解的beanthis.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));LOGGER.info("【Apollo-config-change】end");}@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}
}
4.2日志级别未更新问题
示例配置
logging.level.com.example=info
解决方案-日志监听器
import com.ctrip.framework.apollo.model.ConfigChange;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.logging.LogLevel;
import org.springframework.boot.logging.LoggingSystem;
import org.springframework.context.annotation.Configuration;
import javax.annotation.Resource;/*** Apollo 日志-配置监听*/
@Configuration
public class LoggerConfigListener {private static final Logger LOGGER = LoggerFactory.getLogger(LoggerConfigListener.class);private static final String LOGGER_TAG = "logging.level.";@Resourceprivate LoggingSystem loggingSystem;/*** 监听 日志配置的变化*/@ApolloConfigChangeListener(interestedKeyPrefixes = LOGGER_TAG)private void onChangeLogger(ConfigChangeEvent changeEvent) {LOGGER.info("【Apollo-logger-config-change】>> start");refreshLoggingLevel(changeEvent);LOGGER.info("【Apollo-logger-config-change】>> end");}/*** 刷新日志级别*/private void refreshLoggingLevel(ConfigChangeEvent changeEvent) {if (null == loggingSystem) {return;}for (String key : changeEvent.changedKeys()) {ConfigChange change = changeEvent.getChange(key);if (!StringUtils.containsIgnoreCase(key, LOGGER_TAG)) {continue;}LOGGER.info("【Apollo-logger-config-change】>> key={} , propertyName={} , oldValue={} , newValue={} ",key, change.getPropertyName(), change.getOldValue(), change.getNewValue());String newLevel = change.getNewValue();LogLevel level = LogLevel.valueOf(newLevel.toUpperCase());loggingSystem.setLogLevel(key.replace(LOGGER_TAG, ""), level);LOGGER.info("【Apollo-logger-config-change】>> {} -> {}", key, newLevel);}}
}
4.3日志+配置类自动刷新整合监听
注:由于 4.1与4.2监听有重合,所以最好放在一起处理
import com.ctrip.framework.apollo.model.ConfigChange;
import com.ctrip.framework.apollo.model.ConfigChangeEvent;
import com.ctrip.framework.apollo.spring.annotation.ApolloConfigChangeListener;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
import org.springframework.boot.logging.LogLevel;
import org.springframework.boot.logging.LoggingSystem;
import org.springframework.cloud.context.environment.EnvironmentChangeEvent;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.context.annotation.Configuration;
import javax.annotation.Resource;/*** Apollo 配置监听*/
@Configuration
public class ApolloConfigListener implements ApplicationContextAware {/*** 日志*/private static final Logger LOGGER = LoggerFactory.getLogger(ApolloConfigListener.class);/*** 日志配置常量*/private static final String LOGGER_TAG = "logging.level.";@Resourceprivate LoggingSystem loggingSystem;private ApplicationContext applicationContext;@Overridepublic void setApplicationContext(ApplicationContext applicationContext) throws BeansException {this.applicationContext = applicationContext;}/*** 配置监听* ApolloConfigChangeListener > value 属性默认 命名空间 "application"*/@ApolloConfigChangeListenerprivate void onChangeConfig(ConfigChangeEvent changeEvent) {LOGGER.info("【Apollo-config-change】>> start");for (String key : changeEvent.changedKeys()) {ConfigChange change = changeEvent.getChange(key);LOGGER.info("【Apollo-config-change】>> key={} , propertyName={} , oldValue={} , newValue={} ",key, change.getPropertyName(), change.getOldValue(), change.getNewValue());//是否为日志配置if (StringUtils.containsIgnoreCase(key, LOGGER_TAG)) {//日志配置刷新changeLoggingLevel(key, change);continue;}// 更新相应的bean的属性值,主要是存在@ConfigurationProperties注解的beanthis.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));}LOGGER.info("【Apollo-config-change】>> end");}/*** 刷新日志级别*/private void changeLoggingLevel(String key, ConfigChange change) {if (null == loggingSystem) {return;}String newLevel = change.getNewValue();LogLevel level = LogLevel.valueOf(newLevel.toUpperCase());loggingSystem.setLogLevel(key.replace(LOGGER_TAG, ""), level);LOGGER.info("【Apollo-logger-config-change】>> {} -> {}", key, newLevel);}
}
4.4 其它问题
4.4.1配置文件与配置中心同时存在配置,启用的是那一份
apollo 配置开关开启情况下,配置中心配置会覆盖本地配置
注:配置开关 apollo.bootstrap.enabled=true
4.4.2 配置中心挂掉会影响已发布的项目吗?
项目启动后配置会存在缓存中,配置中心挂掉,已发布的项目不影响
4.4.3 是否支持更新端口配置
支持更新端口配置,但是必需要重启生效,同时也需要考虑服务器的端口占用问题。
附录
Apollo官方文档相关
官方源码地址:https://github.com/ctripcorp/apollo
官方演示环境(Demo):
106.54.227.205
账号/密码:apollo/admin
快速搭建本地测试环境
https://github.com/ctripcorp/apollo/wiki/Quick-Start
分布式部署指南(生产环境建议使用)https://github.com/ctripcorp/apollo/wiki/%E5%88%86%E5%B8%83%E5%BC%8F%E9%83%A8%E7%BD%B2%E6%8C%87%E5%8D%97
关注程序员小强公众号更多编程趣事,知识心得与您分享
SpringBoot整合Apollo配置中心快速使用相关推荐
- 一文搞定:SpringBoot 集成 Apollo 配置中心
公众号后台回复"面试",获取精品学习资料 扫描下方海报了解专栏详情 本文来源: http://www.mydlq.club/article/42/ <Java工程师面试突击( ...
- SpringBoot 集成 Apollo 配置中心
目录[-] 目录 一.Kubernetes 部署配置中心 Apollo 二.SpringBoot 集成 Apollo 配置中心 系统环境 SpringBoot 版本:2.1.8.RELEASE Apo ...
- 记录spring、springboot集成apollo配置中心
一, spring集成apollo,前提是apollo配置中心服务端已经在运行中 上面是我在阿里云服务搭建的apollo配置中心服务端,登录后的样子.没有搭建服务端的小伙伴,请先搭建好apollo的服 ...
- 一文搞定,SpringBoot 集成 Apollo 配置中心
原文: http://www.mydlq.club/article/42/ 1.背景 随着程序功能的日益复杂,程序的配置日益增多,各种功能的开关.参数的配置.服务器的地址--对程序配置的期望值也越来 ...
- Java项目集成apollo,SpringBoot集成Apollo配置中心
准备工作 本文假设读者已经在本地部署Apollo配置中心,如还未部署可参考之前的文章 <Docker部署Apollo配置中心> 文章将引导在Docker中运行Apollo配置中心.在开始使 ...
- Springboot整合Nacos配置中心
前提 安装了Nacos服务端并登陆到其控制台页面. 创建一个Springboot工程. Nacos配置:(相关概念后面说明): 创建一个命名空间,当然,也有默认的命名空间. 创建配置文件: 整合 第一 ...
- Spring Boot 整合携程Apollo 配置中心
作者:AaronSimon blog.csdn.net/AaronSimon/article/details/83657612 Apollo(阿波罗)是携程框架部门研发的分布式配置中心,能够集中化管理 ...
- Apollo配置中心介绍,多环境,分布式等
参考: Apollo Apollo 玩转apollo配置中心--通过源码进行多env环境搭建 - swing·wang - 博客园 一.Apollo(配置中心) Apollo(阿波罗)是携程框架部门研 ...
- Apollo架构体系、Apollo运行原理、Apollo配置中心简单介绍(一)
笔者在工作中遇到如下问题,随着程序功能越多,配置文件不断增加,一些功能的开关.服务器地址.接口地址.不同环境的一些配置文件不同,这些在每次发布不同环境.更新项目时都比较繁琐,后来学习微服务时接触到了S ...
最新文章
- svn的安装以及post-commit实时更新网站
- HDU_1072_Nightmare题解
- Java 编程的动态性, 第4部分: 用 Javassist 进行类转换--转载
- vue2.0路由之编程式导航
- 小明分享|ESP32-C3到底有哪些不一样的功能呢
- 二叉搜索树的最小绝对差
- 【easy】234. Palindrome Linked List
- android 两个imageview重叠,android-在现有ListVIew中添加更多项目时,ImageView重叠
- 分享一些很不错的学习资源网站
- 实验1 java程序基础_《Java程序设计》实验1
- ASP.NET中的图片缓存
- GIT在WINDOWS/LINUX下载的源码,回车换行有差异
- EmmyLua Unity断点调试
- 字体如何设计,这几点很重要
- mysql分页查询如何优化_mysql分页查询优化
- mysql查询范围数据_MySQL通过POIN数据类型查询指定范围内数据
- 三级缓存 SD—内存—网络
- Wed Aug 03 19:48:03 +0800 2022这种字符串,怎么转成时间格式年月日
- Domain Impression A Source Data Free Domain Adaptation Method
- 基于MAC地址划分VLAN