快速学习-Apollo从入门到精通

Config config = ConfigService.getAppConfig();
Integer defaultRequestTimeout = 200;
Integer requestTimeout = config.getIntProperty("requestTimeout", defaultRequestTimeout);

3.6 客户端监听配置变化

通过上述获取配置代码，应用就能实时获取到最新的配置了。

不过在某些场景下，应用还需要在配置变化时获得通知，比如数据库连接的切换等，所以Apollo还提供了监听配置变化的功能，Java示例如下：

Config config = ConfigService.getAppConfig();
config.addChangeListener(new ConfigChangeListener() {
  @Override
  public void onChange(ConfigChangeEvent changeEvent) {
    for (String key : changeEvent.changedKeys()) {
      ConfigChange change = changeEvent.getChange(key);
      System.out.println(String.format(
        "Found change - key: %s, oldValue: %s, newValue: %s, changeType: %s",
        change.getPropertyName(), change.getOldValue(),
        change.getNewValue(), change.getChangeType()));
     }
  }
});

3.7 Spring集成样例

Apollo和Spring也可以很方便地集成，只需要标注@EnableApolloConfig后就可以通过@Value获取配置信息：

@Configuration
@EnableApolloConfig
public class AppConfig {}
@Component
public class SomeBean {
    //timeout的值会自动更新
    @Value("${request.timeout:200}")
    private int timeout;
}

4. 客户端集成Apollo

4.1 开发环境

4.1.1 java

Apollo服务端：1.8+
Apollo客户端：1.7+

由于Quick Start会在本地同时启动服务端和客户端，所以需要在本地安装Java 1.8+。

在配置好后，可以通过如下命令检查：

java -version
样例输出：

java version "1.8.0_74"
Java(TM) SE Runtime Environment (build 1.8.0_74-b02)
Java HotSpot(TM) 64-Bit Server VM (build 25.74-b02, mixed mode)
Windows用户请确保JAVA_HOME环境变量已经设置。

4.1.2 mysql

版本要求：5.6.5+

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

连接上MySQL后，可以通过如下命令检查：

SHOW VARIABLES WHERE Variable_name = 'version';

4.1.3 下载Quick Start安装包

我们准备好了一个Quick Start安装包，大家只需要下载到本地，就可以直接使用，免去了编译、打包过程。

由于百度网盘限制, 故无法提供网盘地址.

apollo-build-scripts项目启动后会产生多余日志文件, 所以建议不要放在脚手架模块中进行调试

从Github下载

checkout或下载apollo-build-scripts 项目
由于Quick Start项目比较大，所以放在了另外的repository，请注意项目地址

$ git clone https://github.com/nobodyiam/apollo-build-scripts.git

Quick Start只针对本地测试使用，所以一般用户不需要自己下载源码打包，只需要下载已经打好的包即可。不过也有部分用户希望在修改代码后重新打包，那么可以参考如下步骤：

修改apollo-configservice, apollo-adminservice和apollo-portal的pom.xml，注释掉spring-boot-maven-plugin和maven-assembly-plugin

在根目录下执行mvn clean package -pl apollo-assembly -am -DskipTests=true

复制apollo-assembly/target下的jar包，rename为apollo-all-in-one.jar

4.2 安装部署

4.2.1 创建数据库

备注:本地测试请按照4.1.3中下载完apollo-build-scripts项目再进行如下操作

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

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

执行以下sql导入sql执行脚本：

source /your_local_path/sql/apolloportaldb.sql

source /your_local_path/sql/apolloconfigdb.sql

4.2.2 配置数据库链接

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

注意：填入的用户需要具备对ApolloPortalDB和ApolloConfigDB数据的读写权限。

#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.2.3 启动Apollo

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

例如，在Linux/Mac下，可以通过如下命令检查：

lsof -i:8080 查看8080端口是否被占用

netstart -tunlp|grep 8080 查看8080端口是否被占用

ps aux|grep apollo 查看Apollo进程是否运行

执行脚本:

./demo.sh start  开启服务端运行（start services and portal）
./demo.sh stop   停止服务端运行（stop services and portal）
./demo.sh client 开启客户端运行（start client demo program）

输出如下内容，说明启动成功：

==== starting service ====
Service logging file is ./service/apollo-service.log
Started [10768]
Waiting for config service startup.......
Config service started. You may visit http://localhost:8080 for service status now!
Waiting for admin service startup....
Admin service started
==== starting portal ====
Portal logging file is ./portal/apollo-portal.log
Started [10846]
Waiting for portal startup......
Portal started. You can visit http://localhost:8070 now!

4.3 使用Apollo配置中心

4.3.1 服务器端搭建

访问http://localhost:8070

快速学习-Apollo从入门到精通_apollo_05

默认用户名密码apollo/admin,如需修改参考Portal 实现用户登录功能

如果提示系统出错，请重试或联系系统负责人，请稍后几秒钟重试一下，因为通过Eureka注册的服务有一个刷新的延时。

新建一个配置中心:

快速学习-Apollo从入门到精通_客户端_06

新增配置：

快速学习-Apollo从入门到精通_客户端_07

注：可以通过文本的方式一次添加多个配置

4.3.2 客户端搭建基于SpringBoot

1.引入maven依赖

<!-- 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.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>
        </dependency>

2.项目结构为：

快速学习-Apollo从入门到精通_apollo_08

app.properties

app.id=创建新项目时填写的appid
apollo.meta=需要连接的apollo的内置ereuka地址 如果是本机请使用 http://localhost:8080

apollo-env.properties

local.meta=需要连接的apollo地址 如果是本机 请使用 http://localhost:8070 
dev.meta=需要连接的apollo地址 如果是本机 请使用 http://localhost:8070 
fat.meta=${fat_meta}
uat.meta=${uat_meta}
lpt.meta=${lpt_meta}
pro.meta=${pro_meta}

application.yml

# 端口
server:
  port: 9000
# spring配置
spring:
  application:
    name: apollo-demo
eureka:
  client:
    fetch-registry: false
    service-url:
      defaultZone: 需要连接的apollo的内置ereuka地址 如果是本机请使用 http://localhost:8080

Controller层实现：

@RestController
@RequestMapping("apollo")
public class ApolloController {

    @Value("${name:无法读取到值}")
    private String name;

    @Value("${age:0}")
    private Long age;

    @RequestMapping("/getname")
    public String getName() {
        return name + "的年龄" + age;
    }
}

项目启动类代码类实现：

@Configuration
@SpringBootApplication
@EnableApolloConfig
public class ApollodemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(ApollodemoApplication.class, args);
    }

}

访问 http://localhost:9000/apollo/getname

快速学习-Apollo从入门到精通_客户端_09

修改name值后，重新访问，实时动态更新

快速学习-Apollo从入门到精通_apollo_10

刷新页面重新访问：

快速学习-Apollo从入门到精通_java_11

这样便完成了动态配置

4.4 使用Apollo灰度发布

4.4.1 准备两台服务器

集群节点	端口
192.168.80.128	9000
192.168.80.135	9000

访问http://192.168.80.128:9000/apollo/getname

快速学习-Apollo从入门到精通_apollo_12

访问http://192.168.80.135:9000/apollo/getname

快速学习-Apollo从入门到精通_spring_13

5. 常见问题

问题一：只在Maven中导入了client依赖

Exception in thread "main" java.lang.NoClassDefFoundError: Could not initialize class com.ctrip.framework.apollo.tracer.Tracer
      at com.ctrip.framework.apollo.build.ApolloInjector.getInstance(ApolloInjector.java:37)
      at com.ctrip.framework.apollo.ConfigService.getManager(ConfigService.java:25)
      at com.ctrip.framework.apollo.ConfigService.getConfig(ConfigService.java:61)

解决办法：

导入同版本的apollo-core依赖

问题二：eureka解析为内网地址

Sync config failed, will retry. Repository class com.ctrip.framework.apollo.internals.RemoteConfigRepository, 
reason: Load Apollo Config failed - appId: bitongchong_bos, cluster: default, namespace: application, 
url: http://此处是私有ip:8080/configs/bitongchong_bos/default/application?ip=192.168.102.1&messages=%7B%22details%22%3A%7B%22bitongchong_bos%2Bdefault%2Bapplication%22%3A6%7D%7D&releaseKey=20190803112627-2b5dd0e414976d16 
[Cause: Could not complete get operation [Cause: connect timed out]]

解决办法：

项目启动时指定启动参数：

-Deureka.instance.ip-address=公网地址

修改Apollo启动脚本：

-Deureka.instance.ip-address=114.55.34.44"

快速学习-Apollo从入门到精通_spring_14

快速学习-Apollo从入门到精通_apollo_15

问题三：未对apollo.meta 属性进行正确赋值

2020-03-04 01:34:28.169  WARN 21840 --- [           main] c.c.f.a.i.AbstractConfigRepository       : Sync config failed, will retry. Repository class com.ctrip.framework.apollo.internals.RemoteConfigRepository, reason: Get config services failed from http://xx.xx.xx.xx:8070/services/config?appId=SPOC_Platform&ip=192.168.102.1 [Cause: Could not complete get operation [Cause: java.lang.IllegalStateException: Expected BEGIN_ARRAY but was STRING at line 1 column 1 path $ [Cause: Expected BEGIN_ARRAY but was STRING at line 1 column 1 path $]]]
2020-03-04 01:34:30.511  WARN 21840 --- [           main] c.c.f.a.i.LocalFileConfigRepository      : Sync config from upstream repository class com.ctrip.framework.apollo.internals.RemoteConfigRepository failed, reason: Get config services failed from http://xx.xx.xx.xx:8070/services/config?appId=SPOC_Platform&ip=192.168.102.1 [Cause: Could not complete get operation [Cause: java.lang.IllegalStateException: Expected BEGIN_ARRAY but was STRING at line 1 column 1 path $ [Cause: Expected BEGIN_ARRAY but was STRING at line 1 column 1 path $]]]

解决办法：

这个是未对apollo.meta 属性进行正确赋值，必须是eureka的地址和端口，就是你输入这个url+端口的时候跳转到的是eureka这个界面，而非apollo管理页面，否则必定报错

-Dapollo.meta=http://ip:8080 -Denv=dev

问题四：自带ereuka的心跳机制

解决办法:

在配置文件中加上fetch-registry: false 让ereuka不要反复的去注册自己

快速学习-Apollo从入门到精通_java_17

6. Apollo相比于Spring Cloud Config有什么优势?

功能点	Apollo	Spring Cloud Config	备注
配置界面	一个界面管理不同环境、不同集群配置	无，需要通过git操作
配置生效时间	实时	重启生效，或手动refresh生效	Spring Cloud Config需要通过Git webhook，加上额外的消息队列才能支持实时生效
版本管理	界面上直接提供发布历史和回滚按钮	无，需要通过git操作
灰度发布	支持	不支持
授权、审核、审计	界面上直接支持，而且支持修改、发布权限分离	需要通过git仓库设置，且不支持修改、发布权限分离
实例配置监控	可以方便的看到当前哪些客户端在使用哪些配置	不支持
配置获取性能	快，通过数据库访问，还有缓存支持	较慢，需要从git clone repository，然后从文件系统读取
客户端支持	原生支持所有Java和.Net应用，提供API支持其它语言应用，同时也支持Spring annotation获取配置	支持Spring应用，提供annotation获取配置	Apollo的适用范围更广一些