文章首發于微信公眾號《程序員果果》
地址:https://mp.weixin.qq.com/s/8UR13rTY2elAGedfFC8EiQ
本篇源碼:https://github.com/gf-huanchupk/SpringBootLearning
簡介
Apollo(阿波羅)是攜程框架部門研發的分布式配置中心,能夠集中化管理應用不同環境、不同集群的配置,配置修改后能夠實時推送到應用端,并且具備規范的權限、流程治理等特性,適用于微服務配置管理場景。
Apollo和Spring Cloud Config對比
通過對比,可以看出,生成環境中 Apollo 相比 Spring Cloud Config 更具有優勢一些。
安裝 Apollo 配置中心
搭建教程
參照 https://github.com/ctripcorp/apollo/wiki/Quick-Start 搭建 Apollo 配置中心,文檔寫的很清楚,這里就贅述了。
查看樣例配置
搭建完成并啟動后,訪問 http://localhost:8070 ,界面如下。
輸入用戶名 apollo,密碼 admin 后登錄后,點擊SampleApp進入配置界面。
與 Spring Boot 整合使用
創建一個springboot項目,主要代碼如下。
pom.xml
添加 Apollo 客戶端的依賴,為了編碼方便引入commons-lang3。
<dependency>
<groupId>com.ctrip.framework.apollo</groupId>
<artifactId>apollo-client</artifactId>
<version>1.3.0</version>
</dependency>
<!-- 為了編碼方便,并非apollo 必須的依賴 -->
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-lang3</artifactId>
<version>3.8.1</version>
</dependency>
application.yml
server:
port: 8761
app:
id: springboot-apollo
apollo:
meta: http://127.0.0.1:8080
bootstrap:
enabled: true
eagerLoad:
enabled: true
logging:
level:
com:
gf:
controller: debug
配置說明:
- app.id:AppId是應用的身份信息,是配置中心獲取配置的一個重要信息。
- apollo.bootstrap.enabled:在應用啟動階段,向Spring容器注入被托管的application.properties文件的配置信息。
- apollo.bootstrap.eagerLoad.enabled:將Apollo配置加載提到初始化日志系統之前。
- logging.level.com.gf.controller:調整 controller 包的 log 級別,為了后面演示在配置中心動態配置日志級別。
HelloController
@RestController
public class HelloController {
private static Logger logger = LoggerFactory.getLogger( HelloController.class );
@Value( "${server.port}" )
String port;
@GetMapping("hi")
public String hi(String name) {
logger.debug( "debug log..." );
logger.info( "info log..." );
logger.warn( "warn log..." );
return "hi " + name + " ,i am from port:" + port;
}
}
啟動類
@SpringBootApplication
@EnableApolloConfig
public class SpringbootApolloApplication {
public static void main(String[] args) {
SpringApplication.run( SpringbootApolloApplication.class, args );
}
}
啟動項目。現在需要去配置中心做些關于這個springboot客戶端的一些配置。
配置中心的配置
創建項目
第一步:訪問http://localhost:8070 登錄后,選擇創建項目。
第二步:填寫配置信息。
配置說明:
- 部門:選擇應用所在的部門。(想自定義部門,參照官方文檔,這里就選擇樣例)
- 應用AppId:用來標識應用身份的唯一id,格式為string,需要和客戶端。application.properties中配置的app.id對應。
- 應用名稱:應用名,僅用于界面展示。
- 應用負責人:選擇的人默認會成為該項目的管理員,具備項目權限管理、集群創建、Namespace創建等權限。
提交配置后會出現如下項目配置的管理頁面。
添加配置項
第一步:點擊 “新增配置”,配置需要管理的 application.properties 中的屬性。
點擊提交,之后按照同樣的方法,新增需要動態管理的 application.properties 中的屬性。
提交后,跳轉到配置的管理界面:
發布配置
配置只有在發布后才會真的被應用使用到,所以在編輯完配置后,需要發布配置。點擊“發布按鈕”。
填寫發布相關信息,點擊發布 。
測試
在配置中心,修改 server.port 的值為 8762 并發布。
Postman 訪問之前寫個測試接口 http://127.0.0.1:8761/hi?name=zhangsan ,返回如下。
說明 客戶端 獲取到了 配置中心修改后的 server.port 的值 。
注意:
- 服務的端口依然還是 8761,這是因為 apollo 修改配置,不會像Spring Cloud Config 那樣去重啟應用。
- 重啟應用后,客戶端會加載使用 配置中心中配置的屬性的值,例如我們重啟我們的應用,服務端口會變成8762。
監聽配置的變化
需求
日志模塊是每個項目中必須的,用來記錄程序運行中的相關信息。一般在開發環境下使用DEBUG級別的日志輸出,為了方便查看問題,而在線上一般都使用INFO或者ERROR級別的日志,主要記錄業務操作或者錯誤的日志。那么問題來了,當線上環境出現問題希望輸出DEBUG日志信息輔助排查的時候怎么辦呢?修改配置文件,重新打包然后上傳重啟線上環境,以前確實是這么做的。
雖然上面我們已經把日志的配置部署到Apollo配置中心,但在配置中心修改日志等級,依然需要重啟應用才生效,下面我們就通過監聽配置的變化,來達到熱更新的效果。
@Configuration
public class LoggerConfig {
private static final Logger logger = LoggerFactory.getLogger(LoggerConfig.class);
private static final String LOGGER_TAG = "logging.level.";
@Autowired
private LoggingSystem loggingSystem;
@ApolloConfig
private Config config;
@ApolloConfigChangeListener
private void configChangeListter(ConfigChangeEvent changeEvent) {
refreshLoggingLevels();
}
@PostConstruct
private void refreshLoggingLevels() {
Set<String> keyNames = config.getPropertyNames();
for (String key : keyNames) {
if (StringUtils.containsIgnoreCase(key, LOGGER_TAG)) {
String strLevel = config.getProperty(key, "info");
LogLevel level = LogLevel.valueOf(strLevel.toUpperCase());
loggingSystem.setLogLevel(key.replace(LOGGER_TAG, ""), level);
logger.info("{}:{}", key, strLevel);
}
}
}
}
關鍵點講解:
- @ApolloConfig注解:將Apollo服務端的中的配置注入這個類中。
- @ApolloConfigChangeListener注解:監聽配置中心配置的更新事件,若該事件發生,則調用refreshLoggingLevels方法,處理該事件。
- ConfigChangeEvent參數:可以獲取被修改配置項的key集合,以及被修改配置項的新值、舊值和修改類型等信息。
application.yml 中配置的日志級別是 debug ,訪問http://127.0.0.1:8761/hi?name=zhangsan ,控制臺打印如下。
2019-03-05 18:29:22.673 DEBUG 4264 --- [nio-8762-exec-1] com.gf.controller.HelloController : debug log...
2019-03-05 18:29:22.673 INFO 4264 --- [nio-8762-exec-1] com.gf.controller.HelloController : info log...
2019-03-05 18:29:22.673 WARN 4264 --- [nio-8762-exec-1] com.gf.controller.HelloController : warn log...
現在在配置中心修改日志級別為 warn。
再次訪問http://127.0.0.1:8761/hi?name=zhangsan ,控制臺打印如下。
2019-03-05 19:07:19.469 WARN 4264 --- [nio-8762-exec-3] com.gf.controller.HelloController : warn log...
說明日志級別的配置,已經支持熱更新了。關于apollo 的更多應用 ,可以參照github的文檔。
源碼下載 : https://github.com/gf-huanchupk/SpringBootLearning/tree/master/springboot-apollo