Feign的使用及自定义配置

痛定思痛。 2024-04-18 20:19 70阅读 0赞

![640?wx\_fmt=gif][640_wx_fmt_gif]

学习更多Java干货，戳上面的

蓝色字题

关注我！

Feign：SpringCloud的官网对它的定义是这样的：

是一个声明式的Web服务客户端。它支持Feign本身的注解、JAX-RS注解以及SpringMVC的注解。Spring Cloud集成Ribbon和Eureka以在使用Feign时提供负载均衡的http客户端。

Feign的使用

我们先来看一看如何在项目中使用Feign

1.  首先呢 ，我们把原先的cloud-demo-consumer项目复制一份，artifactId改为cloud-demo-consumer-feign，然后添加依赖 （温馨提醒，没有看过前几篇文章的朋友，建议先从第一篇文章开始学习效果更佳哦 [使用SpringBoot2.0整合SpringCloud][SpringBoot2.0_SpringCloud]）

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 </pre></td> 
 <td><pre> &lt;dependency&gt; &lt;groupId&gt;org.springframework.cloud&lt;/groupId&gt; &lt;!--注意此处的依赖是SpringBoot2.0以后专用的，如果您使用的SpringBoot版本低于2.0请使用spring-cloud-starter-feign--&gt; &lt;artifactId&gt;spring-cloud-starter-openfeign&lt;/artifactId&gt; &lt;/dependency&gt; </pre></td> 
 </tr> 
 </tbody> 
</table>

2.CloudDemoConsumerApplication启动类改名为CloudDemoConsumerFeignApplication，删除上次使用的RestTemplate，并在类上添加注解@EnableFeignClients，标示此项目为Feign客户端

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 9 </pre></td> 
 <td><pre>@SpringBootApplication @EnableEurekaClient @EnableFeignClients public class CloudDemoConsumerFeignApplication {
 public static void main(String[] args) {
 SpringApplication.run(CloudDemoConsumerFeignApplication.class, args); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

3.在cn.org.zhixiang包下增加feign包 然后添加UserFeignClient接口：

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 </pre></td> 
 <td><pre>@FeignClient("provider-demo") public interface UserFeignClient {
 @GetMapping (value = "/user/getUser/{id}") public User getUser(@PathVariable("id")Long id); } </pre></td> 
 </tr> 
 </tbody> 
</table>

这个接口呢，就是我们使用Feign的关键了，我们先来看一下@FeignClient(“provider-demo”)注解，它括号里的内容 看着是不是很熟悉，这不就是我们的服务提供者的名称么，对其实它就是我们需要调用的服务的spring.application.name。

接着是@RequestMapping(value = “/user/getUser/\{id\}”, method = RequestMethod.GET)

@PathVariable(“id”)，这个注解咋还写上value了呢，我记得没写过呀，其实这就是一个坑了，如果不写的话是启动不起来滴。

4.接着我们看UserController类，刚才我们已经把RestTemple的Bean给干掉了，那么在这断然没有在使用它的道理。

我们现在要使用的就是我们刚才定义的UserFeignClient 接口

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 9 10 11 12 </pre></td> 
 <td><pre>@RestController @RequestMapping("/user") public class UserController {
 @Autowired private UserFeignClient userFeignClient; @GetMapping("/getUser/{id}") public User getUser(@PathVariable Long id){
 return userFeignClient.getUser(id); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

5现在我们就可以测试了，先启动Eureka服务，然后随便启动我们定义的两个服务提供者中的其中一个，最后启动我们的这个项目。

浏览器访问http://localhost:8089/user/getUser/1，不知道你获取到数据了么？

修改Feign的默认配置

修改Feign的默认配置其实也存在包扫描的问题，因为上一篇文章（自定义Eureka集群负载均衡策略）已经讲过了，这里就不浪费时间了，没有看过的同学可以先去参考一下。

这里我们就简单省事，把配置文件放到ComponentScan扫描不到的地方吧：cn.org.config,在这里呢，我们新建了Configuration配置类

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 </pre></td> 
 <td><pre> @org.springframework.context.annotation.Configuration public class Configuration {
 @Bean public Contract feignContract() {
 return new Contract.Default(); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

然后在UserFeignClient类中指定configuration

`@FeignClient(value = "provider-demo",configuration = Configuration.class)`  
注意，我们在此类中修改了Feign的Contract ，那么Contract 是什么呢。它叫做契约。因为Feign一开始使用的契约是SpringMVC，所以刚才我们SpringMVC的注解的时候直接成功了，但是你如果现在启动项目你就会发现已经启动不了了。因为Contract.Default()使用的契约是Feign自己的，也就是说我们要把SpringMVC的注解修改为Feign的注解

SpringMVC版本

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 </pre></td> 
 <td><pre>@GetMapping (value = "/user/getUser/{id}") public User getUser(@PathVariable("id")Long id); Feign版本 @RequestLine("GET /user/getUser/{id}") public User getUser(@Param("id") Long id); </pre></td> 
 </tr> 
 </tbody> 
</table>

当你学会修改Feign的契约时修改别的默认同样不在话下了已经。

点击下方“阅读原文”查看源码！！！

![640?wx\_fmt=gif][640_wx_fmt_gif 1]

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg]

点赞收藏转发好看再走呗!

![640?wx\_fmt=gif][640_wx_fmt_gif 2]

[640_wx_fmt_gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/c45bfcbf775347f5a5a5a728f428e8a6.gif
[SpringBoot2.0_SpringCloud]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247483912&idx=1&sn=1f4bde5b1a1bedff2fc078ef232a292f&chksm=fe396836c94ee1206f2e85a841d8cdc50f4d7f6e173ee4a69a7bbbc28b79499ae78a0fb43bd7&scene=21#wechat_redirect
[640_wx_fmt_gif 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/c3179f4635ac470ba72ba7736e3062f3.gif
[640_wx_fmt_jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/b08b653f2cbc4adab6dd4e482a465cbf.png
[640_wx_fmt_gif 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3335fe805bd643fd83d7fc9c6018560d.gif