@FeignClient注解中的contextId屬性

在使用@FeignClient注解前，我們需要先引入其相關(guān)依賴(lài)，版本為3.0.1

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

例如我們有一個(gè)user服務(wù)，user服務(wù)中有很多個(gè)接口，我們通過(guò)@FeignClient來(lái)實(shí)現(xiàn)接口的調(diào)用，不想將所有的調(diào)用接口都定義在一個(gè)接口類(lèi)中，因此構(gòu)建了下述兩個(gè)Feign接口類(lèi)：

@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();
}

這種情況下啟動(dòng)項(xiàng)目，項(xiàng)目就會(huì)報(bào)錯(cuò)，因?yàn)锽ean的名稱(chēng)沖突了，具體錯(cuò)誤如下：

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配置文件中新增下述配置，允許出現(xiàn)beanName一樣的BeanDefinition

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

解決方法二

為每個(gè)FeignClient手動(dòng)指定不同的contextId，contextId的作用是用來(lái)區(qū)分FeignClient實(shí)例

@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注解及參數(shù)問(wèn)題

在用分布式架構(gòu)SpringBoot的SpringCloud技術(shù)開(kāi)發(fā)過(guò)程中，@FeignClient 是一個(gè)常用的注解，且很重要的功能。它是Feign客戶(hù)端提供負(fù)載均衡的熱插拔注解，通過(guò)該注解可以動(dòng)態(tài)代理創(chuàng)建Feign客戶(hù)端。

簡(jiǎn)單理解就是，分布式架構(gòu)服務(wù)之間，各子模塊系統(tǒng)內(nèi)部通信的核心。

一般在一個(gè)系統(tǒng)調(diào)用另一個(gè)系統(tǒng)的接口時(shí)使用，如下：

注解

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

該注解一般創(chuàng)建在 interface 接口中，然后在業(yè)務(wù)類(lèi)@Autowired進(jìn)去使用非常簡(jiǎn)單方便。

問(wèn)題背景

創(chuàng)建好interface接口后，當(dāng)然要把調(diào)用該服務(wù)的接口方法定義出來(lái)，該方法對(duì)應(yīng)本FeignClient的controller接口，必須重寫(xiě)該接口方法（返回對(duì)象，參數(shù)值完全一樣）。

啟動(dòng)項(xiàng)目出現(xiàn)如下報(bào)錯(cuò)時(shí)，咋一看以為是在業(yè)務(wù)類(lèi)中調(diào)用該接口方法時(shí)，傳參為空null而報(bào)錯(cuò)。

FactoryBean threw exception on object creation; nested exception is

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

當(dāng)把傳參用數(shù)據(jù)代替時(shí)，重新啟動(dòng)時(shí)；任然報(bào)如上錯(cuò)誤。

貼一個(gè)報(bào)錯(cuò)全截圖

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") 接口類(lèi)中，檢查每個(gè)方法的參數(shù)定義時(shí)：

是否有如下情形

@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,

問(wèn)題就在這里：

@RequestParam(required = false) String XXCode

這個(gè)參數(shù)少了個(gè)value = "XXCode", 這個(gè)是Spring 4.0版本后，@RequestParam 注解對(duì)參數(shù)傳值有了很好的封裝特性并嚴(yán)格校驗(yàn)。

改為：

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

之后，問(wèn)題完美解決；重啟項(xiàng)目正常。

另外，插一句：當(dāng)在項(xiàng)目多個(gè)地方調(diào)用同一個(gè)@FeignClien("XX")某項(xiàng)目時(shí)，在多個(gè)包中創(chuàng)建接口，并無(wú)影響。

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論