nobodyiam/apollo-quick-start

Apollo配置中心本地快速部署与使用指南

为帮助快速上手Apollo配置中心，以下提供本地环境部署、启动及使用的详细步骤。本文档基于Quick Start模式，适用于本地测试；生产环境部署需参考[Apollo分布式部署指南] 。若熟悉Docker，也可通过[Apollo Quick Start Docker部署] 快速部署。

注意：Quick Start需bash环境，Windows用户建议安装[Git Bash] ，或通过IDE启动（详见[Apollo开发指南] ）。

一、准备工作

1.1 环境依赖检查

Java环境

• 版本要求：1.8及以上
• 检查方法：执行以下命令验证版本

  sh
  java -version
  

  示例输出（版本符合即可）：

  sh
  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环境变量。

MySQL环境

• 版本要求：5.6.5及以上（因Apollo表结构对timestamp使用多default声明，需此版本以上支持）

• 检查方法：连接MySQL后执行以下SQL

  sql
  SHOW VARIABLES WHERE Variable_name = 'version';
  

  示例结果（版本符合即可）：

  Variable_name	Value
  version	5.7.11

1.2 下载Quick Start安装包

安装包已包含依赖及内置Tomcat，无需手动编译打包，直接下载使用即可（大小约50M）。

下载渠道

1. Github：直接下载[apollo-build-scripts项目]
2. 百度网盘：通过[链接] 下载（提取码：9wwe），解压apollo-quick-start.zip

手动打包（可选，仅开发测试用）

若需修改源码后重新打包，步骤如下：

1. 注释apollo-configservice、apollo-adminservice、apollo-portal的pom.xml中spring-boot-maven-plugin和maven-assembly-plugin插件
2. 根目录执行打包命令：

   sh
   mvn clean package -pl apollo-assembly -am -DskipTests=true
   

3. 复制apollo-assembly/target下的jar包，重命名为apollo-all-in-one.jar

二、安装步骤

2.1 创建数据库

Apollo服务端需两个数据库：ApolloPortalDB（门户数据库）和ApolloConfigDB（配置数据库）。以下为数据库创建及验证步骤。

2.1.1 创建ApolloPortalDB

1. 导入SQL文件：通过MySQL客户端导入[sql/apolloportaldb.sql] （文件路径为安装包内或项目仓库中）
   示例命令（MySQL原生客户端）：

   sql
   source /本地路径/sql/apolloportaldb.sql
   

2. 验证导入：执行以下SQL，若返回结果含SampleApp则成功

   sql
   select `Id`, `AppId`, `Name` from ApolloPortalDB.App;
   

   预期结果：

   Id	AppId	Name
   1	SampleApp	Sample App

2.1.2 创建ApolloConfigDB

1. 导入SQL文件：通过MySQL客户端导入[sql/apolloconfigdb.sql]
   示例命令：

   sql
   source /本地路径/sql/apolloconfigdb.sql
   

2. 验证导入：执行以下SQL，若返回结果含timeout配置则成功

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

   预期结果：

   NamespaceId	Key	Value	Comment
   1	timeout	100	sample timeout配置

2.2 配置数据库连接信息

修改安装包中的demo.sh文件，配置数据库连接串（确保用户有读写权限）。

1. 编辑demo.sh：找到以下配置项，替换为实际数据库信息

   sh
   # ApolloConfigDB连接信息
   apollo_config_db_url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8
   apollo_config_db_username=数据库用户名
   apollo_config_db_password=数据库密码（无密码则留空）
   
   # ApolloPortalDB连接信息
   apollo_portal_db_url=jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8
   apollo_portal_db_username=数据库用户名
   apollo_portal_db_password=数据库密码（无密码则留空）
   

2. 注意：仅修改上述数据库配置项，不要改动脚本其他内容。

三、启动Apollo配置中心

3.1 检查端口占用

Quick Start需占用本地3个端口（8070、8080、8090），启动前需确保端口未被占用。

• 检查命令（Linux/Mac）：

  sh
  lsof -i:8070  # 检查8070端口
  lsof -i:8080  # 检查8080端口
  lsof -i:8090  # 检查8090端口
  

3.2 执行启动脚本

在安装包目录下执行启动命令：

sh
./demo.sh start

启动成功标志

若输出以下内容，说明服务启动完成：

sh
==== starting service ====
Service logging file is ./service/apollo-service.log
Started [10768]
Waiting for config service startup.......
Config service started. You may visit [] 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 [] now!

3.3 异常排查

若启动失败，可通过以下日志文件定位问题：

• 服务日志：./service/apollo-service.log
• 门户日志：./portal/apollo-portal.log

3.4 注意事项

• 仅用于测试：Quick Start为本地测试环境，不支持生产部署或新增环境，生产环境需参考[Apollo分布式部署指南]
• 启动时正常错误：启动过程中可能出现eureka注册失败日志（如Connection refused），属正常现象（服务需向自身注册，启动初期未就绪，后续会重试成功）。

四、使用Apollo配置中心

4.1 样例项目体验（SampleApp）

4.1.1 访问Apollo门户

1. 打开浏览器访问：`[]
2. 登录：默认用户名apollo，密码admin
3. 查看配置：登录后点击SampleApp进入配置界面，可见默认配置timeout=100

4.1.2 运行客户端程序

客户端程序用于演示配置获取及动态更新，步骤如下：

1. 启动客户端：执行以下命令
   CODE_TOKEN_12
2. 验证连接：客户端启动后提示输入key，输入timeout，输出如下即成功获取配置：
   CODE_TOKEN_13

4.1.3 修改并发布配置

1. 编辑配置：在门户SampleApp配置界面，点击timeout项的“编辑”按钮，修改值为200并提交
2. 发布配置：点击“发布”按钮，填写发布说明（如“更新超时时间”），确认发布

4.1.4 查看客户端配置更新

配置发布后，客户端会实时监听变化并输出日志：
CODE_TOKEN_14
再次输入timeout，客户端返回更新后的值：
CODE_TOKEN_15

4.2 新项目接入Apollo

4.2.1 应用接入指南

新应用接入可参考[Apollo Java应用接入指南] ，完成依赖引入、配置等步骤。

4.2.2 运行自定义客户端

1. 修改AppId：编辑客户端配置文件client/META-INF/app.properties，将app.id改为新创建的项目AppId
   CODE_TOKEN_16
2. 启动客户端：执行./demo.sh client，按提示输入key即可获取自定义项目配置。