springcloud-fegin 组件调用

2024-04-13 09:36

本文主要是介绍springcloud-fegin 组件调用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

一、Feign 概述

Feign是Netflix开发的声明式、模板化的HTTP客户端, Feign可以帮助我们更快捷、优雅地调用HTTP API。

在Spring Cloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。

Spring Cloud对Feign进行了增强,使Feign支持了Spring MVC注解,并整合了Ribbon和Eureka,从而让Feign的使用更加方便。

Spring Cloud Feign是基于Netflix feign实现,整合了Spring Cloud Ribbon和Spring Cloud Hystrix,除了提供这两者的强大功能外,还提供了一种声明式的Web服务客户端定义的方式。

Spring Cloud Feign帮助我们定义和实现依赖服务接口的定义。在Spring Cloud feign的实现下,只需要创建一个接口并用注解方式配置它,即可完成服务提供方的接口绑定,简化了在使用Spring Cloud Ribbon时自行封装服务调用客户端的开发量。

1.1 Fegin 常用注解

OpenFeign 常用注解OpenFeign 声明式服务调用和负载均衡组件,因此它的核心是使用注解 + 接口的方式实现服务调用,所以了解 OpenFeign 的注解就至关重要了。 对于 Feign 框架来说,它只支持 Feign 注解和 JAX-RS 注解,但 OpenFeign 在 Feign 的基础上还增加了对 Spring MVC 注解的支持,例如 @RequestMapping、@GetMapping 和 @PostMapping 等注解。 OpenFeign 常用注解有以下几个:

  • @EnableFeignClients:该注解用于开启 OpenFeign 功能,当 Spring Cloud 应用启动时,OpenFeign 会扫描标有 @FeignClient 注解的接口,生成代理并注册到 Spring 容器中。
  • @FeignClient:该注解用于通知 OpenFeign 组件对 @RequestMapping 注解下的接口进行解析,并通过动态代理的方式产生实现类,实现负载均衡和服务调用。
  • @RequestMapping:向服务提供者发起 Request 请求(默认为 GET 方式请求),这里需要注意@RequestMapping/@GetMapping/@PostMapping 和 Spring MVC 中的同名注解的含义是完全不同的。
  • @GetMapping:向服务提供者发起 GET 请求。
  • @PostMapping:向服务提供者发起 POST 请求。

1.2 Feign调用过程

OpenFeign 是用在服务消费端的,有消费端就得有服务提供端,它们的关系如下图所示:
在这里插入图片描述
所以我们先要创建一个服务提供者 Provider;提供者fegin在调用时没有什么特别注意的,提供者没有什么需要注意的,只需要把提供者注入到注册中心,消费者就会从注册中心获取提供者。消费搭建搭建如下

二、组件引入搭建

1.在服务消费者端引入fegin 依赖包

在服务消费者端引入jar包

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

如果配合注册中心使用的话还需要引入注册中心的客户端包

      <dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-config</artifactId></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-eureka-client</artifactId></dependency>

2. 在启动类中启动fegin 功能


@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients(basePackages = {"api.config.env.client"})
public class AmasterWorkServerApplication {public static void main(String[] args) {SpringApplication.run(AmasterWorkServerApplication.class, args);}}

说明 :
@EnableFeignClients 需要指定 fegin的 接口feginClient 所在的接口位置 ,@EnableFeignClients(basePackages ={XXX } 属性,否在 在spring 启动的时候注入 feginClient 所在的接口注入不到spring中,启动会报注入失败异常!

3. 声明FeignClient接口

3.1 @FeignClient 注解属性说明

@FeignClient注解属性

  • name:指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现
  • url: url一般用于调试,可以手动指定@FeignClient调用的地址
  • decode404:当发生http 404错误时,如果该字段位true,会调用decoder进行解码,否则抛出FeignException
  • configuration: Feign配置类,可以自定义Feign的Encoder、Decoder、LogLevel、Contract
  • allback: 定义容错的处理类,当调用远程接口失败或超时时,会调用对应接口的容错逻辑,fallback指定的类必须实现
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;import java.util.List;@FeignClient(name = "amaster-config-env"/*, url = "远程服务URL"*/,path = "amaster-config-env")
public interface ConfigEnvServiceClient {@RequestMapping(value="/env/get/env/all/v1",method = RequestMethod.GET)public List<String> getEnvConfig();
}

在这里插入图片描述
在FeignClient 接口中需要用@FeignClient 注解标注为Feign 客户端,还需要指定 消费这服务名,服务的容器path 路径。如果不指定 path 话,在接口调用的时候会报找不到feign报UnknownHostException:服务名解决方案 ,或者报404 找不到消费者的接口路径。再指定url属性的时候,feginClient 客户端优先使用url进行调用。

如果FeignClient接口参数少了@RequestBody或@RequestParam注解会造成调用服务提供者时出现参数为空现象。(当然无论是服务提供者还是调用者都要加上注解)

4.测试

调用消费者
GET http://localhost:9005/amaster-work-server/env/get/config/env/all/v1
会把提供者接口的结果返回

[“amaster-report-server prod hello world123”]

如果走网关调用也会输出
http://localhost:8070/amaster-work-server/env/get/config/env/all/v1

[“amaster-report-server prod hello world123”]

三. fegin的请求拦截处理

对于Fegin 调用前的拦截调用统一处理可以使用, feign的RequestInterceptor,拦截器进行拦截处理,比如在调用前可以统一给调用的header添加token等处理

class FeignRequestHeaderInterceptor implements RequestInterceptor {@Overridepublic void apply(RequestTemplate requestTemplate) {MethodMetadata methodMetadata = requestTemplate.methodMetadata();// 这个就是当前被@FeignClient注解的feign接口类型Class<?> classDecorateByFeignClientAnnotation = methodMetadata.method().getDeclaringClass();// 获取到path之后, 向rquest header塞入一个约定的键值对, 或者基于ThreadLocal, 向下传递给我们的`LoadBalancerFeignClientEx`......}
}

feign技巧 - 同时支持基于url和服务名的调度:https://blog.csdn.net/lqzkcx3/article/details/130269543

四、fegin传递参数与spring MVC 传参的不同 (待定)

Feign默认使用@RequestBody,这就是上面name参数为null的原因,@RequestBody(只能有一个)一般用于传递对象,如果参数中出现多个对象可以使用Map来传递对象

@FeignClient(name = "hello")  
public interface IHelloService {  @RequestMapping(value = "/hello",method = RequestMethod.GET)  String saveBook(@RequestBody Book book);  
}  

参考博客:
https://blog.csdn.net/justry_deng/article/details/80785973
https://blog.csdn.net/qq_34912478/article/details/81387422

五、 服务之间调用的几种方式比较待定(待定)

使用RestTemplet 进行服务调用时候的负载均衡处理

https://blog.csdn.net/baidu_39378193/article/details/125029430
https://blog.csdn.net/djrm11/article/details/114526346

六、OpenFeign 介绍

OpenFeign 介绍OpenFeign 的全称是 Spring Cloud OpenFeign,它是 Spring 官方推出的一种声明式服务调用和负载均衡组件。它的出现就是为了替代已经进入停更维护状态的 Feign(Netflix Feign)的。也就是说 OpenFeign(Spring Cloud OpenFeign)是 Feign 的升级版,它们的关系如下图所示

在这里插入图片描述
因为 Feign 停更维护了,所以 Spring 官方需要推出了一个新的新的框架来对 Feign 功能进行升级和扩展。

这篇关于springcloud-fegin 组件调用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/899777

相关文章

一文详解SpringBoot中控制器的动态注册与卸载

《一文详解SpringBoot中控制器的动态注册与卸载》在项目开发中,通过动态注册和卸载控制器功能,可以根据业务场景和项目需要实现功能的动态增加、删除,提高系统的灵活性和可扩展性,下面我们就来看看Sp... 目录项目结构1. 创建 Spring Boot 启动类2. 创建一个测试控制器3. 创建动态控制器注

Java操作Word文档的全面指南

《Java操作Word文档的全面指南》在Java开发中,操作Word文档是常见的业务需求,广泛应用于合同生成、报表输出、通知发布、法律文书生成、病历模板填写等场景,本文将全面介绍Java操作Word文... 目录简介段落页头与页脚页码表格图片批注文本框目录图表简介Word编程最重要的类是org.apach

Spring Boot中WebSocket常用使用方法详解

《SpringBoot中WebSocket常用使用方法详解》本文从WebSocket的基础概念出发,详细介绍了SpringBoot集成WebSocket的步骤,并重点讲解了常用的使用方法,包括简单消... 目录一、WebSocket基础概念1.1 什么是WebSocket1.2 WebSocket与HTTP

SpringBoot+Docker+Graylog 如何让错误自动报警

《SpringBoot+Docker+Graylog如何让错误自动报警》SpringBoot默认使用SLF4J与Logback,支持多日志级别和配置方式,可输出到控制台、文件及远程服务器,集成ELK... 目录01 Spring Boot 默认日志框架解析02 Spring Boot 日志级别详解03 Sp

java中反射Reflection的4个作用详解

《java中反射Reflection的4个作用详解》反射Reflection是Java等编程语言中的一个重要特性,它允许程序在运行时进行自我检查和对内部成员(如字段、方法、类等)的操作,本文将详细介绍... 目录作用1、在运行时判断任意一个对象所属的类作用2、在运行时构造任意一个类的对象作用3、在运行时判断

java如何解压zip压缩包

《java如何解压zip压缩包》:本文主要介绍java如何解压zip压缩包问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Java解压zip压缩包实例代码结果如下总结java解压zip压缩包坐在旁边的小伙伴问我怎么用 java 将服务器上的压缩文件解压出来,

SpringBoot中SM2公钥加密、私钥解密的实现示例详解

《SpringBoot中SM2公钥加密、私钥解密的实现示例详解》本文介绍了如何在SpringBoot项目中实现SM2公钥加密和私钥解密的功能,通过使用Hutool库和BouncyCastle依赖,简化... 目录一、前言1、加密信息(示例)2、加密结果(示例)二、实现代码1、yml文件配置2、创建SM2工具

Spring WebFlux 与 WebClient 使用指南及最佳实践

《SpringWebFlux与WebClient使用指南及最佳实践》WebClient是SpringWebFlux模块提供的非阻塞、响应式HTTP客户端,基于ProjectReactor实现,... 目录Spring WebFlux 与 WebClient 使用指南1. WebClient 概述2. 核心依

Spring Boot @RestControllerAdvice全局异常处理最佳实践

《SpringBoot@RestControllerAdvice全局异常处理最佳实践》本文详解SpringBoot中通过@RestControllerAdvice实现全局异常处理,强调代码复用、统... 目录前言一、为什么要使用全局异常处理?二、核心注解解析1. @RestControllerAdvice2

Spring IoC 容器的使用详解(最新整理)

《SpringIoC容器的使用详解(最新整理)》文章介绍了Spring框架中的应用分层思想与IoC容器原理,通过分层解耦业务逻辑、数据访问等模块,IoC容器利用@Component注解管理Bean... 目录1. 应用分层2. IoC 的介绍3. IoC 容器的使用3.1. bean 的存储3.2. 方法注