spring cloud-Feign使用中遇到的问题总结

本文总结了使用 Feign 调用 RESTful API 的常见问题及其解决办法,包括注解使用不当导致的异常、路径变量及请求参数处理等。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >


转载:http://blog.youkuaiyun.com/liuchuanhong1/article/details/54728681


问题一:

在前面的示例中,我们讲过

[java]  view plain  copy
  1. @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)  
  2. @GetMapping("/user/{id}")  
这两个注解的效果是等价的,但是在Feign使用中,只能用上面的那种方式,不能直接用@GetMapping,下面我们将前面的那个示例中,改成@GetMapping注解看下效果,我们发现,修改注解后重新启动服务的时候,抛了如下异常:

[java]  view plain  copy
  1. Caused by: java.lang.IllegalStateException: Method findById not annotated with HTTP method type (ex. GET, POST)  
异常的意思是,我们没有指定HTTP的方法

问题二:

在前面的示例中,我们暴漏Restful服务的方式如下:

[java]  view plain  copy
  1. @GetMapping("/template/{id}")  
  2.     public User findById(@PathVariable Long id) {  
  3.         return client.findById(id);  
  4.     }  
这里,findById方法的参数中,我们直接使用了
[java]  view plain  copy
  1. @PathVariable Long id  
下面我们将Feign的方式也改成这种

[java]  view plain  copy
  1. @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)  
  2.     User findById(@PathVariable Long id);  
然后启动服务,我们发现,又抛异常了,异常信息如下:

[java]  view plain  copy
  1. Caused by: java.lang.IllegalStateException: PathVariable annotation was empty on param 0.  
大概的意思是PathVariable注解的第一个参数不能为空,我们改成如下的方式:

[java]  view plain  copy
  1. @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)  
  2.     User findById(@PathVariable("id") Long id);  

再启动,发现一切都ok了。

问题三:多参数问题

[java]  view plain  copy
  1. @RequestMapping(value="/user/name", method=RequestMethod.GET)  
  2.     User findByUsername(final String userName,  final String address);  
启动服务的时候,会报如下异常:

[java]  view plain  copy
  1. Caused by: java.lang.IllegalStateException: Method has too many Body parameters: public abstract com.chhliu.springboot.restful.vo.User com.chhliu.springboot.restful.feignclient.UserFeignClient.findByUsername(java.lang.String,java.lang.String)  

异常原因:当使用Feign时,如果发送的是get请求,那么需要在请求参数前加上@RequestParam注解修饰,Controller里面可以不加该注解修饰。

上面问题的解决方案如下:

[java]  view plain  copy
  1. @RequestMapping(value="/user/name", method=RequestMethod.GET)  
  2.     User findByUsername(@RequestParam("userName"final String userName, @RequestParam("address"final String address);  

问题四:Request method 'POST' not supported

错误代码示例:

[java]  view plain  copy
  1. @RequestMapping(value="/user/name", method=RequestMethod.GET)  
  2.     User findByUsername(final String userName, @RequestParam("address"final String address);  

注意:上面的userName参数没有用@RequestParam注解修饰,然后发送请求,会发现被调用的服务一直报Request method 'POST' not supported,我们明明使用的是GET方法,为什么被调用服务认为是POST方法了,原因是当userName没有被@RequestParam注解修饰时,会自动被当做request body来处理。只要有body,就会被feign认为是post请求,所以整个服务是被当作带有request parameter和body的post请求发送出去的。



`spring-cloud-starter-feign` 是早期版本中使用的依赖名称,但在 Spring Cloud 的后续版本中已经被废弃。取而代之的是 `spring-cloud-starter-openfeign`[^3]。 如果需要在 Maven 项目中引入 OpenFeign 支持,则应在项目的 `pom.xml` 文件中添如下依赖: ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> ``` 需要注意的是,OpenFeign 已经成为 Spring Cloud 的一部分,并且默认集成了与 Spring Boot 和 Spring MVC 的良好兼容性。因此无需再单独寻找 `spring-cloud-starter-feign` 这一旧版依赖[^4]。 此外,为了确保项目的正常运行,还需要确认所使用Spring Cloud 版本号是否匹配当前的 Spring Boot 版本。可以在 `pom.xml` 中定义 Spring Cloud BOM(Bill of Materials),以便管理所有相关依赖的版本一致性。例如: ```xml <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Hoxton.SR12</version> <!-- 替换为适合您项目的版本 --> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> ``` 最后,当使用 Feign 或 OpenFeign 时,通常会结合 Eureka 或 Consul 等服务注册中心来实现动态的服务发现功能。这可以通过启用相应的注解完成,比如 `@EnableDiscoveryClient` 或者 `@EnableEurekaClient`。 ### 示例代码 以下是完整的 Maven 配置示例: ```xml <?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.7.5</version> <!-- 根据实际需求调整版本 --> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <java.version>11</java.version> </properties> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-dependencies</artifactId> <version>Hoxton.SR12</version> <!-- 使用合适的 Spring Cloud 版本 --> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-openfeign</artifactId> </dependency> <dependency> <groupId>io.github.openfeign</groupId> <artifactId>feign-httpclient</artifactId> </dependency> </dependencies> </project> ```
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值