报错展示
给产品某版本的微服务模块产品做客户化功能时,启动遇到了如下错误:
Caused by: org.springframework.beans.factory.support.BeanDefinitionOverrideException:
Invalid bean definition with name 'xxx.FeignClientSpecification' defined in null:
Cannot register bean definition [Generic bean: class [org.springframework.cloud.openfeign.FeignClientSpecification];
........
There is already ......
须知
在Spring Boot 2.0.x 中,spring.main.allow-bean-definition-overriding属性默认是 true;
注解@FeignClient 没有contextId属性;
在Spring Boot 2.1.x 中,spring.main.allow-bean-definition-overriding属性默认是 false;
注解@FeignClient 有contextId属性;
Spring Boot 2.1.x 已经通过增加contextId属性来避免了bean重复定义的问题,记得给contextId赋值啊。
情景再现
环境:
Spring Boot 2.1.6 RELEASE
Spring Cloud 2.1.2 RELEASE
OpenFeign 2.1.2 RELEASE
在自己电脑上,当前git仓库已经切换到相应代码,在原有模块的基础上,我新建了一个新的模块用于书写扩展功能的代码,当然也引用的那个模块;
在扩展功能的代码中,feign客户端代码类,新增了5个;
书写完毕后,启动项目,报错!
原因分析
报错中的 xxx.FeignClientSpecification ,xxx 正是我@FeignClient注解中value的值
然后我通过搜索确认了我当前类的 ${value} 和 ${contextId} 的值未同时在其他客户端类中重复;
那Spring启动时,为什么会提示我已经存在了呢?
为了解决此问题,我在application.properties配置了如下属性:
spring.main.allow-bean-definition-overriding = true
之后启动服务,证明配置此属性后是有效的,启动服务不报错了;
但是 Spring Boot 2.1.x 已经通过增加contextId属性来避免了bean重复定义的问题啊,允许多个客户端类,只要contextId不重复即可。
接下来我一直在为重复的原因而感到疑惑;我于是根据报错,跟踪了具体的代码:
此时 org.springframework.cloud.openfeign.FeignClientsRegistrar 类中的registerBeanDefinitions 方法执行了两次, AnnotationMetadata metadata 入参参数两次不相同,根据具体的className我终于明白了,我犯了巨大失误。
原来被我引用模块中的入口类注解仍然存在,这相当于我启动了当前模块,spring扫描了一遍,等加载到了原来模块的入口类时,spring又要重新扫描一遍,这时候便重复导致报错了。
解决办法
将被引用模块的入口类删除即可!!不要让spring扫描两遍!!