SpringBoot 整合 apollo

文章首發于微信公眾號《程序員果果》
地址: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

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,505評論 6 533
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,556評論 3 418
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,463評論 0 376
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,009評論 1 312
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,778評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,218評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,281評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,436評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,969評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,795評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,993評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,537評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,229評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,659評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,917評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,687評論 3 392
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,990評論 2 374

推薦閱讀更多精彩內容