Apollo分布式配置中心搭建

 

什么是分布式配置中心

项目中配置文件比较繁杂,而且不同环境的不同配置修改相对频繁,每次发布都需要对应修改配置,如果配置出现错误,需要重新打包发布,时间成本较高,因此需要做统一的分布式注册中心,能做到自动更新配置文件信息,解决以上问题

 

常用分布式配置中心框架

 

Disconf(依赖于zookpeer)、Zookpeer()、diamond、携程(阿波罗)、Redis、xxl-conf

 

Zookpeer保证配置文件信息实时更新 (事件通知)

 

大型互联网公司自己内部都有自己独立分布式配置中心

独立RPC、独立分布式各种解决方案

注册中心解决 rpc服务治理

分布式配置中心 解决分布式配置文件管理

Apollo阿波罗简介

 

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

Apollo阿波罗特点

用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序。

统一管理不同环境、不同集群的配置

 

所有的配置发布都有版本概念,从而可以方便的支持配置的回滚。

配置修改实时生效(热发布)

用户在Apollo修改完配置并发布后,客户端能实时(1秒)接收到最新的配置,并通知到应用程序

版本发布管理

所有的配置发布都有版本概念,从而可以方便的支持配置的回滚

灰度发布

支持配置的灰度发布,比如点了发布后,只对部分应用实例生效,等观察一段时间没问题后再推给所有应用实例。

权限管理、发布审核、操作审计

应用和配置的管理都有完善的权限管理机制,对配置的管理还分为了编辑和发布两个环节,从而减少人为的错误。

所有的操作都有审计日志,可以方便的追踪问题。

客户端配置信息监控

可以方便的看到配置在被哪些实例使用

提供Java和.Net原生客户端

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

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

同时提供了Http接口,非Java和.Net应用也可以方便的使用

提供开放平台API

Apollo自身提供了比较完善的统一配置管理界面,支持多环境、多数据中心配置管理、权限、流程治理等特性。

不过Apollo出于通用性考虑,对配置的修改不会做过多限制,只要符合基本的格式就能够保存。

在我们的调研中发现,对于有些使用方,它们的配置可能会有比较复杂的格式,如xml, json,需要对格式做校验。

还有一些使用方如DAL,不仅有特定的格式,而且对输入的值也需要进行校验后方可保存,如检查数据库、用户名和密码是否匹配。

对于这类应用,Apollo支持应用方通过开放接口在Apollo进行配置的修改和发布,并且具备完善的授权和权限控制

部署简单

配置中心作为基础服务,可用性要求非常高,这就要求Apollo对外部依赖尽可能地少

目前唯一的外部依赖是MySQL,所以部署非常简单,只要安装好Java和MySQL就可以让Apollo跑起来

Apollo还提供了打包脚本,一键就可以生成所有需要的安装包,并且支持自定义运行时参数

Apollo整体架构原理

apollo配置中心namespace Apollo配置中心客户端_分布式配置

Apollo(阿波罗)环境搭建

1.     环境要求:

首选虚拟机内存在2g 以上

一定提前安装好java1.8k环境

2.     搭建数据库 创建表

apollo-build-scripts-master 整个阿波罗环境包 使用一个命令启动整个阿波罗服务环境

apollo-master 阿波罗源码包

创建两个数据库

分别为:apolloconfigdb(存放配置文件信息)、apolloportaldb(门户网站)

 

建议数据库mysql在5.7以上,如果在低版本数据库执行阿波罗结构时,默认是不能支持在一个表中有两个时间戳类型字段,所以建议大家使用mysql在5.7以上。

 

yum -y install zip unzip

3.    

apollo-master 源码和依赖jar包(建议打到本地maven仓库中)

 

  1. 下载apollo-client 打入到本地Maven仓库中,右键项目使用maven  install进行打包成功之后生成一下依赖包:

apollo配置中心namespace Apollo配置中心客户端_spring_02

第二种方式通过执行build.bat进行打包,时间可能稍微较长,请耐心等待

apollo配置中心namespace Apollo配置中心客户端_spring_03

1.     部署

搭建Apollo配置中心

 下载aploll配置中心 https://github.com/nobodyiam/apollo-build-scripts

apollo配置中心namespace Apollo配置中心客户端_数据库_04

 下载好文件图

apollo配置中心namespace Apollo配置中心客户端_apollo配置中心namespace_05

 

如果数据库和JDK环境变量都安装好的情况下将apollo-build-scripts-master.zip拷贝到/usr/local 路径下,解压生成apollo-build-scripts-master文件夹,这里对路径没有强烈要求单纯是个人习惯。如下图:

 

apollo配置中心namespace Apollo配置中心客户端_分布式配置_06

配置数据库参数配置

创建数据库

Apollo服务端共需要两个数据库:ApolloPortalDB和ApolloConfigDB,我们把数据库、表的创建和样例数据都分别准备了sql文件,只需要导入数据库即可。

 

注意:如果你本地已经创建过Apollo数据库,请注意备份数据。我们准备的sql文件会清空Apollo相关的表。

 

配置数据库连接信息

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

 

注意:填入的用户需要具备对ApolloPortalDB和ApolloConfigDB数据的读写权限两个数据库

 

#!/bin/bash
 
# apollo config db info
#此配置是配置存放配置信息的数据库
apollo_config_db_url=jdbc:mysql://192.168.120.130:3306/ApolloConfigDB?characterEncoding=utf8
apollo_config_db_username=root
apollo_config_db_password=123456
 
# apollo portal db info
#此配置门户管理的表
apollo_portal_db_url=jdbc:mysql://192.168.120.130:3306/ApolloPortalDB?characterEncoding=utf8
apollo_portal_db_username=root
apollo_portal_db_password=123456
 
# =============== Please do not modify the following content =============== #
 
if [ "$(uname)" == "Darwin" ]; then
    windows="0"
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
    windows="0"
elif [ "$(expr substr $(uname -s) 1 5)" == "MINGW" ]; then
    windows="1"
else
    windows="0"
fi
 
# meta server url
#此配置是eureka服务地址
config_server_url=http://192.168.120.130:8080
admin_server_url=http://192.168.120.130:8090
eureka_service_url=$config_server_url/eureka/
#此服务是Apollo的门户访问地址
portal_url=http://192.168.120.130:8070

 

 

启动Apollo配置中心

确保端口未被占用

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

例如,在Linux/Mac下,可以通过如下命令检查:

 

执行启动脚本

./demo.sh start

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

apollo配置中心namespace Apollo配置中心客户端_spring_07

首先启动的是springcloud的注册中心其次是Apollo的web平台

使用Apollo配置中心

访问网址:打开http://localhost:8070

apollo配置中心namespace Apollo配置中心客户端_Apollo_08

 

输入用户名apollo,密码admin后登录

apollo配置中心namespace Apollo配置中心客户端_分布式配置_09

Apollo配置中心客户端集成

将apollo-master 打入到本地Maven仓库中

Maven依赖信息

 

<parent>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-parent</artifactId>
           <version>2.0.1.RELEASE</version>
           <relativePath /> <!-- lookup parent from repository -->
      </parent>
 
      <properties>
           <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
           <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
           <java.version>1.8</java.version>
           <spring-cloud.version>Finchley.RC1</spring-cloud.version>
      </properties>
      <dependencies>
           <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter</artifactId>
           </dependency>
           <dependency>
                 <groupId>org.springframework.cloud</groupId>
                 <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
           </dependency>
           <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter-web</artifactId>
                 <!-- <exclusions> <exclusion> <groupId>com.fasterxml.jackson.core</groupId>
                      <artifactId>jackson-databind</artifactId> </exclusion> </exclusions> -->
           </dependency>
 
           <!-- apollo 携程apollo配置中心框架 -->
           <dependency>
                 <groupId>com.ctrip.framework.apollo</groupId>
                 <artifactId>apollo-client</artifactId>
                 <version>1.0.0</version>
           </dependency>
           <dependency>
                 <groupId>com.ctrip.framework.apollo</groupId>
                 <artifactId>apollo-core</artifactId>
                 <version>1.0.0</version>
           </dependency>
 
           <dependency>
                 <groupId>org.projectlombok</groupId>
                 <artifactId>lombok</artifactId>
                 <optional>true</optional>
           </dependency>
           <dependency>
                 <groupId>com.alibaba</groupId>
                 <artifactId>fastjson</artifactId>
                 <version>1.2.3</version>
           </dependency>
           <dependency>
                 <groupId>org.springframework.boot</groupId>
                 <artifactId>spring-boot-starter-test</artifactId>
                 <scope>test</scope>
           </dependency>
      </dependencies>
 
      <dependencyManagement>
           <dependencies>
                 <dependency>
                      <groupId>org.springframework.cloud</groupId>
                      <artifactId>spring-cloud-dependencies</artifactId>
                      <version>${spring-cloud.version}</version>
                      <type>pom</type>
                      <scope>import</scope>
                 </dependency>
           </dependencies>
      </dependencyManagement>
 
      <build>
           <plugins>
                 <plugin>
                      <groupId>org.springframework.boot</groupId>
                      <artifactId>spring-boot-maven-plugin</artifactId>
                 </plugin>
                 <plugin>
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-compiler-plugin</artifactId>
                      <configuration>
                            <source>1.8</source>
                            <target>1.8</target>
                      </configuration>
                 </plugin>
                 <plugin>
                      <groupId>org.apache.maven.plugins</groupId>
                      <artifactId>maven-resources-plugin</artifactId>
                      <version>3.0.1</version>
                      <executions>
                            <execution>
                                  <id>copy-conf</id>
                                  <phase>package</phase>
                                  <goals>
                                       <goal>copy-resources</goal>
                                  </goals>
                                  <configuration>
                                       <encoding>UTF-8</encoding>
                                        <outputDirectory>${project.build.directory}/ext/conf</outputDirectory>
                                       <resources>
                                             <resource>
                                                  <directory>ext/conf</directory>
                                                  <includes>
                                                        <include>logback.xml</include>
                                                  </includes>
                                                  <filtering>true</filtering>
                                             </resource>
                                       </resources>
                                  </configuration>
                            </execution>
                      </executions>
                 </plugin>
                 <plugin>
                      <groupId>org.jacoco</groupId>
                      <artifactId>jacoco-maven-plugin</artifactId>
                      <version>0.7.5.201505241946</version>
                      <executions>
                            <execution>
                                  <id>default-prepare-agent</id>
                                  <goals>
                                       <goal>prepare-agent</goal>
                                  </goals>
                            </execution>
                            <execution>
                                  <id>default-prepare-agent-integration</id>
                                  <goals>
                                       <goal>prepare-agent-integration</goal>
                                  </goals>
                            </execution>
                      </executions>
                 </plugin>
                 <plugin>
                      <groupId>com.spotify</groupId>
                      <artifactId>docker-maven-plugin</artifactId>
                      <version>0.4.3</version>
                      <configuration>
                            <imageName>hy_uav_gateway</imageName>
                            <dockerDirectory>src/main/docker</dockerDirectory>
                            <resources>
                                  <resource>
                                       <targetPath>/</targetPath>
                                       <directory>${project.build.directory}</directory>
                                       <include>${project.build.finalName}.jar</include>
                                       <include>ext/conf/logback.xml</include>
                                  </resource>
                            </resources>
                      </configuration>
                 </plugin>
           </plugins>
      </build>
 
      <repositories>
           <repository>
                 <id>spring-milestones</id>
                 <name>Spring Milestones</name>
                 <url>https://repo.spring.io/milestone</url>
                 <snapshots>
                      <enabled>false</enabled>
                 </snapshots>
           </repository>
      </repositories>

 

application.yml配置文件信息

server:
  port: 8001
spring:
  application:
    name: springboot-abl
eureka:
  client:
    service-url:
      defaultZone: http://192.168.120.130:8080/eureka

 

修改环境

修改/opt/settings/server.properties(Mac/Linux)或C:\opt\settings\server.properties(Windows)文件,设置env为DEV:

env=DEV

创建apollo-env配置文件信息

apollo-env.properties

local.meta=http://192.168.212.162:8080
dev.meta=http://192.168.212.162:8080
fat.meta=${fat_meta}
uat.meta=${uat_meta}
lpt.meta=${lpt_meta}
pro.meta=${pro_meta}

 

IndexController

/**
 * @classDesc: 功能描述:()
 * @author: 郭德龙
 * @createTime:2018年11月11日
 * @version: v1.0
 * TODO
 */
@RestController
public class IndexController {
 
      @Value("${itmayiedu:test}")
      private String gdlsky;
 
      @RequestMapping("/getYushengjun")
      public String getYushengjun() {
           return gdlsky;
      }
}

 

Key配置的就是对应的值,如下图所示

apollo配置中心namespace Apollo配置中心客户端_数据库_10

 

App信息

在META-INF文件夹创建app.properties  指定appid

 

app.id=app_client_8750

apollo配置中心namespace Apollo配置中心客户端_Apollo_11

项目启动

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

 

监听服务器通知

使用以下方法可以监听配置文件是否被修改

@Component
public class TestJavaConfigBean {
 
      // config change listener for namespace application
      @ApolloConfigChangeListener("application")
      private void anotherOnChange(ConfigChangeEvent changeEvent) {
 
           ConfigChange change = changeEvent.getChange("zhangsan_conf");
           System.out.println(String.format("Found change - key: %s, oldValue: %s," + "newValue: %s, changeType: %s",
                      change.getPropertyName(), change.getOldValue(), change.getNewValue(), change.getChangeType()));
      }
 
}

 

数据库账号密码

 

数据库账号连接cdb-8y8qmojr.gz.tencentcdb.com:10010

root Ww861642669+

 

https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E8%AE%BE%E8%AE%A1

 

Apollo原理分析

 

参考地址:

https://github.com/ctripcorp/apollo/wiki/Apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83%E8%AE%BE%E8%AE%A1

项目目录结构:

apollo配置中心namespace Apollo配置中心客户端_数据库_12