基于 SOFAArk 和 SOFADashboard 实现动态模块管控 | Meetup#2 回顾

作者：卫恒（宋国磊） SOFATracer 以及 SOFADashboard 开源负责人。

本文根据 5月26日 SOFA Meetup#2上海站 《使用 SOFAStack 快速构建微服务》主题分享整理，着重分享如何使用 SOFADashboard 来管控 SOFAArk ，对于 SOFAArk 中的一些基础概念和知识不过多涉及；建议大家在阅读之前，先了解下 SOFAArk 的相关基本知识。

现场回顾视频以及 PPT 见文末链接。

0前言

SOFAArk [1] 是一款基于 Java 实现的轻量级类隔离容器，主要提供类隔离和应用（模块）合并部署能力，由蚂蚁金服开源贡献。SOFAArk 在 0.6.0 版本 [2] 提供了非常丰富的功能特性，其中最核心的当属多应用（模块）合并部署这个能力。SOFAArk 本身提供了多种方式来支持多应用（模块）合并部署 ，包括基于命令行的管控，基于 API 的管控等。本篇将结合 SOFA 开源的管控端组件 SOFADashboard [3]，来实现 SOFAArk 提供的合并部署和动态模块推送的功能。

案例工程地址 [4]：
https://github.com/sofastack-guides/sofa-dashbaord-samples-parent

1背景

复杂项目通常需要跨团队协作开发，各自负责不同的组件，而众所周知，协调跨团队合作开发会遇到不少问题；比如各自技术栈不统一导致的依赖冲突，又比如往同一个 Git 仓库提交代码常常导致 merge 冲突。因此，如果能让每个团队将负责的功能组件当成一个个单独的应用开发，运行时合并部署，通过统一的编程界面交互，那么将极大的提升开发效率及应用可扩展性。SOFAArk 提出了一种特殊的包结构 -- Ark Biz，用户可以使用 Maven 插件将应用打包成 Biz，允许多 Biz 在 SOFAArk 容器之上合并部署，并通过统一的编程界面交互。

2案例模型

本篇所演示案例是上图的一个简化版，从整体上可以体现 SOFAArk多应用合并部署的能力。主要包括已经几个工程：

• sofa-dashboard-ark-hostapp : 宿主应用

• sofa-dashboard-ark-facade   : 提供接口 API

• sofa-dashboard-ark-provider ：提供接口 API 的具体实现，将发布一个 JVM 服务

sofa-dashboard-ark-hostapp 和 sofa-dashboard-ark-provider 均作为 SOFAArk 中的 ark-biz 存在；sofa-dashboard-ark-hostapp 作为宿主应用对外提供服务。

上图的模型中，在宿主应用不重启的情况下，实现  provider 模块的动态替换，从而实现版本升级。

在宿主应用启动时，provider 1.0.0 以静态合并部署方式“寄宿”到宿主应用中，这部分实际上与 SOFADashboard 管控是没有什么关系的，为了案例效果，在下面的案例中，关于静态合并部署的操作也会涉及到。

最终的工程结构图如下：

3环境准备

本文需要启动 SOFADashboard 服务端，具体请参考 ： Quick Start [5] ；其他基础设施环境如 Zookeeper 、Mysql 等需提前准备。

4工程构建

本篇将通过 step by step 的方式来构建整个工程，为大家在实际的应用过程中提供一种简单的思路，同时也帮助大家更好的理解 SOFAArk 中的一些点。

sofa-dashboard-ark-facade

基础 API 提供模块，不需要依赖任何其他二方或者三方 JAR，这里仅提供一个接口。

public interface SofaJvmService {	
    String test();	
}

sofa-dashboard-ark-provider

这个模块是 JVM 服务的提供方，也是后面需要在宿主应用中进行替换演示的模块包，这个模块本身也是一个 Web 应用。这里就来一步步分解下，如何将一个普通的 SpringBoot 工程改造成一个 ark-biz 工程。

1、新建一个 SpringBoot 工程

新建 SpringBoot 工程推荐的方式有两种，一种是在 https://start.spring.io/  进行下载，另外一种是基于 IDEA 的 Spring 插件来生成；此处不在过多描述过程。

2、工程基本能力实现

• 引入 sofa-dashboard-ark-facade 依赖，先将需要提供的 JVM 服务实现：

1. @SofaService

2. @Service

3. public class SofaJvmServiceImpl implements SofaJvmService {

4. @Override

5. public String test() {

6. return "first version biz";

7. }

8. }

NOTE: SofaService 的作用是将一个 Bean 发布成一个 JVM 服务， 所以这里需要加上 Spring 提供的 @Service 注解将 SofaJvmServiceImpl 标注为一个 Bean。

• 配置文件：

1. 
   

   spring.application.name=biz-ark-test

2. server.port=8800

3. logging.path=./logs

   
   

3、配置打包插件，将应用打包成 ark-biz  

根据官方文档，可以使用 sofa-ark-maven-plugin 插件将一个普通的工程打包成一个 ark biz 包。这里直接给出本篇中工程的配置：

1. 
   

   <plugin>

2. <groupId>com.alipay.sofa</groupId>

3. <artifactId>sofa-ark-maven-plugin</artifactId>

4. <version>0.6.0</version>

5. <executions>

6. <execution>

7. <!--goal executed to generate executable-ark-jar -->

8. <goals>

9. <goal>repackage</goal>

10. </goals>

11. <!--ark-biz 包的打包配置 -->

12. <configuration>

13. <!--是否打包、安装和发布 ark biz，详细参考 Ark Biz 文档，默认为false-->

14. <attach>true</attach>

15. <!--ark 包和 ark biz 的打包存放目录，默认为工程 build 目录-->

16. <outputDirectory>target</outputDirectory>

17. <!--default none-->

18. <arkClassifier>executable-ark</arkClassifier>

19. <!-- ark-biz 包的启动优先级，值越小，优先级越高-->

20. <priority>200</priority>

21. <!--设置应用的根目录，用于读取 ${base.dir}/conf/ark/bootstrap.application 配置文件，默认为 ${project.basedir}-->

22. <baseDir>../</baseDir>

23. </configuration>

24. </execution>

25. </executions>

26. </plugin>

    
    

4、工程依赖

从前面背景介绍中的设计理念图中可以看出，动态合并部署需要依赖的插件核心有两个，一个是 runtime plugin，一个是 config plugin（没有涉及到 RPC 服务相关）；由于 provider 并不是作为宿主应用，其本身不需要具备动态配置的能力，因此这里仅需要引入 runtime plugin 来为当前 ark-biz 工程提供运行时环境即可。

1. 
   

   <!-- runtime plugin -->

2. <dependency>

3. <groupId>com.alipay.sofa</groupId>

4. <artifactId>runtime-sofa-boot-plugin</artifactId>

5. </dependency>

6. <!-- 其他依赖 -->

7. <dependency>

8. <groupId>com.alipay.sofa</groupId>

9. <artifactId>healthcheck-sofa-boot-starter</artifactId>

10. </dependency>

11. <dependency>

12. <groupId>com.glmapper.bridge.boot</groupId>

13. <artifactId>sofa-dashboard-ark-facade</artifactId>

14. </dependency>

    
    

5、编译打包

执行 mvn clean package ，之后会在当前模块的 target 目录下生成 xxx-ark-biz.jar 的包。

sofa-dashboard-ark-host

前面已经构建好了所需要的一些基础工程，sofa-dashboard-ark-host 作为宿主应用，期望其具备的能力有以下几个：

• 提供可以直观的 check 模块变更后的结果

• 提供能够给 provider 1.0.0 版本 ark-biz 包运行的宿主环境

• 能够通过 SOFAArk 提供的状态 endpoint 查看插件状态

• 能够支持 Zookeeper 下发指令，控制 Biz 的生命周期

基于以上几点功能，下面来分步骤实现。

1、提供一个简单的 Rest 接口来 check 结果

sofa-dashboard-ark-host 本身也是一个 Web 应用，所以在这个提供一个 Rest 接口，具体实现是通过@SofaReference 调用 provider ark-biz 包中发布的 JVM 服务。

1. 
   

   @RestController

2. public class TestController {

3. @SofaReference

4. SofaJvmService sofaJvmService;

5. @RequestMapping("test")

6. public String test(){

7. return sofaJvmService.test();

8. }

9. }

   
   

2、作为宿主应用

• ARK 容器配置

这部分可以先参考阅读 SOFAArk 配置 [6] 。本案例中简单配置了一份 ARK 容器的配置文件。

1. 
   

   # log 日志目录

2. logging.path=./logs

3. # 指定zookeeper 服务地址

4. com.alipay.sofa.ark.config.address=zookeeper://localhost:2181

5. # 指定宿主应用名

6. com.alipay.sofa.ark.master.biz=host-app

   
   

com.alipay.sofa.ark.master.biz 默认情况下是宿主应用的 artifactId。如果这里指定了名字，则在宿主应用的插件配置里面需要使用此名字。

• 依赖引入

引入 sofa-ark-springboot-starter 、web-ark-plugin 以及 provider ark biz 包。

1. 
   

   <!-- 引用ark starter-->

2. <dependency>

3. <groupId>com.alipay.sofa</groupId>

4. <artifactId>sofa-ark-springboot-starter</artifactId>

5. </dependency>

6. <!-- 引用ark web插件-->

7. <dependency>

8. <groupId>com.alipay.sofa</groupId>

9. <artifactId>web-ark-plugin</artifactId>

10. </dependency>

11. <!-- 引入 sofa-dashboard-ark-provider ark-biz ，这里属于静态合并部署情况-->

12. <dependency>

13. <groupId>com.glmapper.bridge.boot</groupId>

14. <artifactId>sofa-dashboard-ark-provider</artifactId>

15. <version>1.0.0</version>

16. <classifier>ark-biz</classifier>

17. </dependency>

    
    

• 插件配置

1. 
   

   <plugin>

2. <groupId>com.alipay.sofa</groupId>

3. <artifactId>sofa-ark-maven-plugin</artifactId>

4. <version>0.6.0</version>

5. <executions>

6. <execution>

7. <id>default-cli</id>

8. <goals>

9. <goal>repackage</goal>

10. </goals>

11. </execution>

12. </executions>

13. <configuration>

14. <!--指定优先级-->

15. <priority>100</priority>

16. <!--指定baseDir-->

17. <baseDir>../</baseDir>

18. <!--bizName,这里需要和 bootstrap 中指定的master.biz 配置保持一致，默认为 artifactId-->

19. <bizName>host-app</bizName>

20. </configuration>

21. </plugin>

    
    

3、状态查看

SOFAArk 提供了 /bizState 这样一个 endpoint 用来获取当前插件的版本及状态信息。这里就在宿主应用中引入actuator 依赖并进行相关配置。

1. 
   

   <!-- 引用 actuator -->

2. <dependency>

3. <groupId>org.springframework.boot</groupId>

4. <artifactId>spring-boot-starter-actuator</artifactId>

5. </dependency>

   
   

application.properties 中配置暴露所有端点。

1. 
   

   management.endpoints.web.exposure.include=*

   
   

4、提供动态配置插件能力

SOFAArk 提供了 config-ark-plugin 对接 Zookeeper 配置中心，用于运行时接受配置，达到控制 Biz 生命周期，引入如下依赖：

1. 
   

   <!-- 引用ark 配置推送扩展插件-->

2. <dependency>

3. <groupId>com.alipay.sofa</groupId>

4. <artifactId>config-ark-plugin</artifactId>

5. </dependency>

   
   

参考 SOFAArk 配置，在 SOFAArk 配置文件 conf/ark/bootstrap.properties 增加如下配置：

1. 
   

   com.alipay.sofa.ark.config.address=zookeeper://localhost:2181

   
   

5静态合并部署演示

基于上述所有的配置，将 host-app 打包，然后运行。

• mvn clean install 

• java -jar sofa-dashboard-ark-hostapp-1.0.0.jar

下面可以通过 SOFAArk 提供的 endpoint 来查看下当前应用的 biz state 信息：

这里只有宿主应用自身的 ark biz 状态信息，实际上我们使用了静态合并部署。但是貌似 ark-biz 合并部署的包插件没有在 bizState 中体现出来。访问下 http://localhost:8085/test 我们的 check  rest 服务：

提示出来没有可用的 JVM 服务。

这里有个点是并不会去激活里面的 ark biz 包，需要通过通过 终端或者 API 的方式来进行激活，实际上只是激活了宿主应用本身的 ark-biz。

6 SOFADashboard 命令推送

SOFADashboard 进行推送的原理可以参考前面背景介绍中的描述。下面主要来介绍如何使用 SOFADashboard 进行动态模块切换。

注册插件

将 sofa-dashboard-ark-provider 这个 ark-biz 插件注册到 SOFADashboard：

填写插件的基本信息：

注册成功之后，模块列表如下：

增加版本

点击添加版本，弹出新增版本表单，输入版本信息及当前版本对应的 ark biz 包文件地址；支持从文件服务器（http 协议）上拉取，也支持从本地文件（File 协议）系统获取。下面为了方便，使用从文件系统中获取，配置如下：

添加成功之后，插件列表如下：

关联应用

点击插件列表后面的 关联应用案例，将插件与应用进行关联，如下：

详情查看

点击插件列表后面的详情按钮，可以查看当前插件下所有应用信息和应用实例信息。

命令推送

SOFADashboard 提供两种维度的命令推送：

• 基于应用维度，当前应用所有的实例都会监听到此命令变更；

• 基于 IP 维度，分组维度的单 IP 场景。

下面演示基于 IP 维度的推送：

1、安装

点击安装，安装过程中，插件状态会发生变化， RESOLVED 状态为正在解析。

延迟 1~3s 之后，状态变为  ACTIVATED 状态

再次访问下 http://localhost:8085/test 我们的 check rest 服务：

实现了在不重启宿主应用的情况下，实现了内部业务逻辑的变更。

2、版本切换

模块版本 1 运行一段时间之后，出现新的需求，希望更改下模块版本 1 中的一些逻辑。在未使用动态模块的情况下，一般就需要新拉一个迭代，然后将原有的逻辑修改，然后发布上线。可能是一个非常小的功能点，但是却需要走复杂的发布流程。

这个就可以借助动态模块的方式来实现版本的动态切换。修改 sofa-dashboard-ark-provider  模块逻辑实现，升级版本，重新打包 sofa-dashboard-ark-provider 。

在 SOFADashboard ，新增 2.0.0 版本，并且配置指定的版本 ark-biz 包的文件地址。添加成功之后如下：

进入详情界面，切换版本到 2.0.0：

执行安装，此时版本 2.0.0 状态将会变为非激活状态：

执行点击激活按钮进行激活，延迟 1~3s 之后，状态变更为激活状态：

再次访问下 http://localhost:8085/test 我们的 check  rest 服务：

可以看到，版本 2.0.0 中的逻辑已经生效了；切回到 1.0.0 ，此时 1.0.0 的状态变成了非激活状态：

7小结

本文分享了基于 SOFAArk 和 SOFADashboard 实现动态模块管控的能力。动态模块在实际业务中有非常丰富的场景，对主应用不发版，不重启的情况下实现具体模块的功能变更；在此基础上也可以实现版本灰度的能力。

本案例中，provider 也是一个独立的应用，其作为一个子模块在宿主应用 hostapp 中启动，因此也可以基于 SOFABoot 这种能力来实现多 Web 应用的合并部署的能力。

以上就是本次分享的全部内容。

SOFA Meetup 上海站回顾资料

现场回顾视频以及 PPT 地址：

http://t.cn/AiKlmCmE

文中涉及相关链接

[1] SOFAArk：
https://www.sofastack.tech/sofa-boot/docs/sofa-ark-readme

[2] SOFAArk 0.6.0 版本：
https://github.com/alipay/sofa-ark/releases/tag/v0.6.0

[3] SOFADashboard：
https://github.com/sofastack/sofa-dashboard

[4] 案例工程地址：
https://github.com/sofastack-guides/sofa-dashbaord-samples-parent

[5] Quick Start：
https://www.sofastack.tech/sofa-dashboard/docs/QuickStart

[6] SOFAArk 配置：
https://www.sofastack.tech/sofa-boot/docs/sofa-ark-ark-config