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循环队列与非循环队列的区别总结
Jun 22 Java/Android
解决ObjectMapper.convertValue() 遇到的一些问题
Jun 30 Java/Android
Spring中bean的生命周期之getSingleton方法
Jun 30 Java/Android
Spring Boot 整合 Apache Dubbo的示例代码
Jul 04 Java/Android
Spring中的使用@Async异步调用方法
Nov 01 Java/Android
解决persistence.xml配置文件修改存放路径的问题
Feb 24 Java/Android
Spring this调用当前类方法无法拦截的示例代码
Mar 20 Java/Android
mybatis-plus模糊查询指定字段
Apr 28 Java/Android
Java异常体系非正常停止和分类
Jun 14 Java/Android
OpenFeign实现远程调用
Aug 14 Java/Android
HttpClient实现表单提交上传文件
Aug 14 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
PHPMailer 中文使用说明小结
2010/01/22 PHP
php下过滤html代码的函数 提高程序安全性
2010/03/02 PHP
php用户注册页面利用js进行表单验证具体实例
2013/10/17 PHP
PHP抓取远程图片(含不带后缀的)教程详解
2016/10/21 PHP
解决thinkphp5未定义变量会抛出异常,页面错误,请稍后再试的问题
2019/10/16 PHP
JQuery中$.ajax()方法参数详解及应用
2013/12/12 Javascript
js对table的td进行相同内容合并示例详解
2013/12/27 Javascript
jquery滚动加载数据的方法
2015/03/09 Javascript
JS基于面向对象实现的拖拽库实例
2015/09/24 Javascript
jQuery获取checkboxlist的value值的方法
2015/09/27 Javascript
js格式化时间的方法
2015/12/18 Javascript
用NODE.JS中的流编写工具是要注意的事项
2016/03/01 Javascript
js获取iframe中的window对象的实现方法
2016/05/20 Javascript
JavaScript每天必学之数组和对象部分
2016/09/17 Javascript
深入学习Bootstrap表单
2016/12/13 Javascript
微信小程序实现图片自适应(支持多图)
2017/01/25 Javascript
Bootstrap栅格系统使用方法及页面调整变形的解决方法
2017/03/10 Javascript
微信小程序开发之toast等弹框提示使用教程
2017/06/08 Javascript
js中this对象用法分析
2018/01/05 Javascript
详解vue中router-link标签所必备了解的属性
2019/04/15 Javascript
vue 移动端记录页面浏览位置的方法
2020/03/11 Javascript
Openlayers实现点闪烁扩散效果
2020/09/24 Javascript
js实现贪吃蛇游戏(简易版)
2020/09/29 Javascript
在Python的Flask框架中实现单元测试的教程
2015/04/20 Python
一个基于flask的web应用诞生(1)
2017/04/11 Python
Django中的Signal代码详解
2018/02/05 Python
Python SVM(支持向量机)实现方法完整示例
2018/06/19 Python
Python 比较文本相似性的方法(difflib,Levenshtein)
2018/10/15 Python
Django-simple-captcha验证码包使用方法详解
2020/11/28 Python
CSS3实现的渐变幻灯片效果
2020/12/07 HTML / CSS
副乡长民主生活会个人对照检查材料思想汇报
2014/10/01 职场文书
堂吉诃德读书笔记
2015/06/30 职场文书
2015年小学实验室工作总结
2015/07/28 职场文书
学校2016年九九重阳节活动总结
2016/04/01 职场文书
Python Pandas数据分析之iloc和loc的用法详解
2021/11/11 Python
Spring Boot 底层原理基础深度解析
2022/04/03 Java/Android