Apollo配置中心


Apollo簡介:

  Apollo (阿波羅)是攜程框架部門研發的分布式配置中心,能夠集中化管理應用的不同環境、不同集群的配置,配置修改后能夠實時推送到應用端,並且具備規范的權限、流程治理等特性,適用於微服務配置管理場景。

  Apollo包括服務端和客戶端兩部分:

    服務端基於Spring Boot和Spring Cloud開發,打包后可以直接運行,不需要額外安裝Tomcat等應用容器。

    Java客戶端不依賴任何框架,能夠運行於所有Java運行時環境,同時對Spring/Spring Boot環境也有較好的支持。

Apollo特性:

  1.統一管理不同環境、不同集群的配置

    Apollo 提供了一個統一界面集中式管理不同環境(environment)、不同集群(cluster)、不同命名空間(namespace)的配置。

    同一份代碼部署在不同的集群,可以有不同的配置,比如 zookeeper 的地址等

    通過命名空間( namespace)可以很方便地支持多個不同應用共享同一份配置,同時還允許應用對共享的配置進行覆蓋

  2.配置修改實時生效(熱發布)

    用戶在 Apollo修改完配置並發布后,客戶端能實時(1秒)接收到最新的配置,並通知到應用程序

  3.版本發布管理

    所有的配置發布都有版本概念,從而可以方便地支持配置的回滾

  4.灰度發布

    支持配置的灰度發布,比如點了發布后,只對部分應用實例生效,等觀察一段時間沒問題后再推給所有應用實例

  5.權限管理、發布審核、操作審計

    應用和配置的管理都有完善的權限管理機制,對配置的管理還分為了編輯和發布兩個環節,從而減少人為的錯誤。

    所有的操作都有審計日志,可以方便地追蹤問題

  6.客戶端配置信息監控

    可以在界面上方便地看到配置在被哪些實例使用

  7.提供 Java和.Net原生客戶端

    提供了 Java和.Net的原生客戶端,方便應用集成

    支持 Spring Placeholder, Annotation和Spring Boot的ConfigurationProperties,方便應用使用(需要Spring 3.1.1+)

    同時提供了 Http接口,非Java和.Net應用也可以方便地使用

  8.提供開放平台 API

    Apollo 自身提供了比較完善的統一配置管理界面,支持多環境、多數據中心配置管理、權限、流程治理等特性。不過Apollo出於通用性考慮,不會對配置的修改做過多限制,只要符合基本的格式就能保存,不會針對不同的配置值進行針對性的校驗,如數據庫用戶名、密碼,Redis服務地址等

    對於這類應用配置, Apollo支持應用方通過開放平台API在Apollo進行配置的修改和發布,並且具備完善的授權和權限控制

Apollo 快速入門:

  執行流程:

    

     操作流程如下:

      1、在Apollo配置中心修改配置

      2、應用程序通過Apollo客戶端從配置中心拉取配置信息
      用戶通過Apollo配置中心修改或發布配置后,會有兩種機制來保證應用程序來獲取最新配置:一種是Apollo配置中心會向客戶端推送最新的配置;另外一種是Apollo客戶端會定時從Apollo配置中心拉取最新的配置,通過以上兩種機制共同來保證應用程序能及時獲取到配置。

  安裝Apollo:

    運行時環境:

      Apollo 服務端:JDK1.8+  Apollo 客戶端:JDK1.7+

      MySQL版本要求: 5.6.5+  Apollo的表結構對 timestamp 使用了多個default聲明,所以需要5.6.5以上版本。

    下載配置:https://github.com/ctripcorp/apollo/tags

      

     創建數據庫:

      Apollo服務端共需要兩個數據庫: ApolloPortalDB 和 ApolloConfigDB ,ApolloPortalDB只需要在生產環境部署一個即可,而ApolloConfigDB需要在每個環境部署一套。

      1. 創建ApolloPortalDB,sql腳本下載地址:https://github.com/ctripcorp/apollo/blob/v1.3.0/scripts/db/migration/configdb/V1.0.0__initialization.sql

      2. 創建ApolloConfigDB,sql腳本下載地址:https://github.com/ctripcorp/apollo/blob/v1.3.0/scripts/db/migration/configdb/V1.0.0__initialization.sql

     啟動Apollo:

      1. 確保端口未被占用

        Apollo默認會啟動3個服務,分別使用8070, 8080, 8090端口,請確保這3個端口當前沒有被使用

      2. 啟動apollo-configservice,在apollo目錄下執行如下命令,可通過-Dserver.port=8080修改默認端口

java -Dserver.port=8080 -Xms256m -Xmx256m -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-configservice-1.3.0.jar

      3. 啟動apollo-adminservice

java -Dserver.port=8090 -Xms256m -Xmx256m -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-adminservice-1.3.0.jar

      4. 啟動apollo-portal

java -Dserver.port=8070 -Xms256m -Xmx256m -Ddev_meta=http://localhost:9090/ -Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8 -Dspring.datasource.username=root -Dspring.datasource.password=root -jar apollo-portal-1.3.0.jar

      5. 也可以使用提供的runApollo.bat快速啟動三個服務(需要先編輯修改數據庫連接地址,數據庫以及密碼)

      6.待啟動成功后,訪問 http://localhost:9092/ 默認登錄賬號密碼 apollo/admin 

  代碼實現:

    1.發布配置

      新建項目:apollo-quickstart

        

       新增配置:新增配置后還要發布,才能被應用程序讀取到

        

     2.應用讀取配置

      新建Maven工程,添加apollo依賴:

    <dependencies>
        <dependency>
            <groupId>com.ctrip.framework.apollo</groupId>
            <artifactId>apollo‐client</artifactId>
            <version>1.1.0</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>slf4j-simple</artifactId>
            <version>1.7.27</version>
        </dependency>
    </dependencies>

      編寫測試類GetConfigTest,讀取sms.enable的值:

public class GetConfigTest {
    public static void main(String[] args) {
        Config config = ConfigService.getAppConfig();
        // Config config = ConfigService.getConfig("namespace");
        String key = "sms.enable";
        String value = config.getProperty(key, null); // 第二個參數表示取不到值則采用默認值
        System.out.println(value);
    }
}

      測試:需要配置VM options,設置系統屬性

        -Dapp.id=apollo-quickstart -Denv=DEV -Ddev_meta=http://localhost:8080

      如果需要讀取配置中心集群中的配置:

         

Apollo 應用:

  核心概念:

    1. application (應用)
      實際使用配置的應用,Apollo客戶端在運行時需要知道當前應用是誰,從而可以去獲取對應的配置
      關鍵字:appId
    2. environment (環境)
      配置對應的環境,Apollo客戶端在運行時需要知道當前應用處於哪個環境,從而可以去獲取應用的配置
      關鍵字:env
    3. cluster (集群)
      一個應用下不同實例的分組,比如典型的可以按照數據中心分,把上海機房的應用實例分為一個集群,把北京機房的應用實例分為另一個集群。
      關鍵字:cluster
    4. namespace (命名空間)
      一個應用下不同配置的分組,可以簡單地把namespace類比為文件,不同類型的配置存放在不同的文件中,如數據庫配置文件,RPC配置文件,應用自身的配置文件等
      關鍵字:namespaces

    

Apollo 應用於分布式系統:

  1.Spring Boot應用集成

    創建工程,引入依賴:

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.3.RELEASE</version>
        <relativePath/>
    </parent>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>
        <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.3.0</version>
        </dependency>
    </dependencies>

    application.properties配置文件:

#這項也可以交給配置中心管理,下面的三項不可以
server.port = 63000

app.id = account-service
apollo.bootstrap.enabled = true
apollo.bootstrap.namespaces = application,micro_service

    apollo控制台創建對應上面配置文件的項目,以及添加配置文件:

      

       

    Apollo Meta Server:

      Apollo支持應用在不同的環境有不同的配置,常用的指定方式有如下兩種:

        第一種:通過 Java System Property的apollo.meta: -D環境.meta=http://localhost:8080  根據不同環境可以指定多個

        第二種:在 resources目錄下新建apollo-env.properties文件

dev.meta = http://localhost:8080
pro.meta = http://localhost:8081

        第三種:在Spring Boot的application.propertiesbootstrap.properties中指定apollo.meta=http://config-service-url

    本地緩存路徑:

      Apollo客戶端會把從服務端獲取到的配置在本地文件系統緩存一份,用於在遇到服務不可用,或網絡不通的時候,依然能從本地恢復配置,不影響應用正常運行。本地配置文件會以下面的文件名格式放置於配置的本地緩存路徑下:{appId}+{cluster}+{namespace}.properties

      1.可以通過如下方式指定緩存路徑,通過Java System Property的apollo.cacheDir:

        ‐Dapollo.cacheDir=d:/apollo‐config

      2.通過Spring Boot的配置文件

        可以在Spring Boot的application.propertiesbootstrap.properties中指定apollo.cache-dir=/opt/data/some-cache-dir(1.9.0+) 或者 apollo.cacheDir=/opt/data/some-cache-dir(1.9.0之前)

    Environment:

      通過Java System Property的env來指定環境: - Denv=DEV

      此參數決定了 Apollo Meta Server 使用哪個配置中心

    Cluster(集群):

      1.通過Java System Property的apollo.cluste來指定集群: - Dapollo.cluster=DEFAULT

      2.通過Spring Boot的配置文件

        可以在Spring Boot的application.propertiesbootstrap.properties中指定apollo.cluster=SomeCluster

    控制層讀取apollo中的配置:

@RestController
public class AccountController {

    @Value("${sms.enable}")
    private Boolean smsEnable;

    @GetMapping("/sms")
    public String getSmsConfig() {
        return "smsEnable: " + smsEnable;
    }

    @GetMapping("/timeout")
    public Long getTimeout(@Value("${timeout}") Long timeout) {
        return timeout;
    }
}

    啟動類:啟動類需要添加 @EnableApolloConfig 注解

@SpringBootApplication
@EnableApolloConfig
public class AccountApplication {
    public static void main(String[] args) {
        SpringApplication.run(AccountApplication.class, args);
    }
}

    啟動訪問 http://localhost:63000/sms  http://localhost:63000/timeout 響應成功

生產環境部署:

  在企業中常用的部署方案為:Apollo-adminservice和Apollo-configservice兩個服務分別在線上環境(pro),仿真環境(uat)和開發環境(dev)各部署一套,Apollo-portal作為管理端只部署一套,統一管理上述三套環境。

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM