Quick Start · ctripcorp/apollo Wiki · GitHub

为了让大家更快的上手了解Apollo配置中心，我们这里准备了一个Quick Start，能够在几分钟内在本地环境部署、启动Apollo配置中心。

考虑到Docker的便捷性，我们还提供了Quick Start的Docker版本，如果你对Docker比较熟悉的话，可以参考Apollo Quick Start Docker部署通过Docker快速部署Apollo。

不过这里需要注意的是，Quick Start只针对本地测试使用，如果要部署到生产环境，还请另行参考分布式部署指南。

注：Quick Start需要有bash环境，Windows用户请安装Git Bash，或者也可以直接通过IDE环境启动，详见Apollo开发指南。

[](#%E4%B8%80%E5%87%86%E5%A4%87%E5%B7%A5%E4%BD%9C)一、准备工作

[](#11-java)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环境变量已经设置。

[](#12-mysql)1.2 MySQL

  • 版本要求：5.6.5+

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

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

SHOW VARIABLES WHERE Variable_name = 'version';

Variable_name

Value

version

5.7.11

[](#13-%E4%B8%8B%E8%BD%BDquick-start%E5%AE%89%E8%A3%85%E5%8C%85)1.3 下载Quick Start安装包

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

安装包共50M，如果访问github网速不给力的话，可以从百度网盘下载。

  1. 从Github下载

  2. 从百度网盘下载

    • 通过网盘链接下载
    • 下载到本地后，在本地解压apollo-quick-start.zip

  3. 为啥安装包要58M这么大？

    • 因为这是一个可以自启动的jar包，里面包含了所有依赖jar包以及一个内置的tomcat容器

[](#131-%E6%89%8B%E5%8A%A8%E6%89%93%E5%8C%85quick-start%E5%AE%89%E8%A3%85%E5%8C%85)1.3.1 手动打包Quick Start安装包

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

  1. 修改apollo-configservice, apollo-adminservice和apollo-portal的pom.xml，注释掉spring-boot-maven-plugin和maven-assembly-plugin
  2. 在根目录下执行mvn clean package -pl apollo-assembly -am -DskipTests=true
  3. 复制apollo-assembly/target下的jar包，rename为apollo-all-in-one.jar

[](#%E4%BA%8C%E5%AE%89%E8%A3%85%E6%AD%A5%E9%AA%A4)二、安装步骤

[](#21-%E5%88%9B%E5%BB%BA%E6%95%B0%E6%8D%AE%E5%BA%93)2.1 创建数据库

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

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

[](#211-%E5%88%9B%E5%BB%BAapolloportaldb)2.1.1 创建ApolloPortalDB

通过各种MySQL客户端导入sql/apolloportaldb.sql即可。

下面以MySQL原生客户端为例：

source /your_local_path/sql/apolloportaldb.sql

导入成功后，可以通过执行以下sql语句来验证：

select Id, AppId, Name from ApolloPortalDB.App;

Id

AppId

Name

1

SampleApp

Sample App

[](#212-%E5%88%9B%E5%BB%BAapolloconfigdb)2.1.2 创建ApolloConfigDB

通过各种MySQL客户端导入sql/apolloconfigdb.sql即可。

下面以MySQL原生客户端为例：

source /your_local_path/sql/apolloconfigdb.sql

导入成功后，可以通过执行以下sql语句来验证：

select NamespaceId, Key, Value, Comment from ApolloConfigDB.Item;

NamespaceId

Key

Value

Comment

1

timeout

100

sample timeout配置

[](#22-%E9%85%8D%E7%BD%AE%E6%95%B0%E6%8D%AE%E5%BA%93%E8%BF%9E%E6%8E%A5%E4%BF%A1%E6%81%AF)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=密码（如果没有密码，留空即可）

注意：不要修改demo.sh的其它部分

[](#%E4%B8%89%E5%90%AF%E5%8A%A8apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83)三、启动Apollo配置中心

[](#31-%E7%A1%AE%E4%BF%9D%E7%AB%AF%E5%8F%A3%E6%9C%AA%E8%A2%AB%E5%8D%A0%E7%94%A8)3.1 确保端口未被占用

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

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

lsof -i:8080

[](#32-%E6%89%A7%E8%A1%8C%E5%90%AF%E5%8A%A8%E8%84%9A%E6%9C%AC)3.2 执行启动脚本

./demo.sh start

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

==== 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!

[](#33-%E5%BC%82%E5%B8%B8%E6%8E%92%E6%9F%A5)3.3 异常排查

如果启动遇到了异常，可以分别查看service和portal目录下的log文件排查问题。

注：在启动apollo-configservice的过程中会在日志中输出eureka注册失败的信息，如com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused。需要注意的是，这个是预期的情况，因为apollo-configservice需要向Meta Server（它自己）注册服务，但是因为在启动过程中，自己还没起来，所以会报这个错。后面会进行重试的动作，所以等自己服务起来后就会注册正常了。

[](#34-%E6%B3%A8%E6%84%8F)3.4 注意

Quick Start只是用来帮助大家快速体验Apollo项目，具体实际使用时请参考：分布式部署指南。

另外需要注意的是Quick Start不支持增加环境，只有通过分布式部署才可以新增环境，同样请参考：分布式部署指南

[](#%E5%9B%9B%E4%BD%BF%E7%94%A8apollo%E9%85%8D%E7%BD%AE%E4%B8%AD%E5%BF%83)四、使用Apollo配置中心

[](#41-%E4%BD%BF%E7%94%A8%E6%A0%B7%E4%BE%8B%E9%A1%B9%E7%9B%AE)4.1 使用样例项目

[](#411-%E6%9F%A5%E7%9C%8B%E6%A0%B7%E4%BE%8B%E9%85%8D%E7%BD%AE)4.1.1 查看样例配置

  1. 打开http://localhost:8070
Quick Start集成了Spring Security简单认证，更多信息可以参考Portal 实现用户登录功能

登录

  1. 输入用户名apollo，密码admin后登录

首页

  1. 点击SampleApp进入配置界面，可以看到当前有一个配置timeout=100 配置界面
如果提示系统出错，请重试或联系系统负责人，请稍后几秒钟重试一下，因为通过Eureka注册的服务有一个刷新的延时。

[](#412-%E8%BF%90%E8%A1%8C%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%A8%8B%E5%BA%8F)4.1.2 运行客户端程序

我们准备了一个简单的Demo客户端来演示从Apollo配置中心获取配置。

程序很简单，就是用户输入一个key的名字，程序会输出这个key对应的值。

如果没找到这个key，则输出undefined。

同时，客户端还会监听配置变化事件，一旦有变化就会输出变化的配置信息。

运行./demo.sh client启动Demo客户端，忽略前面的调试信息，可以看到如下提示：

Apollo Config Demo. Please input key to get the value. Input quit to exit.

输入timeout，会看到如下信息：

timeout
[SimpleApolloConfigDemo] Loading key : timeout with value: 100

如果运行客户端遇到问题，可以通过修改client/log4j2.xml中的level为DEBUG来查看更详细日志信息

<logger name="com.ctrip.framework.apollo" additivity="false" level="trace">

<AppenderRef ref="Async" level="DEBUG"/>

</logger>

[](#413-%E4%BF%AE%E6%94%B9%E9%85%8D%E7%BD%AE%E5%B9%B6%E5%8F%91%E5%B8%83)4.1.3 修改配置并发布

  1. 在配置界面点击timeout这一项的编辑按钮 编辑配置
  2. 在弹出框中把值改成200并提交 配置修改
  3. 点击发布按钮，并填写发布信息 发布

发布信息

[](#414-%E5%AE%A2%E6%88%B7%E7%AB%AF%E6%9F%A5%E7%9C%8B%E4%BF%AE%E6%94%B9%E5%90%8E%E7%9A%84%E5%80%BC)4.1.4 客户端查看修改后的值

如果客户端一直在运行的话，在配置发布后就会监听到配置变化，并输出修改的配置信息：

[SimpleApolloConfigDemo] Changes for namespace application
[SimpleApolloConfigDemo] Change - key: timeout, oldValue: 100, newValue: 200, changeType: MODIFIED

再次输入timeout查看对应的值，会看到如下信息：

timeout
[SimpleApolloConfigDemo] Loading key : timeout with value: 200

[](#42-%E4%BD%BF%E7%94%A8%E6%96%B0%E7%9A%84%E9%A1%B9%E7%9B%AE)4.2 使用新的项目

[](#421-%E5%BA%94%E7%94%A8%E6%8E%A5%E5%85%A5apollo)4.2.1 应用接入Apollo

这部分可以参考Java应用接入指南

[](#422-%E8%BF%90%E8%A1%8C%E5%AE%A2%E6%88%B7%E7%AB%AF%E7%A8%8B%E5%BA%8F)4.2.2 运行客户端程序

由于使用了新的项目，所以客户端需要修改appId信息。

编辑client/META-INF/app.properties，修改app.id为你新创建的app id。

app.id=你的appId

运行./demo.sh client启动Demo客户端即可。

Original url: Access
Created at: 2020-04-18 16:56:38
Category: default
Tags: none

未标明原创文章均为采集，版权归作者所有，转载无需和我联系，请注明原出处，南摩阿彌陀佛，知识，不只知道，要得到

请先后发表评论
  • 最新评论
  • 总共0条评论