Spring Cloud 中@FeignClient注解中的contextId属性详解


Posted in Java/Android onSeptember 25, 2021

@FeignClient注解中的contextId属性

在使用@FeignClient注解前,我们需要先引入其相关依赖,版本为3.0.1

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

例如我们有一个user服务,user服务中有很多个接口,我们通过@FeignClient来实现接口的调用,不想将所有的调用接口都定义在一个接口类中,因此构建了下述两个Feign接口类:

@FeignClient(name = "user-server")
public interface UserServerClient1 {
 @GetMapping("/user/get")
 public User getUser(@RequestParam("id") int id);
}
@FeignClient(name = "user-server")
public interface UserServerClient2 {
 @GetMapping("/user/getAll")
 public List<User> getAllUser();
}

这种情况下启动项目,项目就会报错,因为Bean的名称冲突了,具体错误如下:

Description:

The bean 'user-server.FeignClientSpecification' could not be registered. A bean with that name has already been defined and overriding is disabled.

 

Action:

Consider renaming one of the beans or enabling overriding by setting spring.main.allow-bean-definition-overriding=true

解决方法一

在yml配置文件中新增下述配置,允许出现beanName一样的BeanDefinition

spring:
  main:
    allow-bean-definition-overriding: true

解决方法二

为每个FeignClient手动指定不同的contextId,contextId的作用是用来区分FeignClient实例

@FeignClient(contextId = "userService1",name = "user-server")
public interface UserServerClient1 {
 @GetMapping("/user/get")
 public User getUser(@RequestParam("id") int id);
}
@FeignClient(contextId = "userService1",name = "user-server")
public interface UserServerClient2 {
 @GetMapping("/user/getAll")
 public List<User> getAllUser();
}

FeignClient注解及参数问题

在用分布式架构SpringBoot的SpringCloud技术开发过程中,@FeignClient 是一个常用的注解,且很重要的功能。它是Feign客户端提供负载均衡的热插拔注解,通过该注解可以动态代理创建Feign客户端。

简单理解就是,分布式架构服务之间,各子模块系统内部通信的核心。

一般在一个系统调用另一个系统的接口时使用,如下:

注解

@FeignClient("XXX")
public interface XX{
   ....
}

该注解一般创建在 interface 接口中,然后在业务类@Autowired进去使用非常简单方便。

问题背景

创建好interface接口后,当然要把调用该服务的接口方法定义出来,该方法对应本FeignClient的controller接口,必须重写该接口方法(返回对象,参数值完全一样)。

启动项目出现如下报错时,咋一看以为是在业务类中调用该接口方法时,传参为空null而报错。

FactoryBean threw exception on object creation; nested exception is

java.lang.IllegalStateException: RequestParam.value() was empty on parameter 0

当把传参用数据代替时,重新启动时;任然报如上错误。

贴一个报错全截图

org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'withdrawCountRecordController': Unsatisfied dependency expressed through field 'withdrawCountService'; nested exception is org.springframework.beans.factory.UnsatisfiedDependencyException: Error creating bean with name 'withdrawCountServiceImpl': Unsatisfied dependency expressed through field 'cumClient'; nested exception is org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'com.epaylinks.efps.pas.clr.client.CumClient': FactoryBean threw exception on object creation; nested exception is java.lang.IllegalStateException: RequestParam.value() was empty on parameter 0 at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor$AutowiredFieldElement.inject(AutowiredAnnotationBeanPostProcessor.java:588) at org.springframework.beans.factory.annotation.InjectionMetadata.inject(InjectionMetadata.java:88) at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.postProcessPropertyValues(AutowiredAnnotationBeanPostProcessor.java:366) at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.populateBean(AbstractAutowireCapableBeanFactory.java:1264) at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.doCreateBean(AbstractAutowireCapableBeanFactory.java:553) at org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory.createBean(AbstractAutowireCapableBeanFactory.java:483) at org.springframework.beans.factory.support.AbstractBeanFactory$1.getObject(AbstractBeanFactory.java:306) at org.springframework.beans.factory.support.DefaultSingletonBeanRegistry.getSingleton(DefaultSingletonBeanRegistry.java:230) at org.springframework.beans.factory.support.AbstractBeanFactory.doGetBean(AbstractBeanFactory.java:302) at org.springframework.beans.factory.support.AbstractBeanFactory.getBean(AbstractBeanFactory.java:197)

解决办法

在@FeignClien("XX") 接口类中,检查每个方法的参数定义时:

是否有如下情形

@RequestMapping(value="/XXX/query", method = RequestMethod.GET)
    public PageResult<XXutionResp> query(@RequestParam(required = false) String XXCode,
                                             @RequestParam(value = "XXnName",required = false) String institutionName,
                                             @RequestParam(value = "startTime",required = false) String startTime,

问题就在这里:

@RequestParam(required = false) String XXCode

这个参数少了个value = "XXCode", 这个是Spring 4.0版本后,@RequestParam 注解对参数传值有了很好的封装特性并严格校验。

改为:

@RequestParam(value = "XXCode", required = false) String XXCode

之后,问题完美解决;重启项目正常。

另外,插一句:当在项目多个地方调用同一个@FeignClien("XX")某项目时,在多个包中创建接口,并无影响。

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

Java/Android 相关文章推荐
Java并发编程之详解CyclicBarrier线程同步
Jun 23 Java/Android
Feign调用全局异常处理解决方案
Jun 24 Java/Android
elasticSearch-api的具体操作步骤讲解
Jun 28 Java/Android
Lombok的详细使用及优缺点总结
Jul 15 Java/Android
JavaWeb 入门篇(3)ServletContext 详解 具体应用
Jul 16 Java/Android
浅谈Java父子类加载顺序
Aug 04 Java/Android
Java spring单点登录系统
Sep 04 Java/Android
springboot+zookeeper实现分布式锁
Mar 21 Java/Android
剑指Offer之Java算法习题精讲二叉树的构造和遍历
Mar 21 Java/Android
Spring Boot 实现 WebSocket
Apr 30 Java/Android
Java 中的 Lambda List 转 Map 的多种方法详解
Jul 07 Java/Android
Springboot集成kafka高级应用实战分享
Aug 14 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
spring cloud 配置中心客户端启动遇到的问题
Sep 25 #Java/Android
SpringBoot+Vue+JWT的前后端分离登录认证详细步骤
Sep 25 #Java/Android
You might like
PHP性能优化准备篇图解PEAR安装
2011/12/05 PHP
php 字符串替换的方法
2012/01/10 PHP
PHP微商城开源代码实例
2019/03/27 PHP
PHP Cli 模式设置进程名称的方法
2019/06/12 PHP
JQuery入门——事件切换之toggle()方法应用介绍
2013/02/05 Javascript
JavaScript执行顺序详细介绍
2013/12/04 Javascript
javascript替换已有元素replaceChild()使用介绍
2014/04/03 Javascript
node中socket.io的事件使用详解
2014/12/15 Javascript
详解javascript中的事件处理
2015/11/06 Javascript
javascript中错误使用var造成undefined
2016/03/31 Javascript
js仿QQ中对联系人向左滑动、滑出删除按钮的操作
2016/04/07 Javascript
javascript和jquery实现用户登录验证
2016/05/04 Javascript
使用jQuery判断浏览器滚动条位置的方法
2016/05/30 Javascript
jQuery基于ajax操作json数据简单示例
2017/01/05 Javascript
详解js产生对象的3种基本方式(工厂模式,构造函数模式,原型模式)
2017/01/09 Javascript
JS数组去重(4种方法)
2017/03/27 Javascript
微信小程序网络请求wx.request详解及实例
2017/05/18 Javascript
JS实现二维数组元素的排列组合运算简单示例
2019/01/28 Javascript
eslint 的三大通用规则详解
2019/05/16 Javascript
vue简单练习 桌面时钟的实现代码实例
2019/09/19 Javascript
使用layer弹窗,制作编辑User信息页面的方法
2019/09/27 Javascript
[04:55]完美世界副总裁蔡玮:DOTA2的自由、公平与信任
2013/12/18 DOTA
Python实现的检测web服务器健康状况的小程序
2014/09/17 Python
Python设计实现的计算器功能完整实例
2017/08/18 Python
Python中int()函数的用法浅析
2017/10/17 Python
Python多线程扫描端口代码示例
2018/02/09 Python
对django后台admin下拉框进行过滤的实例
2019/07/26 Python
Maisons du Monde德国:法国家具和装饰的市场领导者
2019/07/26 全球购物
关键字final的用法
2013/10/02 面试题
工程造价专业大专生求职信
2013/10/06 职场文书
综合素质的自我鉴定
2013/10/07 职场文书
银行求职信怎么写
2014/05/26 职场文书
课外活动总结范文
2014/07/09 职场文书
商业用房租赁协议书
2014/10/13 职场文书
红领巾广播站广播稿
2014/10/19 职场文书
python3 字符串str和bytes相互转换
2022/03/23 Python