微服务组件之OpenFeign\Feign的区别、RequestInterceptor配置全局拦截器、局部拦截器详解

本文主要是介绍微服务组件之OpenFeign\Feign的区别、RequestInterceptor配置全局拦截器、局部拦截器详解,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

Feign和OpenFeign 

Feign

       Feign是Spring Cloud组件中的一个轻量级RESTful的HTTP服务客户端,Feign内置了Ribbon,用来做客户端负载均衡,去调用服务注册中心的服务。Feign的使用方式是:使用Feign的注解定义接口,调用这个接口,就可以调用服务注册中心的服务。

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

OpenFeign

        OpenFeign是springcloud在Feign的基础上支持了SpringMVC的注解,如@RequestMapping等等。OpenFeign的@FeignClient可以解析SpringMVC的@RequestMapping注解下的接口,并通过动态代理的方式产生实现类,实现类中做负载均衡并调用其他服务。

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

RequestInterceptor请求拦截器

        RequestInterceptor是OpenFeign提供的一个拦截器,它可以在每一次接口调用之前,对这个接口进行拦截器,你可以对这个接口做一些额外的处理,例如:权限认证、添加请求头信息等等操作。         

        RequestInterceptor的使用步骤包括如下:

  • 实现RequestInterceptor请求拦截器。
  • 对实现的拦截器进行配置,分为全局配置以及局部配置。

实现RequestInterceptor请求拦截器

        自定义一个类,实现RequestInterceptor接口,重写apply()方法:

package com.gitee.code.interceptor;import feign.RequestInterceptor;
import feign.RequestTemplate;/*** @version 1.0.0* @Copyright (C) * @Description: 请求拦截器*/
public class CustomFeignInterceptor implements RequestInterceptor {@Overridepublic void apply(RequestTemplate requestTemplate) {// TODO 在这里可以实现一些自定义的逻辑,例如:用户认证System.out.println("执行拦截器....");requestTemplate.query("name","Allen") ;requestTemplate.header(header, "secret"); //作用 :统一加 Headers : }
}

        配置类指定我们的自定义拦截器,拦截器需要继承RequestInterceptor,实现 apply(RequestTemplate requestTemplate)方法。在这个方法我们拿到了被拦截请求的RestTemplate实例,就可以往里面扔公共参数啦~

        在这里调用query,就是追加一个新的query param,还有其他api如header、body等等,按需调用即可。调用header,就是向请求头中添加一个header字段,其值为secret。

全局配置拦截器 

        上面虽然写好了拦截器,但是OpenFeign还不知道有这个拦截器,所以还需要通过配置,告诉OpenFeign使用我自己编写的拦截器。编写一个配置类,使用@Configuration注解,并且使用@Bean注解将RequestInterceptor注入到IOC容器里面。

        注意:这种方式配置的拦截器,是对所有的FeignClient都生效的。

package com.gitee.code.config;import com.gitee.code.interceptor.CustomFeignInterceptor;
import feign.RequestInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;/*** @version 1.0.0* @Description: OpenFeign 配置类*/
@Configuration
public class FeignConfig {/*** 注入自定义的拦截器*/@Beanpublic RequestInterceptor requestInterceptor() {return new CustomFeignInterceptor();}}

局部配置拦截器

        局部拦截器不同于全局拦截器,强调的是1对1配置【对于某一个FeignClient下的所有接口生效】,此时不需要在配置FeignConfig上面添加注解@Configuration,而是在@FeignClient注解的configuration参数指定一个配置类。示例如下所示:

@FeignClient(name = "auth",configuration = FeginConfig.class)
public interface AuthFeignService {/*** 该接口需要传输的http header ,需要每次手动传输header * 比较麻烦,重复代码多* /@PostMapping("/role/user/isSystemAdmin1")Boolean isSystemAdmin(@RequestBody Map entity,@RequestHeader String secret);/*** 拦截器 FeginHeaderInterceptor 自动配置传输参数 header,无需每次手动传输* 大大简化接口参数,减少手写冗余代码参数* /@PostMapping("/role/user/isSystemAdmin2")Boolean isSystemAdmin(@RequestBody Map entity);} 

        除了上面所述在FeignClient中通过configuration指定配置项,也可以通过在配置文件【application.yml】中指定局部拦截器。

# feign 配置
feign:client:config:# 这里写微服务的服务名称,例如:我这里写的是 service-provider 服务名称# 针对 service-provider 微服务的请求,都将执行这些配置信息service-provider:loggerlevel: full# 配置请求拦截器,可以多个requestInterceptors:- com.gitee.code.interceptor.CustomFeignInterceptor

参考文献

feign 全局 与 局部拦截器的区分与使用_feigninterceptor局部拦截-CSDN博客

Feign Interceptor 拦截器实现全局请求参数_feign拦截器获取请求参数-CSDN博客 

 

这篇关于微服务组件之OpenFeign\Feign的区别、RequestInterceptor配置全局拦截器、局部拦截器详解的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

一文深入详解Python的secrets模块

《一文深入详解Python的secrets模块》在构建涉及用户身份认证、权限管理、加密通信等系统时,开发者最不能忽视的一个问题就是“安全性”,Python在3.6版本中引入了专门面向安全用途的secr... 目录引言一、背景与动机:为什么需要 secrets 模块?二、secrets 模块的核心功能1. 基

一文详解MySQL如何设置自动备份任务

《一文详解MySQL如何设置自动备份任务》设置自动备份任务可以确保你的数据库定期备份,防止数据丢失,下面我们就来详细介绍一下如何使用Bash脚本和Cron任务在Linux系统上设置MySQL数据库的自... 目录1. 编写备份脚本1.1 创建并编辑备份脚本1.2 给予脚本执行权限2. 设置 Cron 任务2

一文详解如何在idea中快速搭建一个Spring Boot项目

《一文详解如何在idea中快速搭建一个SpringBoot项目》IntelliJIDEA作为Java开发者的‌首选IDE‌,深度集成SpringBoot支持,可一键生成项目骨架、智能配置依赖,这篇文... 目录前言1、创建项目名称2、勾选需要的依赖3、在setting中检查maven4、编写数据源5、开启热

Python常用命令提示符使用方法详解

《Python常用命令提示符使用方法详解》在学习python的过程中,我们需要用到命令提示符(CMD)进行环境的配置,:本文主要介绍Python常用命令提示符使用方法的相关资料,文中通过代码介绍的... 目录一、python环境基础命令【Windows】1、检查Python是否安装2、 查看Python的安

HTML5 搜索框Search Box详解

《HTML5搜索框SearchBox详解》HTML5的搜索框是一个强大的工具,能够有效提升用户体验,通过结合自动补全功能和适当的样式,可以创建出既美观又实用的搜索界面,这篇文章给大家介绍HTML5... html5 搜索框(Search Box)详解搜索框是一个用于输入查询内容的控件,通常用于网站或应用程

Before和BeforeClass的区别及说明

《Before和BeforeClass的区别及说明》:本文主要介绍Before和BeforeClass的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录Before和BeforeClass的区别一个简单的例子当运行这个测试类时总结Before和Befor

Redis Cluster模式配置

《RedisCluster模式配置》:本文主要介绍RedisCluster模式配置,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录分片 一、分片的本质与核心价值二、分片实现方案对比 ‌三、分片算法详解1. ‌范围分片(顺序分片)‌2. ‌哈希分片3. ‌虚

SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志

《SpringBoot项目配置logback-spring.xml屏蔽特定路径的日志》在SpringBoot项目中,使用logback-spring.xml配置屏蔽特定路径的日志有两种常用方式,文中的... 目录方案一:基础配置(直接关闭目标路径日志)方案二:结合 Spring Profile 按环境屏蔽关

Python中使用uv创建环境及原理举例详解

《Python中使用uv创建环境及原理举例详解》uv是Astral团队开发的高性能Python工具,整合包管理、虚拟环境、Python版本控制等功能,:本文主要介绍Python中使用uv创建环境及... 目录一、uv工具简介核心特点:二、安装uv1. 通过pip安装2. 通过脚本安装验证安装:配置镜像源(可

C++ 函数 strftime 和时间格式示例详解

《C++函数strftime和时间格式示例详解》strftime是C/C++标准库中用于格式化日期和时间的函数,定义在ctime头文件中,它将tm结构体中的时间信息转换为指定格式的字符串,是处理... 目录C++ 函数 strftipythonme 详解一、函数原型二、功能描述三、格式字符串说明四、返回值五