Apollo开发指南

一、准备工作

1.1 本地运行时环境

Apollo本地开发需要以下组件：

1. Java: 1.8+
2. MySQL: 5.6.5+
3. IDE: 没有特殊要求

其中MySQL需要创建Apollo数据库并导入基础数据。 具体步骤请参考分布式部署指南中的以下部分：

1. 一、准备工作
2. 2.1 创建数据库

1.2 Apollo总体设计

具体请参考Apollo配置中心设计

二、本地启动

2.1 Apollo Config Service和Apollo Admin Service

我们在本地开发时，一般会在IDE中同时启动apollo-configservice和apollo-adminservice。

下面以Intellij Community 2016.2版本为例来说明如何在本地启动apollo-configservice和apollo-adminservice。

2.1.1 新建运行配置

2.1.2 Main class配置

com.ctrip.framework.apollo.assembly.ApolloApplication

注：如果希望独立启动apollo-configservice和apollo-adminservice，可以把Main Class分别换成 com.ctrip.framework.apollo.configservice.ConfigServiceApplication和 com.ctrip.framework.apollo.adminservice.AdminServiceApplication

2.1.3 VM options配置

-Dapollo_profile=dev
-Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloConfigDB?characterEncoding=utf8
-Dspring.datasource.username=root
-Dspring.datasource.password=

注1：spring.datasource相关配置替换成你自己的数据库连接信息，注意数据库是ApolloConfigDB

注2：程序默认日志输出为/opt/logs/100003171/apollo-assembly.log，如果需要修改日志文件路径，可以增加logging.file参数，如下：

-Dlogging.file=/your-path/apollo-assembly.log

2.1.4 Program arguments配置

--configservice --adminservice

2.1.5 运行

对新建的运行配置点击Run或Debug皆可。

启动完后，打开http://localhost:8080可以看到apollo-configservice和apollo-adminservice都已经启动完成并注册到Eureka。

2.2 Apollo-Portal

下面以Intellij Community 2016.2版本为例来说明如何在本地启动apollo-portal。

2.2.1 新建运行配置

2.2.2 Main class配置

com.ctrip.framework.apollo.portal.PortalApplication

2.2.3 VM options配置

-Dapollo_profile=dev
-Ddev_meta=http://localhost:8080/
-Dserver.port=8070
-Dspring.datasource.url=jdbc:mysql://localhost:3306/ApolloPortalDB?characterEncoding=utf8
-Dspring.datasource.username=root
-Dspring.datasource.password=

注1：spring.datasource相关配置替换成你自己的数据库连接信息，注意数据库是ApolloPortalDB 。

注2：默认ApolloPortalDB中导入的配置只会展示DEV环境的配置，所以这里配置了dev_meta属性，如果你希望在本地展示其它环境的配置，需要在这里增加其它环境的meta服务器地址，如fat_meta。

注3：这里指定了server.port=8070是因为apollo-configservice启动在8080端口，所以这里配置apollo-portal启动在8070端口。

注4：程序默认日志输出为/opt/logs/100003173/apollo-portal.log，如果需要修改日志文件路径，可以增加logging.file参数，如下：

-Dlogging.file=/your-path/apollo-portal.log

2.2.4 运行

对新建的运行配置点击Run或Debug皆可。

启动完后，打开http://localhost:8070就可以看到Apollo配置中心界面了。

2.2.5 Demo应用接入

为了更好的开发和调试，一般我们都会自己创建一个demo项目给自己使用。

可以参考应用接入指南中的一、普通应用接入指南创建自己的demo项目。

2.3 样例客户端启动

项目中有一个样例客户端的项目：apollo-demo，下面以Intellij Community 2016.2版本为例来说明如何在本地启动。

2.3.1 配置项目AppId

在2.2.5 Demo应用接入中创建Demo项目时，系统会要求填入一个全局唯一的AppId，我们需要把这个AppId配置到apollo-demo项目的app.properties文件中：apollo-demo/src/main/resources/META-INF/app.properties。

如我们自己的demo项目使用的AppId是100004458，那么文件内容就是：

app.id=100004458

注：AppId是应用的唯一身份标识，Apollo客户端使用这个标识来获取应用自己的私有Namespace配置。

对于公共Namespace的配置，没有AppId也可以获取到配置，但是就失去了应用覆盖公共Namespace配置的能力。

2.3.2 新建运行配置

2.3.3 Main class配置

SimpleApolloConfigDemo

2.3.4 VM options配置

-Denv=dev
-Ddev_meta=http://localhost:8080

注1：这里指定运行时环境是dev，所以会获取Portal中DEV环境的配置

注2：对dev环境，需要指定dev环境的meta server地址，也就是apollo-configservice的地址。

2.3.5 概览

2.3.6 运行

对新建的运行配置点击Run或Debug皆可。

启动完后，忽略前面的调试信息，可以看到如下提示：

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

输入你之前在Portal上配置的值，如我们的Demo项目中配置了timeout，会看到如下信息：

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

客户端日志级别默认是DEBUG，如果需要调整，可以通过修改apollo-demo/src/main/resources/log4j2.xml中的level配置

<logger name="com.ctrip.framework.apollo" additivity="false" level="trace">
    <AppenderRef ref="Async" level="DEBUG"/>
</logger>

三、开发

3.1 Portal接入SSO

Apollo Portal默认的用户实现是全局只有apollo一个账号，所以如果需要真实用户账号的话，需要接入SSO或其它类似的用户服务。

我们在Portal定义了统一的User相关的接口，只需要自行实现即可。可以参考apollo-portal下的com.ctrip.framework.apollo.portal.spi这个包下面的两个实现：

1. defaultimpl：默认实现，全局只有apollo一个账号
2. ctrip：ctrip实现，接入了SSO并实现用户搜索、查询接口

实现了相关接口后，可以通过com.ctrip.framework.apollo.portal.configuration.AuthConfiguration在运行时替换默认的实现。