【Spring Cloud】使用RestTemplate和Feign实现微服务之间的相互请求

codingXT

已于 2022-01-23 22:00:43 修改

阅读量6.2k

点赞数

文章标签： spring cloud

于 2022-01-23 21:37:55 首次发布

本文链接：https://blog.csdn.net/qq_37774171/article/details/122654301

版权

Nacos的简单介绍以及服务注册与发现功能的基本使用
我这里采用nacos来实现服务的注册与发现
然后这里展示一下两种实现服务之间相互请求的实现方式

Nacos实现注册与发现服务

基本都是Nacos的简单介绍以及服务注册与发现功能的基本使用这篇博客的代码，我这就不拷贝到这里了，可以到这篇博客的指定章节观看

RestTemplate 简单介绍

RestTemplate是由Spring提供的一个HTTP请求工具。RestTemplate是从Spring3.0开始支持的一个HTTP请求工具，它提供了常见的REST请求方案的模版，例如 GET 请求、POST请求、PUT请求、DELETE请求以及一些通用的请求执行方法exchange以及execute。RestTemplate继承自InterceptingHttpAccessor并且实现了RestOperations 接口，其中RestOperations接口定义了基本的 restful操作，这些操作在RestTemplate中都得到了实现。开发者也可以不使用 RestTemplate ，使用 Java 自带的 HttpUrlConnection 、Apache HttpComponents或者经典的网络访问框架 HttpClient 也可以完成上文的案例，只是在 Spring 项目中，使用 RestTemplate 显然更方便一些。
HttpComponents和HttpClient基本用法

Commons HttpClient 项目现已结束，不再开发。它已被 HttpClient 和 HttpCore 模块中的 Apache HttpComponents 项目取代，提供更好的性能和更大的灵活性。
Apache HttpComponents 项目负责创建和维护专注于 HTTP 和相关协议的低级 Java 组件工具集。该项目在 Apache 软件基金会下运作，是更大的开发人员和用户社区的一部分。

RestTemplate

public class RestTemplate extends InterceptingHttpAccessor implements RestOperations

他实现了一系列的GET,POST,PUT,PATCH,DELETE等方法
在这里插入图片描述

RestTemplate实现服务间相互请求

运行三个nacos-provider服务实例，使用nacos-consumer向nacos-provider服务实例发起请求

nacos-consumer启动类
在nacos-consumer服务的启动类里面，将RestTemplate注解为Bean
@Bean 用在方法上，告诉Spring容器，你可以从下面这个方法中拿到一个Bean

@SpringBootApplication
@EnableDiscoveryClient
public class NacosConsumerApplication {

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

    public static void main(String[] args){
        SpringApplication.run(NacosConsumerApplication.class, args);
    }
}

nacos-consumer服务的控制器TestController
使用restTemplate.getForObject方法向指定服务nacos-provider发起请求

@RestController
public class TestController {

    private final RestTemplate restTemplate;

    @Autowired
    public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

    @RequestMapping(value = "/echo/{str}", method = RequestMethod.GET)
    public String echo(@PathVariable String str) {
        return restTemplate.getForObject("http://nacos-provider/echo/" + str, String.class);
    }
}

上述代码getForObject()，第一个参数是 url ，第二个参数是接口返回的数据类型。

restTemplate.getForObject()方法
在其他重载的实现中，还有一个可变长度的参数，用来给url的占位符填值，不过我这里没使用占位符

@Override
@Nullable
public <T> T getForObject(String url, Class<T> responseType, Object... uriVariables) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
}

@Override
@Nullable
public <T> T getForObject(String url, Class<T> responseType, Map<String, ?> uriVariables) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor, uriVariables);
}

@Override
@Nullable
public <T> T getForObject(URI url, Class<T> responseType) throws RestClientException {
	RequestCallback requestCallback = acceptHeaderRequestCallback(responseType);
	HttpMessageConverterExtractor<T> responseExtractor =
			new HttpMessageConverterExtractor<>(responseType, getMessageConverters(), logger);
	return execute(url, HttpMethod.GET, requestCallback, responseExtractor);
}

RestTemplate还有一个GET请求方法：getForEntity。

他和getForObject方法在RestTemplate的实现里面都有三个重载方法实现。

getForObject 方法和 getForEntity 方法类似，参数和 getForEntity 一样， getForObject 和 getForEntity 的差异主要体现在返回值的差异上， getForObject 的返回值就是服务提供者返回的数据，使用 getForObject 无法获取到响应头。

但是使用 getForEntity 来发送 HTTP 请求，返回的对象是一个 ResponseEntity 的实例。这个实例中包含了响应数据以及响应头。
在返回的 ResponseEntity 中，可以获取响应头中的信息，其中 getStatusCode 方法用来获取响应状态码， getBody 方法用来获取响应数据， getHeaders 方法用来获取响应头

其他方法可以查看这位博主的博客RestTemplate 用法详解

我们使用浏览器向nacos-consumer发起请求，nacos-consumer会向nacos-provider发起请求。

RestTemplate请求服务展示

浏览器请求nacos-consumer
在这里插入图片描述
一个nacos-provider接收到了请求，并处理了这次服务请求

Feign简单介绍

Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单, 它的使用方法是定义一个接口，然后在上面添加注解，同时也支持JAX-RS标准的注解。Feign也支持可拔插式的编码器和解码器。SpringCloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。

Feign可帮助我们更加便捷，优雅的调用HTTP API。
在SpringCloud中，使用Feign非常简单——创建一个接口，并在接口上添加一些注解，代码就完成了。
Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。
SpringCloud对Feign进行了增强，使Feign支持了SpringMVC注解，并整合了Ribbon和Eureka，从而让Feign的使用更加方便。

Feign实现服务间相互请求

添加依赖

因为Feign是Netflix开发的声明式、模板化的HTTP客户端，所以原本的spring-cloud-alibaba里面没有，我们需要添加新依赖

Spring Cloud Alibaba 和Spring Cloud的对应关系如下，我们添加Spring Cloud Hoxton.SR12
在这里插入图片描述

根项目pom.xml文件修改成如下所示

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.xt</groupId>
    <artifactId>springcloud</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>nacos-provider</module>
        <module>nacos-consumer</module>
    </modules>


    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
    </parent>


    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <spring-cloud-alibaba-version>2.2.7.RELEASE</spring-cloud-alibaba-version>
        <spring-cloud-version>Hoxton.SR12</spring-cloud-version>
    </properties>


    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

    <dependencyManagement>
        <dependencies>

            <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>

            <!--为引入feign而添加的依赖-->
            <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>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.22</version>
                <scope>provided</scope>
            </dependency>

        </dependencies>
    </dependencyManagement>


</project>

需要使用Feign的nacos-consumer服务的pom.xml文件添加如下依赖

 <dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-starter-openfeign</artifactId>
 </dependency>

代码文件

在NacosConsumerApplication启动类上添加@EnableFeignClients注解开启FeignClient的功能。

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class NacosConsumerApplication {

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

    public static void main(String[] args){
        SpringApplication.run(NacosConsumerApplication.class, args);
    }

}

新建一个FeignClient，如下EchoService

FeignClient 默认集成了 Ribbon，使用 @FeignClient 注解将EchoService接口包装为 FeignClient ，其属性名称与服务名称nacos-provider对应

Feign的Fallback机制，在网络请求时，可能会出现异常请求，如果还想再异常情况下使系统可用，那么就需要容错处理，比如:网络请求超时时给用户提示“稍后重试”或使用本地快照数据等等。
当接口请求不成功时，就会调用EchoServiceFallback类这里的实现

@Component
@FeignClient(name = "nacos-provider",fallback = EchoService.EchoServiceFallback.class)
public interface EchoService {


    @RequestMapping(value = "/echo/{str}",method = RequestMethod.GET)
    String echo(@PathVariable("str") String str);

    //fallback实现类
    @Component
    class EchoServiceFallback implements EchoService{
        @Override
        public String echo(@PathVariable("str") String str) {
            return "接口请求失败";
        }
    }

}

要使用Feign的fallback机制，需要开启Feign的Hystrix的功能，nacos-consumer服务的application.yml新增配置如下：

feign:
  hystrix:
    enabled: true

控制器修改如下

@RestController
public class TestController {

    private final RestTemplate restTemplate;

    @Autowired
    public TestController(RestTemplate restTemplate) {this.restTemplate = restTemplate;}

    @RequestMapping(value = "/echo-restemplate/{str}", method = RequestMethod.GET)
    public String echo(@PathVariable String str) {
        return restTemplate.getForObject("http://nacos-provider/echo/" + str, String.class);
    }

    @Autowired
    EchoService echoService;

    @RequestMapping(value = "/echo-feign/{str}",method = RequestMethod.GET)
    public String feign(@PathVariable String str) {
        return echoService.echo(str);
    }
    
}

Feign请求服务展示

正常响应的时候，通过Feign请求nacos-provider服务
在这里插入图片描述

通过RestTemplate请求服务
在这里插入图片描述

Feign容错机制展示

将/echo改为/echo-error ,但是nacos-provider是没有提供这个/echo-error的controller的，所以Feign的容错机制会调用fallback

@Component
@FeignClient(name = "nacos-provider",fallback = EchoService.EchoServiceFallback.class)
public interface EchoService {


    @RequestMapping(value = "/echo-error/{str}",method = RequestMethod.GET)
    String echo(@PathVariable("str") String str);

    //fallback实现类
    @Component
    class EchoServiceFallback implements EchoService{
        @Override
        public String echo(@PathVariable("str") String str) {
            return "接口请求失败";
        }
    }

}

请求不成功，结果如下，Feign的容错机制生效
在这里插入图片描述
如果不适用容错机制，会直接报状态码为500的错误

References:

https://blog.csdn.net/jinjiniao1/article/details/100849237
https://www.cnblogs.com/bossen/p/5824067.html
https://github.com/alibaba/spring-cloud-alibaba/tree/master/spring-cloud-alibaba-examples/nacos-example/nacos-discovery-example
https://kaven.blog.csdn.net/article/details/109105382

（写博客主要是对自己学习的归纳整理，资料大部分来源于书籍、网络资料和自己的实践，整理不易，但是难免有不足之处，如有错误，请大家评论区批评指正。同时感谢广大博主和广大作者辛苦整理出来的资源和分享的知识。）

codingXT

关注

0
点赞
踩
7

收藏

觉得还不错? 一键收藏
4
评论
【Spring Cloud】使用RestTemplate和Feign实现微服务之间的相互请求

Nacos的简单介绍以及服务注册与发现功能的基本使用我这里采用nacos来实现服务的注册与发现然后这里展示一下两种实现服务之间相互请求的实现方式Nacos实现注册与发现服务基本都是Nacos的简单介绍以及服务注册与发现功能的基本使用这篇博客的代码，我这就不拷贝到这里了，可以到这篇博客的指定章节观看RestTemplate 简单介绍RestTemplate是由Spring提供的一个HTTP请求工具。RestTemplate是从Spring3.0开始支持的一个HTTP请求工具，它提供了常见的REST
复制链接

扫一扫