springboot FeignClient注解及参数

 更新时间:2019年12月17日 14:31:56   作者:珠混鱼目  
这篇文章主要介绍了springboot FeignClient注解及参数,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

一、FeignClient注解

FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上

@FeignClient(name = "github-client", url = "https://api.github.com", configuration = GitHubExampleConfig.class)
public interface GitHubClient {
  @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
  String searchRepo(@RequestParam("q") String queryStr);
}

声明接口之后,在代码中通过@Resource注入之后即可使用。@FeignClient标签的常用属性如下:

  • name:指定FeignClient的名称,如果项目使用了Ribbon,name属性会作为微服务的名称,用于服务发现
  • url: url一般用于调试,可以手动指定@FeignClient调用的地址
  • decode404:当发生http 404错误时,如果该字段位true,会调用decoder进行解码,否则抛出FeignException
  • configuration: Feign配置类,可以自定义Feign的Encoder、Decoder、LogLevel、Contract
  • fallback: 定义容错的处理类,当调用远程接口失败或超时时,会调用对应接口的容错逻辑,fallback指定的类必须实现@FeignClient标记的接口
  • fallbackFactory: 工厂类,用于生成fallback类示例,通过这个属性我们可以实现每个接口通用的容错逻辑,减少重复的代码
  • path: 定义当前FeignClient的统一前缀
@FeignClient(name = "github-client",
    url = "https://api.github.com",
    configuration = GitHubExampleConfig.class,
    fallback = GitHubClient.DefaultFallback.class)
public interface GitHubClient {
  @RequestMapping(value = "/search/repositories", method = RequestMethod.GET)
  String searchRepo(@RequestParam("q") String queryStr);
 
  /**
   * 容错处理类,当调用失败时,简单返回空字符串
   */
  @Component
  public class DefaultFallback implements GitHubClient {
    @Override
    public String searchRepo(@RequestParam("q") String queryStr) {
      return "";
    }
  }
}

在使用fallback属性时,需要使用@Component注解,保证fallback类被Spring容器扫描到,GitHubExampleConfig内容如下:

@Configuration
public class GitHubExampleConfig {
  @Bean
  Logger.Level feignLoggerLevel() {
    return Logger.Level.FULL;
  }
}

在使用FeignClient时,Spring会按name创建不同的ApplicationContext,通过不同的Context来隔离FeignClient的配置信息,在使用配置类时,不能把配置类放到Spring App Component scan的路径下,否则,配置类会对所有FeignClient生效.

二、Feign Client 和@RequestMapping

当前工程中有和Feign Client中一样的Endpoint时,Feign Client的类上不能用@RequestMapping注解否则,当前工程该endpoint http请求且使用accpet时会报404
Controller:

@RestController
@RequestMapping("/v1/card")
public class IndexApi {
 
  @PostMapping("balance")
  @ResponseBody
  public Info index() {
    Info.Builder builder = new Info.Builder();
    builder.withDetail("x", 2);
    builder.withDetail("y", 2);
    return builder.build();
  }
}

Feign Client

@FeignClient(
    name = "card",
    url = "http://localhost:7913",
    fallback = CardFeignClientFallback.class,
    configuration = FeignClientConfiguration.class
)
@RequestMapping(value = "/v1/card")
public interface CardFeignClient {
 
  @RequestMapping(value = "/balance", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
  Info info();
 
}  

if @RequestMapping is used on class, when invoke http /v1/card/balance, like this :

如果 @RequestMapping注解被用在FeignClient类上,当像如下代码请求/v1/card/balance时,注意有Accept header:

Content-Type:application/json
Accept:application/json
 
POST http://localhost:7913/v1/card/balance

那么会返回 404。

如果不包含Accept header时请求,则是OK:

Content-Type:application/json
POST http://localhost:7913/v1/card/balance

或者像下面不在Feign Client上使用@RequestMapping注解,请求也是ok,无论是否包含Accept:

@FeignClient(
    name = "card",
    url = "http://localhost:7913",
    fallback = CardFeignClientFallback.class,
    configuration = FeignClientConfiguration.class
)
 
public interface CardFeignClient {
 
  @RequestMapping(value = "/v1/card/balance", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_VALUE)
  Info info();
 
}

三、Feign请求超时问题

Hystrix默认的超时时间是1秒,如果超过这个时间尚未响应,将会进入fallback代码。而首次请求往往会比较慢(因为Spring的懒加载机制,要实例化一些类),这个响应时间可能就大于1秒了
解决方案有三种,以feign为例。

方法一
hystrix.command.default.execution.isolation.thread.timeoutInMilliseconds: 5000
该配置是让Hystrix的超时时间改为5秒

方法二
hystrix.command.default.execution.timeout.enabled: false
该配置,用于禁用Hystrix的超时时间

方法三
feign.hystrix.enabled: false
该配置,用于索性禁用feign的hystrix。该做法除非一些特殊场景,不推荐使用。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 图文详解Java中的字节输入与输出流

    图文详解Java中的字节输入与输出流

    在Java中所有数据都是使用流读写的,流是一组有序的数据序列,将数据从一个地方带到另一个地方,这篇文章主要给大家介绍了关于Java中字节输入与输出流的相关资料,需要的朋友可以参考下
    2021-08-08
  • Java之Spring认证使用Profile配置运行环境讲解

    Java之Spring认证使用Profile配置运行环境讲解

    这篇文章主要介绍了Java之Spring认证使用Profile配置运行环境讲解,本篇文章通过简要的案例,讲解了该项技术的了解与使用,以下就是详细内容,需要的朋友可以参考下
    2021-07-07
  • tdesign的文件上传功能实现(微信小程序+idea的springboot)

    tdesign的文件上传功能实现(微信小程序+idea的springboot)

    这篇文章主要介绍了tdesign的文件上传(微信小程序+idea的springboot)的相关知识,本文通过图文实例代码相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2023-09-09
  • ReentrantLock可重入锁原理解析

    ReentrantLock可重入锁原理解析

    这篇文章主要为大家介绍了ReentrantLock可重入锁原理解析,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-10-10
  • springboot下添加全局异常处理和自定义异常处理的过程解析

    springboot下添加全局异常处理和自定义异常处理的过程解析

    在spring项目中,优雅处理异常,好处是可以将系统产生的全部异常统一捕获处理,自定义的异常也由全局异常来捕获,如果涉及到validator参数校验器使用全局异常捕获也是较为方便,这篇文章主要介绍了springboot下添加全局异常处理和自定义异常处理,需要的朋友可以参考下
    2023-12-12
  • Spring Session的使用示例

    Spring Session的使用示例

    最近团队一个项目需要使用Session,之前没有在实际项目中使用过Spring-Session,这里记录一下使用的过程
    2021-06-06
  • IDEA 工程里 new不出来Vue文件的图文解决方案

    IDEA 工程里 new不出来Vue文件的图文解决方案

    这篇文章主要介绍了IDEA 工程里 new不出来Vue文件的解决方案,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • java中类与对象的使用详情

    java中类与对象的使用详情

    这篇文章主要介绍了java中类与对象的使用详情,面向对象是通过类和对象去描述和代表万千事物对象的,首先我们需要知道如何去定义一个类,下面文章我们详细介绍两者的使用方法,需要的小伙伴可以参考一下
    2022-05-05
  • Spring中的@RefreshScope注解作用

    Spring中的@RefreshScope注解作用

    这篇文章主要介绍了Spring中的@RefreshScope注解作用详解,@RefreshScope注解是Spring Cloud中的一个重要注解,用于实现动态刷新配置的功能,当我们在应用程序中使用@Value注解获取配置属性时,如果配置发生变化,需要重启应用程序才能生效,需要的朋友可以参考下
    2023-10-10
  • 基于maven使用IDEA创建多模块项目

    基于maven使用IDEA创建多模块项目

    这篇文章主要介绍了基于maven使用IDEA创建多模块项目,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-04-04

最新评论