一、环境准备
jdk:1.8
Maven : 3.3.9
Mysql : 5.7.9 (要求5.6.5以上)
apollo : 0.10.0 (目前最新测试版)
Git Bash (Quick Start需要有bash环境,Windows用户建议安装Git Bash,或者也可以直接通过IDE环境启动),网上有安装教程
二、搭建Apollo配置中心
2.1 下载项目
此篇文章是介绍快速搭建的单机版,所以只要点击进入: https://github.com/nobodyiam/apollo-build-scripts 把项目下载下来。
下载好后就是下面如图所示
2.2 配置数据
2.2.1 创建数据库
Apollo服务端共需要两个数据库:ApolloPortalDB
和ApolloConfigDB
,我们把数据库、表的创建和样例数据都分别准备了sql文件,只需要导入数据库即可。
注意:如果你本地已经创建过Apollo数据库,请注意备份数据。我们准备的sql文件会清空Apollo相关的表。
2.2.2 创建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 |
2.2.3 创建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配置 |
2.2.4 配置数据库连接信息
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的其它部分
三、启动Apollo配置中心
3.1 确保端口未被占用
Quick Start脚本会在本地启动3个服务,分别使用8070, 8080, 8090端口,请确保这3个端口当前没有被使用。
例如,在Linux/Mac下,可以通过如下命令检查:
lsof -i:8080
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!
启动如图所示:
3.3 异常排查
如果启动遇到了异常,可以分别查看service和portal目录下的log文件排查问题。
注:在启动apollo-configservice的过程中会在日志中输出eureka注册失败的信息,如
com.sun.jersey.api.client.ClientHandlerException: java.net.ConnectException: Connection refused
。需要注意的是,这个是预期的情况,因为apollo-configservice需要向Meta Server(它自己)注册服务,但是因为在启动过程中,自己还没起来,所以会报这个错。后面会进行重试的动作,所以等自己服务起来后就会注册正常了。
四、使用Apollo配置中心
4.1 使用样例项目
4.1.1 查看样例配置
Quick Start集成了Spring Security简单认证,更多信息可以参考Portal 实现用户登录功能
- 输入用户名apollo,密码admin后登录
如果提示
系统出错,请重试或联系系统负责人
,请稍后几秒钟重试一下,因为通过Eureka注册的服务有一个刷新的延时。
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>
4.1.3 修改配置并发布
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
以上步骤基本就是官方步骤。一步一步来基本没什么问题,接下来将自己创建项目通过连接apollo配置中心启动。