SpringCloud之@FeignClient()注解的使用方式


Posted in Java/Android onSeptember 25, 2021

@FeignClient()注解的使用

由于SpringCloud采用分布式微服务架构,难免在各个子模块下存在模块方法互相调用的情况。比如service-admin服务要调用service-card 服务的方法。

  • @FeignClient()注解就是为了解决这个问题的。
  • @FeignClient()注解的源码要求它必须在Interface接口上使用。( FeignClient注解被@Target(ElementType.TYPE)修饰,表示FeignClient注解的作用目标在接口上)

@RequestLine与其它请求不同,只需要简单写请求方式和路径就能达到请求其它服务的目的。

@FeignClient(value = "feign-server",configuration = FeignConfig.class)  //需要一个配置文件
public interface TestService {
    @RequestLine("POST /feign/test")    //对应请求方式和路径
    String feign(@RequestBody UserDO userDO);
}
@EnableFeignClients
@SpringBootConfiguration
public class FeignConfig {
    @Bean
    public Contract contract(){
        return new feign.Contract.Default();
    }
}

@FeignClient标签的常用属性如下

  • value: 服务名
  • 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的统一前缀

此外还要求服务的启动类要有@EnableFeignClients 注解才能使Fegin生效。

SpringCloud 服务间互相调用 @FeignClient注解

SpringCloud搭建各种微服务之后,服务间通常存在相互调用的需求,SpringCloud提供了@FeignClient 注解非常优雅的解决了这个问题

首先,保证几个服务都在一个Eureka中注册成功形成服务场。

如下,我一共有三个服务注册在服务场中。COMPUTE-SERVICE ; FEIGN-CONSUMER ; TEST-DEMO;

SpringCloud之@FeignClient()注解的使用方式

我在FEIGN-CONSUMER

服务中调用其他两个服务的两个接口

分别为get带参和post不带参两个接口如下这个是COMPUTE-SERVICE中的get带参方法

@RequestMapping(value = "/add" ,method = RequestMethod.GET)
public Integer add(@RequestParam Integer a, @RequestParam Integer b) {
    ServiceInstance instance = client.getLocalServiceInstance();
    Integer r = a + b;
    logger.info("/add, host:" + instance.getHost() + ", service_id:" + instance.getServiceId() + ", result:" + r);
    return r;
}

如果要在FEIGN-CONSUMER 服务中调用这个方法的话,需要在 FEIGN-CONSUMER 中新建一个接口类专门调用某一工程中的系列接口

@FeignClient("compute-service")
 public interface ComputeClient { 
     @RequestMapping(method = RequestMethod.GET, value = "/add")
     Integer add(@RequestParam(value = "a") Integer a, @RequestParam(value = "b") Integer b); 
 }

其中,@FeignClient注解中标识出准备调用的是当前服务场中的哪个服务,这个服务名在目标服务中的配置中取

spring.application.name

接下来,在@RequestMapping中设置目标接口的接口类型、接口地址等属性。然后在下面定义接口参数以及返回参数

在FEIGN-CONSUMER

Controller层调用方法的时候

将上面接口注入进来,就可以直接用了

@Autowired
 ComputeClient computeClient;
 
 @RequestMapping(value = "/add", method = RequestMethod.GET)
 public Integer add() {
     return computeClient.add(10, 20);
 }

当然,post方法同理:

这是目标接口:

@RestController
 @RequestMapping("/demo")
 @EnableAutoConfiguration
 public class HelloController {
    @RequestMapping(value = "/test",method = RequestMethod.POST)
    String test1(){
       return "hello,test1()";
    }
 }

这是在本项目定义的接口文件:

@FeignClient("test-Demo")
 public interface TestDemo {
     @RequestMapping(method = RequestMethod.POST, value = "/demo/test")
     String test();
 }

这是项目中的Controller层

@RestController
 public class ConsumerController {
     @Autowired
     TestDemo testDemo;
 
     @Autowired
     ComputeClient computeClient;
 
     @RequestMapping(value = "/add", method = RequestMethod.GET)
     public Integer add() {
         return computeClient.add(10, 20);
     }
 
     @RequestMapping(value = "/test", method = RequestMethod.GET)
     public String test() {
         return testDemo.test();
     }
 }

最终调用结果如下:

SpringCloud之@FeignClient()注解的使用方式

OK 服务间接口调用就是这样了!

以上为个人经验,希望能给大家一个参考,也希望大家多多支持三水点靠木。

Java/Android 相关文章推荐
SpringBoot实现异步事件驱动的方法
Jun 28 Java/Android
死磕 java同步系列之synchronized解析
Jun 28 Java/Android
HashMap实现保存两个key相同的数据
Jun 30 Java/Android
Spring mvc是如何实现与数据库的前后端的连接操作的?
Jun 30 Java/Android
java基础——多线程
Jul 03 Java/Android
Java 语言中Object 类和System 类详解
Jul 07 Java/Android
Java生成日期时间存入Mysql数据库的实现方法
Mar 03 Java/Android
Java实现经典游戏泡泡堂的示例代码
Apr 04 Java/Android
Java实现扫雷游戏详细代码讲解
May 25 Java/Android
ConditionalOnProperty配置swagger不生效问题及解决
Jun 14 Java/Android
springboot为异步任务规划自定义线程池的实现
Jun 14 Java/Android
tree shaking对打包体积优化及作用
Jul 07 Java/Android
springboot中rabbitmq实现消息可靠性机制详解
Sep 25 #Java/Android
Spring Cloud 中@FeignClient注解中的contextId属性详解
Sep 25 #Java/Android
关于springboot配置druid数据源不生效问题(踩坑记)
Sep 25 #Java/Android
Java使用Unsafe类的示例详解
Sep 25 #Java/Android
Spring-cloud Config Server的3种配置方式
Sep 25 #Java/Android
MyBatis-Plus 批量插入数据的操作方法
Sep 25 #Java/Android
spring cloud 配置中心native配置方式
Sep 25 #Java/Android
You might like
php下载远程文件类(支持断点续传)
2008/11/14 PHP
php控制linux服务器常用功能 关机 重启 开新站点等
2012/09/05 PHP
PHP 类相关函数的使用详解
2013/05/10 PHP
php中\r \r\n \t的区别示例介绍
2014/02/08 PHP
PHP使用fopen与file_get_contents读取文件实例分享
2016/03/04 PHP
使用laravel的migrate创建数据表的方法
2019/09/30 PHP
Javascript常用运算符(Operators)-javascript基础教程
2007/12/14 Javascript
从URL中提取参数与将对象转换为URL查询参数的实现代码
2012/01/12 Javascript
基于jQuery实现左右div自适应高度完全相同的代码
2012/08/09 Javascript
Javascript基础知识(一)核心基础语法与事件模型
2014/09/29 Javascript
javascript实现获取字符串hash值
2015/05/10 Javascript
JavaScript实现图片轮播的方法
2015/07/31 Javascript
纯JavaScript 实现flappy bird小游戏实例代码
2016/09/27 Javascript
jQuery ajax的功能实现方法详解
2017/01/06 Javascript
Vue.js 2.0中select级联下拉框实例
2017/03/06 Javascript
ES6数组的扩展详解
2017/04/25 Javascript
Vue中保存用户登录状态实例代码
2017/06/07 Javascript
JSON在Javascript中的使用(eval和JSON.parse的区别)详细解析
2017/09/05 Javascript
JavaScript定义及输出螺旋矩阵的方法详解
2017/12/01 Javascript
最简单的vue消息提示全局组件的方法
2019/06/16 Javascript
jquery.pager.js实现分页效果
2019/07/29 jQuery
python中的字典详细介绍
2014/09/18 Python
使用Python将数组的元素导出到变量中(unpacking)
2016/10/27 Python
如何用Python实现简单的Markdown转换器
2018/07/16 Python
解决tensorflow模型参数保存和加载的问题
2018/07/26 Python
python中用logging实现日志滚动和过期日志删除功能
2019/08/20 Python
python计算n的阶乘的方法代码
2019/10/25 Python
原装进口全世界:天猫国际
2016/08/03 全球购物
李宁官方网店:中国运动品牌
2017/11/02 全球购物
Jacadi Paris英国官网:法国童装品牌
2019/08/09 全球购物
介绍一下Linux内核的排队自旋锁
2014/08/27 面试题
小学领导班子对照材料
2014/08/23 职场文书
离退休人员聘用协议书
2014/11/24 职场文书
标准离婚协议书范文下载
2014/11/30 职场文书
2015高三毕业寄语赠言
2015/02/27 职场文书
使用pipenv管理python虚拟环境的全过程
2021/09/25 Python