SOFABoot 是在 Spring Boot 的基础上提供的功能扩展。基于 Spring Boot 的机制,SOFABoot 管理了 SOFA 中间件的依赖,并且提供了 Spring Boot 的 Starter,方便用户在 Spring Boot 中使用 SOFA 中间件。

SOFABoot 依赖管理 – Maven

在使用 SOFA 中间件之前,需要引入 SOFABoot 依赖管理。类似 Spring Boot 引入方式,在工程中增加如下 <parent/> 标签配置的方式:

  1. <parent>
  2. <groupId>com.alipay.sofa</groupId>
  3. <artifactId>sofaboot-dependencies</artifactId>
  4. <version>${sofa.boot.version}</version>
  5. </parent>

其中 ${sofa.boot.version} 为具体的 SOFABoot 版本,参考发布历史

SOFABoot 依赖管理 – Gradle

从 SOFABoot 3.1.1 版本开始,SOFABoot 开始支持使用 Gradle 来进行依赖管理,如果要使用 Gradle 来进行依赖管理,需要按照如下的形式来配置 build.gradle

  1. buildscript {
  2. ext {
  3. sofaBootVersion = '3.1.1'
  4. }
  5. repositories {
  6. mavenLocal()
  7. mavenCentral()
  8. }
  9. dependencies {
  10. classpath("com.alipay.sofa:sofa-boot-gradle-plugin:${sofaBootVersion}")
  11. }
  12. }
  13. apply plugin: 'java'
  14. apply plugin: 'eclipse'
  15. apply plugin: 'com.alipay.sofa.boot'
  16. apply plugin: 'io.spring.dependency-management'
  17. group = 'com.example'
  18. version = '0.0.1-SNAPSHOT'
  19. sourceCompatibility = 1.8
  20. repositories {
  21. mavenLocal()
  22. mavenCentral()
  23. }
  24. dependencies {
  25. implementation('com.alipay.sofa:rpc-sofa-boot-starter')
  26. implementation('org.springframework.boot:spring-boot-starter')
  27. testImplementation('org.springframework.boot:spring-boot-starter-test')
  28. }

主要有几个步骤:

  • 添加 buildScript,增加 sofa-boot-gradle-plugin 的依赖,其中版本号为你使用的 SOFABoot 的版本。
  • 添加两个 plugin,分别是 com.alipay.sofa.bootio.spring.dependency-management。这样,在 dependencies 里面,就可以直接添加 SOFABoot 管理的各种中间件和依赖了,而不用声明版本号。

引入 SOFA 中间件

SOFABoot 使用一系列后缀为 -sofa-boot-starter 来标示一个中间件组件,如果想要使用某个中间件,直接添加对应的依赖即可。例如,如果期望使用 SOFARPC,只需增加下面的 Maven 依赖即可:

  1. <dependency>
  2. <groupId>com.alipay.sofa</groupId>
  3. <artifactId>rpc-sofa-boot-starter</artifactId>
  4. </dependency>

注意上面的 Maven 依赖中并没有声明版本,这个是因为版本已经在 sofaboot-dependencies 里面声明好。这样做的好处是对于 SOFA 中间件,用户统一进行升级即可,不需要单独升级一个中间件的版本,防止出现依赖冲突以及兼容性的问题。目前管控的 SOFABoot 中间件列表如下:

中间件starter
SOFARPCrpc-sofa-boot-starter
SOFATracertracer-sofa-boot-starter
SOFALookoutlookout-sofa-boot-starter

引入 SOFABoot 扩展组件

SOFABoot 基于 Spring Boot 提供了健康检查,模块隔离,类隔离等扩展能力。遵循 Spring Boot 依赖即服务的理念,添加相关组件依赖之后,扩展能力即可生效。目前提供的扩展组件如下:

扩展组件starter
健康检查healthcheck-sofa-boot-starter
模块化隔离isle-sofa-boot-starter
类隔离sofa-ark-springboot-starter
测试扩展test-sofa-boot-starter

引入 SOFA 中间件 ark 插件

SOFABoot 提供了类隔离组件 SOFAArk,借助 SOFAArk 容器,用户可以将依赖冲突的三方包打包成 ark 插件。运行时,ark 插件使用单独的类加载器加载,可以和其他 ark 插件以及业务依赖隔离,解决类冲突问题。SOFABoot 官方提供了 SOFARPC 和 SOFATracer 的 ark 插件,例如在应用中引入 SOFARPC ark 插件依赖替代 SOFARPC starter,从而隔离应用和 SOFARPC 及其间接依赖。目前管控的 ark 插件列表如下:

Ark插件plugin
SOFARPCrpc-sofa-boot-plugin
SOFATracertracer-sofa-boot-plugin

引入 SOFABoot 命名空间

使用 SOFA 中间件时,需要在 XML 中根据中间件的具体使用方式添加相应的配置,这个时候需要引入 SOFABoot 的命名空间 xmlns:sofa="http://sofastack.io/schema/sofaboot&#34; 以能够正确解析相应的配置标签,示例:

  1. <beans xmlns="http://www.springframework.org/schema/beans"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns:sofa="http://sofastack.io/schema/sofaboot"
  4. xmlns:context="http://www.springframework.org/schema/context"
  5. xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
  6. http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd
  7. http://sofastack.io/schema/sofaboot http://sofastack.io/schema/sofaboot.xsd"
  8. default-autowire="byName">
  9. </beans>