接入 Spring Cloud SOFA

适配版本

Spring Cloud SOFA 目前可适配于宽范围的 Spring Cloud 版本。

引入公共依赖

在项目的 Maven 配置中，将 Spring Cloud SOFA 版本配置于dependencyManagement中，以控制 Spring Cloud SOFA 相关依赖的版本（版本映射关系可能随 Spring Cloud 官方升级而发生变化），示例如下：

<dependencyManagement>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-dependencies</artifactId>
        <version>2.7.16</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-dependencies</artifactId>
        <version>2021.0.8</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
    <dependency>
        <groupId>com.alipay.cloud</groupId>
        <artifactId>spring-cloud-sofa-dependencies</artifactId>
        <version>2021.0.0</version>
        <type>pom</type>
        <scope>import</scope>
    </dependency>
</dependencyManagement>

添加公共配置

您只需在application.properties中配置以下公共参数，即可将 Spring Cloud SOFA 轻松接入整套 SOFA 商业版中间件产品。

spring.application.name={your project name}
spring.cloud.sofa.instanceid={sofa middleware instance id}
spring.cloud.sofa.acvip.endpoint={sofa acvip lb address}
spring.cloud.sofa.mw.access={sofa middleware ak, optional}
spring.cloud.sofa.mw.secret={sofa middleware sk, optional}
spring.cloud.sofa.ldc.region={sofa application region, optional}
spring.cloud.sofa.ldc.datacenter={sofa application data center, optional}
spring.cloud.sofa.ldc.zone={sofa application zone, optional}

参数说明：

如果您使用 SOFABoot 进行过应用开发，可以继续沿用 SOFABoot 的公共配置 Key。Spring Cloud SOFA上的这些公共配置和 SOFABoot 框架的公共配置相对应且兼容，使用 SOFABoot 的公共配置 Key 在 Spring Cloud SOFA 上进行配置也同样生效。

需注意，当使用动态配置功能时（Bootstrap 模式），以上与中间件连接相关的配置需要抽取到bootstrap.properties文件中进行配置，详情请参见 Bootstrap 模式。

添加 Spring Cloud SOFA 组件

Spring Cloud SOFA 提供了以下组件来引入 SOFA 商业版中间件：

以上模块，均可单独引入项目，仅使用一部分功能。Spring Cloud SOFA 与其他开源或商业化 Spring Cloud 生态有着极好的兼容性，可以按需组合。当然我们更推荐完整引入 Spring Cloud SOFA 某一类型的组件（如全部引入微服务类型组件），以便获得完整的功能增强，并更易于与 SOFA 的中间件控制台搭配使用。