【SpringCloud】之远程消费（进阶使用）

🎉🎉欢迎来到我的CSDN主页！🎉🎉

🏅我是君易--鑨，一个在CSDN分享笔记的博主。📚📚

🌟推荐给大家我的博客专栏《SpringCloud开发之远程消费》。🎯🎯

🎁如果感觉还不错的话请给我关注加三连吧！🎁🎁

前言

在上一期的SpringCloud的分享中我们对其SpringCloud有了一个初步的了解，在上一期我们一起学习了什么是SpringCloud、详细的讲述了SpringCloud核心组件在业务中的一些用法以及作用，最后我们还涉及到了nacos在SpringCloud中的集成使用。本期的博客分享基于上期的博客进行一个远程消费的一个分享

一、什么是远程消费

1. 概述

在 Spring Cloud 中，远程消费通常指的是一个微服务通过网络调用另一个微服务的接口，以实现跨服务的功能调用。这种跨服务的通信方式常见于分布式系统中，其中不同的微服务协同工作以完成更大的业务目标。在微服务架构中，各个微服务通常拥有独立的代码库和部署单元。

2. 实现方式

2.1 RestTemplate

RestTemplate 是 Spring 提供的一个用于访问 REST 服务的模板类。通过 RestTemplate，你可以发起 HTTP 请求，从而实现对其他微服务提供的 RESTful API 的调用。在 Spring Cloud 中，可以通过使用 @LoadBalanced 注解来启用负载均衡，使得 RestTemplate 可以根据服务名称自动选择合适的实例。

代码示例展示

@Bean
@LoadBalanced
public RestTemplate restTemplate() {
    return new RestTemplate();
}

2.2 Feign

Spring Cloud Feign 是一个基于注解的声明式 HTTP 客户端，它简化了使用 RestTemplate 的代码。通过定义接口并添加 @FeignClient 注解，开发者可以直接调用其他微服务的接口，而 Feign 会在运行时自动创建实现类并处理 HTTP 请求。

代码示例展示

@FeignClient(name = "another-service")
public interface AnotherServiceClient {
    @GetMapping("/api/someEndpoint")
    String getSomeData();
}

2.3 WebFlux WebClient

对于响应式编程，Spring WebFlux 提供了 WebClient 类，它也可以用于进行远程服务调用。WebClient 提供了非阻塞的 API，适用于构建响应式系统。

代码示例展示

WebClient webClient = WebClient.create("http://another-service");
String result = webClient.get()
        .uri("/api/someEndpoint")
        .retrieve()
        .bodyToMono(String.class)
        .block();

总之，这些方法都允许微服务之间进行远程通信，使得不同微服务能够协同工作，共同完成复杂的业务逻辑。在使用这些远程消费的方法时，通常需要考虑到服务的可用性、负载均衡、容错机制（如断路器模式）等因素，以确保系统的稳定性和可靠性。

二、DTO封装

        VO（View Object）：视图对象，用于展示层，它的作用是把某个指定页面（或组件）的所有数据封装起来。

        DTO（Data Transfer Object）：数据传输对象，这个概念来源于J2EE的设计模式，原来的目的是为了EJB的分布式应用提供粗粒度的数据实体，以减少分布式调用的次数，从而提高分布式调用的性能和降低网络负载，但在这里，我泛指用于展示层与服务层之间的数据传输对象。

        DO（Domain Object）：领域对象，就是从现实世界中抽象出来的有形或无形的业务实体。

        PO（Persistent Object）：持久化对象，它跟持久层（通常是关系型数据库）的数据结构形成一一对应的映射关系，如果持久层是关系型数据库，那么，数据表中的每个字段（或若干个）就对应PO的一个（或若干个）属性。

        消费者远程调用生产者 : 需要网络传输,使用DTO同一封装对象

   原理与 SpringBoot 启动类相同
        1.将 DTO 对象封装到公共 DTO 模块

        2.为需要的项目引入公共 DTO 模块

注意点

         1.不需要继承父模块(重复引用问题)

        2.打包方式为jar

        3.不需要添加启动类的编译

三、Feign实现远程消费

如果我们基于上一期的博客中的代码去实现我们的代码的话，我们的代码要写到爆，因此我们接下来就以Feign来详细说明其实现的过程

1. 导入其Fegin的pom依赖

在我们的主项目中去导入我们的Fegin的pom依赖。

<!--  引入openfeign的依赖-->
  <dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
  </dependency>

2. 标记使用远程消费

我们在需要远程消费的服务的启动类上打上注解进行标记说明该服务启用远程消费。

注解：@EnableFeignClients

该注解是开启Feign功能，我们的消费者需要启用，因此在我们的消费者的启动类上打上其注解。

3. 生产者编写接口

我们需要模拟远程消费，对应的生产者是不是应该编写一个Controller去提供一些接口让我们的消费者进行调用。

在编写的过程中只要参数是复杂对象，即使指定了是GET方法，feign依然会以POST方法进行发送请求，同时生产者必须支持POST请求并给参数添加@RequestBody注解

3.1 参数的接收方式

3.1.1 路径参数

//    路径接收参数的请求
    @RequestMapping("/{account}")
    public String getByPath(@PathVariable("account") String account){
        log.info("account:{}",account);//打印输出查看
        return "🍗";
    }

3.1.2 接收多个参数

//    接收多个参数的请求
    //    @RequestParam接受参数
    @RequestMapping("/param")
    public String getByPath(@RequestParam("account") String password,
                            @RequestParam("password") String account){
        log.info("account:{},password:{}",account,password);//打印输出查看
        return "🍗";
    }

3.1.3 使用对象接收

首先我们要在生产者进行创建一个实体类

User.java

package com.yx.provider.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * com.yx.provider.pojo
 *
 * @author 君易--鑨
 * @site www.yangxin.com
 * @company 木易
 * @create 2024/1/6
 * 实体类，用于存储用户信息
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Long id;//id
    private String account;//账号
    private String password;//密码String password;//密码



}

编写对应的请求方法

    //    接收对象参数的请求
    //    @RequestBody接受参数
    @RequestMapping("/pojo")
    public String getByPath(@RequestBody User user){
        log.info("user:{}",user);//打印输出查看
        return "🍗";
    }

3.1.4 使用Map接收

   @RequestMapping("/more")
    public String getByMore(@RequestBody Map<String, Object> map) {
        log.info("more:{}" + map);
        return "🍗";
    }

4. 编写一个接口类

如果我们的消费者还是使用上期博客中的那种方式去调用的话不方便，也不好。因此我们可以在消费者编写一个接口类用于调用。

FeginService.java

package com.yx.consumer.service;

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

/**
 * com.yx.consumer.service
 *
 * @author 君易--鑨
 * @site www.yangxin.com
 * @company 木易
 * @create 2024/1/6
 * 接口类，用于调用生产者的请求方法，连接生产者的Controller
 */
@FeignClient("provider")//连接的注解
public interface FeginService {

    //    路径接收参数的请求
    @RequestMapping("/{account}")
    String getByPath(@PathVariable("account") String account);


    //    接收多个参数的请求
    //    @RequestParam接受参数
    @RequestMapping("/param")
    String getByPath(@RequestParam("account") String password,
                            @RequestParam("password") String account);

}

编写对应的接口类的时候要注意一下几点

5. 编写消费者的Controller

重新编写请求方法进行调用生产者的方法

ConsumerController.java

package com.yx.consumer;

import com.yx.consumer.service.FeginUserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class ConsumerController {

//    调用生产者  ,注入接口
    @Autowired
    private FeginUserService feginUserService;

//restTemplate相当于HttpClient，用于发送请求
    @RequestMapping("/test01 ")
    public String test01() {
    //    跳转到生产者去
        return feginUserService.getByPath("木易兮");
    }

}

6. 测试

6.1 测试路径传参

当我们启动项目之后，在其网页进行对其发送请求

6.2 测试传递多个参数

6.3 测试对象传递参数

消费者中的接口类定义其方法

对其的控制层编写请求

运行测试

我们这里测试没有问题，但是我们要考虑一个问题，如果我们生产者的实体类比较多呢，难道都赋值到消费者去吗。我们可以在主项目下新建一个maven项目作为公共模块，我们创建好之后对其pom文件进行修改。

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <artifactId>common</artifactId>
    <packaging>jar</packaging>
    <name>common Maven Webapp</name>
    <url>http://maven.apache.org</url>

    <parent>
        <groupId>com.yx</groupId>
        <artifactId>cloud</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <dependencies>

    </dependencies>
</project>

还要将其实体类赋值过来

将实体类的名称改成UserDto,该类中的属性不一定和User的属性一致，生产者和消费者中引入UserDto需要在pom文件中引入公共模块

 <dependency>
            <groupId>com.yx</groupId>
            <artifactId>common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>