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 相关文章推荐
在Java中Collection的一些常用方法总结
Jun 13 Java/Android
SpringBoot2 参数管理实践之入参出参与校验的方式
Jun 16 Java/Android
SpringCloud Alibaba项目实战之nacos-server服务搭建过程
Jun 21 Java/Android
详解Java ES多节点任务的高效分发与收集实现
Jun 30 Java/Android
JavaWeb 入门篇(3)ServletContext 详解 具体应用
Jul 16 Java/Android
SpringDataJPA在Entity中常用的注解介绍
Dec 06 Java/Android
Java并发编程之原子性-Atomic的使用
Mar 16 Java/Android
教你在 Java 中实现 Dijkstra 最短路算法的方法
Apr 08 Java/Android
Java数组详细介绍及相关工具类
Apr 14 Java/Android
Android Studio 计算器开发
May 20 Java/Android
Springboot中如何自动转JSON输出
Jun 16 Java/Android
SpringBoot项目部署到阿里云服务器的实现步骤
Jun 28 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简单中奖算法(实例)
2017/08/15 PHP
PHP调用接口API封装的例子
2019/10/11 PHP
thinkphp5 + ajax 使用formdata提交数据(包括文件上传) 后台返回json完整实例
2020/03/02 PHP
百度 popup.js 完美修正版非常的不错 脚本之家推荐
2009/04/17 Javascript
关于javascript DOM事件模型的两件事
2010/07/22 Javascript
JavaScript中的16进制字符(改进)
2011/11/21 Javascript
JavaScript var声明变量背后的原理示例解析
2013/10/12 Javascript
浅析IE10兼容性问题(frameset的cols属性)
2014/01/03 Javascript
jQuery使用hide方法隐藏指定元素class样式用法实例
2015/03/30 Javascript
移动端JQ插件hammer使用详解
2015/07/03 Javascript
JS作为值的函数用法示例
2016/06/20 Javascript
web 前端常用组件之Layer弹出层组件
2016/09/22 Javascript
浅谈JS对html标签的属性的干预以及对CSS样式表属性的干预
2017/06/25 Javascript
基于JS脚本语言的基础语法详解
2017/07/22 Javascript
bootstrap时间控件daterangepicker使用方法及各种小bug修复
2017/10/25 Javascript
快速解决brew安装特定版本flow的问题
2018/05/17 Javascript
JS实现把一个页面层数据传递到另一个页面的两种方式
2018/08/13 Javascript
Vue异步组件处理路由组件加载状态的解决方案
2018/09/07 Javascript
vue监听键盘事件的相关总结
2021/01/29 Vue.js
python实现简单遗传算法
2018/03/19 Python
python获取网页中所有图片并筛选指定分辨率的方法
2018/03/31 Python
python实现socket+threading处理多连接的方法
2019/07/23 Python
pycharm开发一个简单界面和通用mvc模板(操作方法图解)
2020/05/27 Python
印度和世界各地的精美产品:Ikka Dukka
2018/02/12 全球购物
STAY JAPAN台湾:预订日本民宿
2018/07/22 全球购物
如何用Java判断一个文件或目录是否存在
2012/11/19 面试题
餐饮商业计划书范文
2014/04/29 职场文书
园林专业毕业生自荐信
2014/07/04 职场文书
教育局党的群众路线教育实践活动整改方案
2014/09/20 职场文书
会计电算化实训报告
2014/11/04 职场文书
运动会闭幕式致辞
2015/07/29 职场文书
护理专业毕业自我鉴定
2019/08/12 职场文书
MySQL中distinct与group by之间的性能进行比较
2021/05/26 MySQL
Python机器学习应用之工业蒸汽数据分析篇详解
2022/01/18 Python
pycharm无法安装cv2模块问题
2022/05/20 Python
浅谈为什么我的 z-index 又不生效了
2022/07/15 HTML / CSS