Spring Cloud Feign 使用方式

最新推荐文章于 2025-10-14 13:16:56 发布

原创最新推荐文章于 2025-10-14 13:16:56 发布 · 2.5k 阅读

2 ·

CC 4.0 BY-SA版权

编程专栏收录该内容

47 篇文章

订阅专栏

本文介绍如何在SpringCloud项目中集成Feign客户端，包括开启Feign支持、定义Feign接口的方法，以及使用Get和Post请求的具体实现。此外还总结了一些常见的问题及解决方法。

结合 Spring Cloud 使用 Feign 的步骤如下：

Feign 结合 Spring Cloud 时，可使用 Springmvc 提供的注解支持，如 @RequestMapping @GetMapping 等

1.开启 Feign 支持 @EnableFeignClients

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class Application {

	public static void main(String[] args) {
		SpringApplication.run(Application.class, args);
	}

}

2.定义 Feign 接口

Get 请求方式：

展示两种定义 Get 请求的方式，注意必须要定义属性名称，不能像 mvc 省略 @RequestParam

@FeignClient(Constants.SERVICE_NAME)
public interface ApiClient {

	public static final String URL = "/api/user";

	@GetMapping(URL + "/get")
	User get(@RequestParam("uid") String uid);

	@GetMapping(URL + "/get/{uid}")
	User show(@PathVariable("uid") String uid);

}

同时也可以用 Map 构建参数

public User get(@RequestParam Map<String, Object> map);

Post 请求方式：

@PostMapping(URL + "/update")
User update(@RequestBody User user);

服务端：

@RestController
public class UserApi {

    @PostMapping("/update")
    public User update(@RequestBody User user) {
      ...
    }
}

一些坑：

1.@RequestMapping 不要在接口上注解，否则会当成 controller 暴露出去

2.使用 Get 请求时，参数只能是基本数据对象，可以是 String、Integer、Map （如果传入复杂对象，如 User ，则 Get 请求会被转为 Post 请求）

3.参数必须使用 @RequestParam 或 @PathVariable 进行注解，并定义属性名称，否则报错 no suitable HttpMessageConverter found for response type [type] and content type [text/plain;charset=UTF-8]

4.在 Feign 中使用 @RequestParam 的作用是向请求 url 中附加参数，如 /api/user/get?uid=1 中 ?uid=1 ,所以参数名称必须与服务接口的参数一致

Feign 项目文档

https://github.com/OpenFeign/feign