微服务的开源配置中心Apollo

  • 一、Apollo(阿波罗)概述
  • 二、Apollo的实现方式
  • 三、搭建Apollo服务端
  • 1、环境要求
  • 2、 环境搭建
  • (1)下载Apollo
  • (2)配置数据库
  • (3)配置数据库连接
  • (4)启动
  • (5)测试
  • 四、客户端集成
  • 1、创建工程并引入依赖
  • 2、创建模块
  • 3、模块当中引入依赖
  • 4、完善其他功能模块
  • 5、Spring Boot集成
  • (1)设置application.yml
  • (2)重新启动运行测试
  • (3)新增配置


一、Apollo(阿波罗)概述

java获取apollo实时配置 java中apollo_spring cloud

Apollo(阿波罗)是携程框架部门研发的分布式配置中心,能够集中化管理应用不同环境、不同集群的配置,配置修改后能够实时推送到应用端,并且具备规范的权限、流程治理等特性,适用于微服务配置管理场景。

服务端基于Spring Boot和Spring Cloud开发,打包后可以直接运行,不需要额外安装Tomcat等应用容器。

正是基于配置的特殊性,
所以Apollo从设计之初就立志于成为一个有治理能力的配置发布平台,目前提供了以下的特性:

  • 统一管理不同环境、不同集群的配置
  • Apollo提供了一个统一界面集中式管理不同环境(environment)、不同集群(cluster) 不同命名空间(namespace)的配置。
  • 同一份代码部署在不同的集群,可以有不同的配置,比如zookeeper的地址等。
  • 通过命名空间(namespace)可以很方便地支持多个不同应用共享同一份配置,同时还允许应用对共享的配置进行覆盖。
  • 配置修改实时生效(热发布)
  • 用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序
  • 版本发布管理
  • 所有的配置发布都有版本概念,从而可以方便地支持配置的回滚
  • 灰度发布
  • 支持配置的灰度发布,比如点了发布后,只对部分应用实例生效,等观察一段时间没问题后再推给所有应用实例
  • 权限管理、发布审核、操作审计
  • 应用和配置的管理都有完善的权限管理机制,对配置的管理还分为了编辑和发布两个环节, 从而减少人为的错误。
  • 所有的操作都有审计日志,可以方便地追踪问题
  • 客户端配置信息监控
  • 可以在界面上方便地看到配置在被哪些实例使用
  • 提供Java和.Net原生客户端
  • 提供了Java和.Net的原生客户端,方便应用集成
  • 支持Spring Placeholder, Annotation和Spring Boot的ConfigurationProperties,方便应用
    使用(需要Spring 3.1.1+)
  • 同时提供了Http接口,非Java和.Net应用也可以方便地使用
  • 提供开放平台API
  • Apollo自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权
    限、流程治理等特性。不过Apollo出于通用性考虑,不会对配置的修改做过多限制,只要符
    合基本的格式就能保存,不会针对不同的配置值进行针对性的校验,如数据库用户名、密
    码,Redis服务地址等
  • 对于这类应用配置,Apollo支持应用方通过开放平台API在Apollo进行配置的修改和发布,并且具备完善的授权和权限控制
  • 部署简单
  • 配置中心作为基础服务,可用性要求非常高,这就要求Apollo对外部依赖尽可能地少
  • 目前唯一的外部依赖是MySQL,所以部署非常简单,只要安装好Java和MySQL就可以让 Apollo跑起来
  • Apollo还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数

二、Apollo的实现方式

java获取apollo实时配置 java中apollo_java获取apollo实时配置_02


上图简要描述了Apollo客户端的实现原理:

  1. 客户端和服务端保持了一个长连接,从而能第一时间获得配置更新的推送。
  2. 定时拉去配置
  3. 客户端从Apollo配置中心服务端获取到应用的最新配置后,会保存在内存中。
  4. 客户端会把从服务端获取到的配置在本地文件系统缓存一份
    在遇到服务不可用,或网络不通的时候,依然能从本地恢复配置
  5. 应用程序从Apollo客户端获取最新的配置、订阅配置更新通知。

三、搭建Apollo服务端

1、环境要求

Java

  • Apollo服务端:1.8+
  • Apollo客户端:1.7+

由于需要同时运行服务端和客户端,所以建议安装Java 1.8+。

MySQL

  • 版本要求:5.6.5+

Apollo的表结构对 timestamp 使用了多个default声明,所以需要5.6.5以上版本

2、 环境搭建

(1)下载Apollo

通过官网提供的下载连接下载安装包,下载链接https://github.com/nobodyiam/apollo-build-scripts

java获取apollo实时配置 java中apollo_spring_03


下载后解压

java获取apollo实时配置 java中apollo_微服务_04

(2)配置数据库

Apollo服务端共需要两个数据库: ApolloPortalDB 和 ApolloConfigDB ,

进入上面的sql文件当中我们把数据库、表的创建和样例数据都分别准备了sql文件,只需要导入数据库即可。

java获取apollo实时配置 java中apollo_java获取apollo实时配置_05


创建数据库

运行上述的SQL文件即可创建好对应的数据库

java获取apollo实时配置 java中apollo_spring cloud_06

(3)配置数据库连接

Apollo服务端需要知道如何连接到你前面创建的数据库,所以需要编辑demo.sh,修改ApolloPortalDB和ApolloConfigDB相关的数据库连接串信息。

将下载好的apollo-build-scripts-master.zip上传到Linux服务器上

java获取apollo实时配置 java中apollo_java_07


解压上述的压缩包

[root@hecs-221767 Apollo]# unzip apollo-build-scripts-master.zip

解压成功

java获取apollo实时配置 java中apollo_spring cloud_08


进入到cd apollo-build-scripts-master

java获取apollo实时配置 java中apollo_java获取apollo实时配置_09


我们需要对demo.sh的内容进行修改

vim demo.hs

java获取apollo实时配置 java中apollo_微服务_10


对上述内容进行修改并保存

#apollo config db info
apollo_config_db_url=jdbc:mysql://localhost:3306/ApolloConfigDB?
characterEncoding=utf8
apollo_config_db_username=用户名
apollo_config_db_password=密码(如果没有密码,留空即可)
# apollo portal db info
apollo_portal_db_url=jdbc:mysql://localhost:3306/ApolloPortalDB?
characterEncoding=utf8
apollo_portal_db_username=用户名
apollo_portal_db_password=密码(如果没有密码,留空即可)

(4)启动

启动脚本会在本地启动3个服务,分别使用8070, 8080, 8090端口,请确保这3个端口当前没有被使用。

./demo.sh start

当看到如下输出后,就说明启动成功了!

java获取apollo实时配置 java中apollo_java获取apollo实时配置_11


开启上述对应的端口号并重启防火墙

firewall-cmd --zone=public --add-port=8070/tcp --permanent
firewall-cmd --zone=public --add-port=8080/tcp --permanent
firewall-cmd --zone=public --add-port=8090/tcp --permanent
firewall-cmd --reload

(5)测试

通过浏览器打开 http://ip:8070 即可访问Apollo配置中心的前端页面

java获取apollo实时配置 java中apollo_spring_12


输入默认用户名密码apollo/admin即可登录到应用中

java获取apollo实时配置 java中apollo_spring cloud_13


java获取apollo实时配置 java中apollo_微服务_14


java获取apollo实时配置 java中apollo_微服务_15


创建成功

java获取apollo实时配置 java中apollo_微服务_16

四、客户端集成

1、创建工程并引入依赖

因为在之前已经多次创建过类似的项目,所以不用重复创建

下面是这个代码的下载地址:

  • 创建工程

  • 引入依赖
<?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>cn.itbluebox</groupId>
    <artifactId>spring_apollo_demo</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.6.RELEASE</version>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-logging</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.4</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>



    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.1.0.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <repositories>
        <repository>
            <id>central</id>
            <url>http://maven.aliyun.com/nexus/content/groups/public/</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <name>Spring Snapshots</name>
            <url>http://repo.spring.io/libs-snapshot-local</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </pluginRepository>
        <pluginRepository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>http://repo.spring.io/libs-milestone-local</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
    </pluginRepositories>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2、创建模块

java获取apollo实时配置 java中apollo_java获取apollo实时配置_17


java获取apollo实时配置 java中apollo_java获取apollo实时配置_18

3、模块当中引入依赖

Apollo的客户端jar包已经上传到中央仓库,

应用在实际使用时只需要按照如下方式引入即可。

java获取apollo实时配置 java中apollo_spring_19

<?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">
    <parent>
        <artifactId>spring_apollo_demo</artifactId>
        <groupId>cn.itbluebox</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>product_service</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.32</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <!--apollo客户端依赖-->
        <dependency>
            <groupId>com.ctrip.framework.apollo</groupId>
            <artifactId>apollo-client</artifactId>
            <version>1.1.0</version>
        </dependency>
    </dependencies>
</project>

4、完善其他功能模块

因为在之前都做过这里直接复制使用之前product_service工程的代码即可
也可以下载我的代码:

最基本的查询功能

java获取apollo实时配置 java中apollo_spring_20


application.yml

java获取apollo实时配置 java中apollo_spring_21

server:
  port: 9001 #端口
spring:
  application:
    name: service-product #服务名称
  datasource:
    driver-class-name: com.mysql.jdbc.Driver
    url: jdbc:mysql://localhost:3306/springcloud?useUnicode=true&characterEncoding=utf8
    username: root
    password: root
  jpa:
    database: MySQL
    show-sql: true
    open-in-view: true
name: zhangsan

运行测试

java获取apollo实时配置 java中apollo_spring cloud_22


访问:http://localhost:9001/product/1

java获取apollo实时配置 java中apollo_spring_23

5、Spring Boot集成

Spring Boot支持通过application.properties/bootstrap.properties来配置,
该方式能使配置在更早的阶段注入,
比如使用 @ConditionalOnProperty 的场景或者是有一些spring-boot-starter在启动阶段就需要读取配置做一些事情(如dubbo-spring-boot-project),
所以对于Spring Boot环境建议通过以下方式来接入Apollo(需要0.10.0及以上版本)。

(1)设置application.yml

java获取apollo实时配置 java中apollo_java获取apollo实时配置_24

apollo:
  bootstrap:  #开启apollo ,既开启 nameSpace
    enabled: true
  meta: http://192.168.74.101:8080  #Linux  对应apollo的eureka的地址
app:
  id: product-service  #指定apollo配置中心中的appid,创建时候定义的id

(2)重新启动运行测试

设置启动参数

java获取apollo实时配置 java中apollo_spring_25


java获取apollo实时配置 java中apollo_spring cloud_26


java获取apollo实时配置 java中apollo_java获取apollo实时配置_27

访问:http://localhost:9001/product/test

java获取apollo实时配置 java中apollo_java获取apollo实时配置_28

(3)新增配置

java获取apollo实时配置 java中apollo_spring_29


java获取apollo实时配置 java中apollo_spring cloud_30


java获取apollo实时配置 java中apollo_微服务_31


java获取apollo实时配置 java中apollo_微服务_32


配置文件更新成功

java获取apollo实时配置 java中apollo_spring cloud_33