【SpringBoot】Spring Boot 单体应用升级 Spring Cloud 微服务

Spring Cloud 是在 Spring Boot 之上构建的一套微服务生态体系,包括服务发现、配置中心、限流降级、分布式事务、异步消息等,因此通过增加依赖、注解等简单的四步即可完成 Spring Boot 应用到 Spring Cloud 升级。

Spring Boot 应用升级为 Spring Cloud

Cloud Native

以下是应用升级 Spring Cloud 的完整步骤。

第一步:添加 Spring Cloud 依赖

首先,为应用添加 Spring Cloud 与 Spring Cloud Alibaba 依赖。注意根据当前应用 Spring Boot 版本选择合适的 Spring Cloud 版本,具体参见版本映射表**[** 1]。​​​​​​

复制代码
<properties>    <spring-cloud-alibaba.version>2022.0.0.0</spring-cloud-alibaba.version>    <spring-cloud.version>2022.0.0</spring-cloud.version></properties><dependencyManagement>    <dependencies>        <dependency>            <groupId>org.springframework.cloud</groupId>            <artifactId>spring-cloud-dependencies</artifactId>            <version>${spring-cloud.version}</version>            <type>pom</type>            <scope>import</scope>        </dependency>        <dependency>            <groupId>com.alibaba.cloud</groupId>            <artifactId>spring-cloud-alibaba-dependencies</artifactId>            <version>${spring-cloud-alibaba.version}</version>            <type>pom</type>            <scope>import</scope>        </dependency>    </dependencies></dependencyManagement><dependencies>    <!-- Nacos 服务发现 -->    <dependency>        <groupId>com.alibaba.cloud</groupId>        <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>    </dependency>    <!-- 服务发现:OpenFeign服务调用 -->    <dependency>        <groupId>org.springframework.cloud</groupId>        <artifactId>spring-cloud-starter-openfeign</artifactId>    </dependency>  <!-- 服务发现:OpenFeign服务调用 -->    <dependency>        <groupId>org.springframework.cloud</groupId>        <artifactId>spring-cloud-starter-loadbalancer</artifactId>    </dependency></dependencies>

以上我们添加了服务注册发现、OpenFeign 等依赖。

第二步:添加配置

在应用 application.yml 或者 application.properties 文件中增加以下配置项,设置应用名、注册中心地址。

application.yml:

复制代码
spring:  application:    #项目名称必填,在注册中心唯一    #最好和之前域名规范、kubernetes service名等保持一致(会作为调用与负载均衡依据)    name: service-provider  cloud:     nacos:       discovery: #启用 spring cloud nacos discovery        server-addr: 127.0.0.1:8848

application.properties:​​​​​​​

复制代码
#项目名称必填,在注册中心唯一#最好和之前域名规范、kubernetes service名等保持一致(会作为调用与负载均衡依据)spring.application.name=service-provider #启用 spring cloud nacos discoveryspring.cloud.nacos.discovery.server-addr=127.0.0.1:8848

第三步:启动类增加注解

启动类增加 EnableDiscoveryClient EnableFeignClients 注解,启动服务地址自动注册与发现。​​​​​​​

复制代码
@SpringBootApplication@EnableDiscoveryClient@EnableFeignClientspublic class ProviderApplication {    public static void main(String[] args) {        SpringApplication.run(ProviderApplication.class, args);    }}

第四步:调整服务调用方式

🔔 注意!

  1. 为了保证平滑升级,请确保下游应用完成 Spring Cloud 改造并在注册中心注册服务后再进行调用方式改造。

  2. RestTemplate/FeignClient 默认发起调用的 hostname (示例中的 service-provider)是对端 Spring Cloud 应用名。因此,为了保证尽可能少的改造量,改造过程中设置的应用名 spring.name=service-provider 最好和之前的命名规范保持一致。比如:

    • 如果之前有自定义域名,则和域名定义保持一致

    • 如果之前用的 Kubernetes Service,则和 Service Name 保持一致

  1. RestTemplate 模式

为之前的 RestTemplate Bean 添加 @LoadBlanced 注解,使得 RestTemplate 接入服务发现与负载均衡:​​​​​​

复制代码
@Bean@LoadBalancedpublic RestTemplate restTemplate() {    return new RestTemplate();}

其它原有 RestTemplate 发起调用的代码保持不变,只需调整 hostname 即可,如下所示。​​​​​​​

复制代码
@RestController public class TestController {
    @Autowired    private RestTemplate restTemplate;
    @GetMapping(value = "/echo-rest/{str}")    public String rest(@PathVariable String str) {        return restTemplate.getForObject("http://service-provider/echo/" + str, String.class);    }}
  1. FeignClient 模式

使用 @FeignClient 注解将 EchoService 这个接口包装成一个 FeignClient,属性 name 对应对端应用名 spring.name=service-provider。​​​​​​

复制代码
//@FeignClient(name = "service-provider", url="http://service.example.com/") @FeignClient(name = "service-provider")public interface EchoService {    @GetMapping(value = "/echo/{str}")    String echo(@PathVariable("str") String str);}

将 EchoService 作为标准 bean 注入,即可对远端服务发起请求了。​​​​​​​

复制代码
@RestController public class TestController {
    @Autowired    private EchoService echoService;
    @GetMapping(value = "/echo-feign/{str}")    public String feign(@PathVariable String str) {        return echoService.echo(str);    }}
  1. HtClient、自定义 HTTP 访问工具等

对于使用 HttpClient 或者自行封装 http 调用工具的用户,建议统一改造为以上 1、2 两种调用模式之一。

相关推荐
小小霸王龙!16 分钟前
互联网大厂Java面试实录:Spring Boot与微服务在电商场景中的应用
java·spring boot·redis·微服务·电商
大只鹅2 小时前
Springboot3.3.4使用spring-data-elasticsearch整合Elasticsearch7.12.1
spring boot·elasticsearch
「、皓子~2 小时前
后台管理系统的诞生 - 利用AI 1天完成整个后台管理系统的微服务后端+前端
前端·人工智能·微服务·小程序·go·ai编程·ai写作
1.01^10002 小时前
[6-02-01].第05节:配置文件 - YAML配置文件语法
spring boot
白仑色3 小时前
Spring Cloud 微服务(统一网关设计)
spring cloud·微服务·服务治理·统一配置管理·分布式配置中心
知了一笑4 小时前
SpringBoot3集成多款主流大模型
spring boot·后端·openai
paopaokaka_luck4 小时前
基于SpringBoot+Vue的酒类仓储管理系统
数据库·vue.js·spring boot·后端·小程序
白仑色5 小时前
Spring Boot 性能优化与最佳实践
spring boot·后端·性能优化·数据库层优化·jvm 层优化·日志优化·transactional优化
风象南6 小时前
SpringBoot基于Java Agent的无侵入式监控实现
java·spring boot·后端
崎岖Qiu6 小时前
【Spring篇08】:理解自动装配,从spring.factories到.imports剖析
java·spring boot·后端·spring·面试·java-ee