SpringCloud学习笔记之OpenFeign进行服务调用

更新时间：2022年01月14日 12:44:29 作者：崇尚学技术的科班人

OpenFeign对feign进行进一步的封装,添加了springmvc的一些功能,更加强大,下面这篇文章主要给大家介绍了关于SpringCloud学习笔记之OpenFeign进行服务调用的相关资料,需要的朋友可以参考下

前言

Feign是一个声明式的Web服务客户端，是面向接口编程的。也就是说使用Feign，只需要创建一个接口并使用注解方式配置它，就可以完成对微服务提供方的接口绑定。

在使用RestTemplate时，每次调用服务都需要指定服务的具体路径，当在多个地方同时使用时要写多次，显得代码冗余也难以维护，而openfeign就可以避免这种操作。

1、OpenFeign

1.1、OpenFeign概述

1. 是什么？

Feign是一个声明式的web服务客户端，让编写web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可。

源码地址

2. 能干嘛？

Feign旨在使编写Java Http客户端变得更容易。
前面的服务调用在使用Ribbon + RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模板化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些以来服务的调用。所以，Feign在此基础上做了进一步封装，由他来帮助我们定义和实现依赖服务接口的定义。在Feign的实现下，我们只需创建一个接口并使用注解的方式来配置它（以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标志一个Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring Cloud Ribbon时，自动封装服务调用客户端的开发量。
Feign集成了Ribbon，利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过Feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

3. Feign和OpenFeign的区别

Feign	OpenFeign
Feign是SpringCloud组件中的一个轻量级restful的Http服务客户端，Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务。Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务	OpenFeign是SpringCloud在Feign的基础上支持了SpringMVC的注解，如@RequestMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口，并通过动态代理的方式实现类，实现类中做负载均衡并调用其他服务

1.2、OpenFeign的使用步骤

1. 建Module

Module的名称为cloud-consumer-feign-order80。

2. 改POM

<?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">
    <parent>
        <artifactId>cloud02</artifactId>
        <groupId>com.xiao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>cloud-consumer-feign-order80</artifactId>

    <!--openfeign-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.xiao</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

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

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
</project>

3. 改YML

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka

4. 主启动

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients 		//开启OpenFeign
public class OrderFeignMain80 {
    public static void main(String[] args) {
        SpringApplication.run(OrderFeignMain80.class,args);
    }
}

@EnableFeignClients开启OpenFeign

5. PaymentFeignService接口

import com.xiao.cloud.entities.CommonResult;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.stereotype.Component;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;


@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")  // 使用OpenFeign
public interface PaymentFeignService {

    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);
}

@FeignClient(value = "CLOUD-PAYMENT-SERVICE")使用OpenFeign。

6. Controller类

import com.xiao.cloud.entities.CommonResult;
import com.xiao.cloud.entities.Payment;
import com.xiao.cloud.service.PaymentFeignService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class PaymentFeignController {

    @Autowired
    private PaymentFeignService paymentFeignService;


    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
        return paymentFeignService.getPaymentById(id);
    }
}

7. 测试结果

当我们多次点击刷新时，端口在8001和8002之间依次变化。

8. 小总结

1.3、超时控制

1.3.1、是什么？

默认Feign客户端只等待一秒钟，但是服务端处理需要超过1秒钟，导致Feign客户端不想等待了，直接返回报错。为了避免这样的情况，有时候我们需要设置Feign客户端的超时控制。

在yml文件中开启配置。

1.3.2、修改代码设置超时错误

1. 修改支付模块8001的Controller

添加以下代码

    @GetMapping(value = "/payment/feign/timeout")
    public String timeOUt(){
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return ServerPort;
    }

2. 修改订单模块的PaymentFeignService

添加以下代码

    @GetMapping(value = "/payment/feign/timeout")
    public String timeOUt();

3. 修改订单模块的OrderFeignController

添加以下代码

    @GetMapping(value = "/consumer/payment/feign/timeout")
    public String timeOUt(){
        return paymentFeignService.timeOUt();
    }

4. 测试结果

直接对支付模块8001的暴露的服务接口进行调用，测验通过。

如果通过订单模块进行调用，那么就会报超时错误。

1.3.3、进行超时配置

在订单模块的YML文件中添加以下代码

ribbon:
  ReadTimeout:  8000
  ConnectTimeout: 8000

1. 测试结果

自测通过。

1.4、日志打印

1.4.1、是什么？

Feign提供了日志打印功能，我们可以通过配置来调整日志级别，从而了解Feign中Http请求的细节。就是对feign接口调用的情况进行监控和输出。

1.4.2、日志级别

NONE：默认的，不显示任何日志
BASIC：仅记录请求方法、URL、响应状态码及执行时间
HEADERS：除了BASIC中定义的信息之外，还有请求和响应的头信息
FULL：除了HEADERS中定义的信息之外，还有请求和响应的正文及元数据。

1.4.3、如何开启日志打印

1. 编写日志配置类

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

2. 在YML文件中进行相关配置

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka

ribbon:
  ReadTimeout:  8000
  ConnectTimeout: 8000

logging:
  level:
    com.atguigu.springcloud.service.PaymentFeignService: debug

3. 测试结果

4. 包结构图示

总结

到此这篇关于SpringCloud学习笔记之OpenFeign进行服务调用的文章就介绍到这了,更多相关SpringCloud OpenFeign服务调用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

一文揭晓如何在Java中终止一个线程
工作中我们经常会用到线程，一般情况下我们让线程执行就完事了，那么你们有没有想过如何去终止一个正在运行的线程呢？本文就来带大家一起看看
2023-03-03
Spring Boot详解整合JWT教程
JWT是目前比较流行的跨域认证解决方案，本文主要介绍了SpringBoot整合JWT的实现示例，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-07-07
Springboot通用mapper和mybatis-generator代码示例
这篇文章主要介绍了Springboot通用mapper和mybatis-generator代码示例,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-12-12
Java并发之搞懂读写锁
这篇文章主要介绍了Java并发之读写锁,文中相关实例代码详细，测试可用，具有一定参考价值，需要的朋友可以了解下,希望能够给你带来帮助
2021-11-11
一文掌握Java开发工具Maven(简单上手)
掌握maven的相关知识是Java开发必备的技能，今天通过本文从入门安装开始，逐步深入讲解maven的相关知识，包括maven的安装到简单上手maven项目开发，感兴趣的朋友跟随小编一起看看吧
2021-06-06
最简单的java生成word文档方法
这篇文章主要介绍了java生成word文档最简单的方法，首先说明，使用该方法时，尽量不要使用wps新建word文档，经测试，手机不能兼容，出现很多格式问题，office则手机可以很好的兼容，所以，本文以office做教程
2021-08-08
Springboot事务失效的原因及解决办法详解
这篇文章主要介绍了Springboot事务失效的原因及解决办法详解,spring中的事务是依赖AOP的,AOP是通过动态代理实现的,只有通过代理类访问的方法才能被拦截,而addMultiFile直接内部调用了addFile方法,所以addFile中的事务就不会生效
2023-10-10
Java创建多线程的8种方式集合
这篇文章主要介绍了Java创建多线程的8种方式集合，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
springboot2.0如何通过fastdfs实现文件分布式上传
这篇文章主要介绍了springboot2.0如何通过fastdfs实现文件分布式上传,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-12-12
Spring循环依赖正确性及Bean注入的顺序关系详解
这篇文章主要给大家介绍了关于Spring循环依赖的正确性，以及Bean注入的顺序关系的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧。
2018-01-01