0
0

Spring Cloud中的Feign调用

前言

主要介绍了feign client的参数的用户，并列举了开发中的一个实际用例

一、Feign是什么？

  1. Feign是Netflix开发的声明式、模板化的HTTP客户端， Feign可以帮助我们更快捷、优雅地调用HTTP API。
  2. Feign支持多种注解，例如Feign自带的注解或者JAX-RS注解等。
  3. Spring Cloud对Feign进行了增强，使Feign支持了Spring MVC注解，并整合了Ribbon和Eureka，从而让Feign的使用更加方便。
  4. Spring Cloud Feign是基于Netflix feign实现，整合了Spring Cloud Ribbon和Spring Cloud Hystrix，除了提供这两者的强大功能外，还提供了一种声明式的Web服务客户端定义的方式。
  5. Spring Cloud Feign帮助我们定义和实现依赖服务接口的定义。在Spring Cloud feign的实现下，只需要创建一个接口并用注解方式配置它，即可完成服务提供方的接口绑定，简化了在使用Spring Cloud Ribbon时自行封装服务调用客户端的开发量。

二、使用说明

1.引入依赖

  1. <!--服务调用-->
  2. <dependency>
  3.     <groupId>org.springframework.cloud</groupId>
  4.     <artifactId>spring-cloud-starter-openfeign</artifactId>
  5. </dependency>

2.FeignClient注解的参数说明

  1. //
  2. // Source code recreated from a .class file by IntelliJ IDEA
  3. // (powered by FernFlower decompiler)
  4. //
  6. package org.springframework.cloud.openfeign;
  8. import java.lang.annotation.Documented;
  9. import java.lang.annotation.ElementType;
  10. import java.lang.annotation.Inherited;
  11. import java.lang.annotation.Retention;
  12. import java.lang.annotation.RetentionPolicy;
  13. import java.lang.annotation.Target;
  14. import org.springframework.core.annotation.AliasFor;
  16. @Target({ElementType.TYPE})
  17. @Retention(RetentionPolicy.RUNTIME)
  18. @Documented
  19. @Inherited
  20. public @interface FeignClient {
  21.     @AliasFor("name")
  22.     String value() default "";
  24.     String contextId() default "";
  26.     @AliasFor("value")
  27.     String name() default "";
  29.     /** @deprecated */
  30.     @Deprecated
  31.     String qualifier() default "";
  33.     String[] qualifiers() default {};
  35.     String url() default "";
  37.     boolean decode404() default false;
  39.     Class<?>[] configuration() default {};
  41.     Class<?> fallback() default void.class;
  43.     Class<?> fallbackFactory() default void.class;
  45.     String path() default "";
  47.     boolean primary() default true;
  48. }

value和name

如果没有配置url，那么配置的值将作为服务的名称，用于服务的发现。

注意配置的内容是提供接口的服务的名字，对用服务发现、走网关调用,由这个参数控制。

这两个是一样的效果，内容互相引用

contextId

如果同一个工程中出现两个接口使用一样的服务名称会报错。原因是Client名字注册到容器中重复了。这种情况可以使用contextId来解决问题。

比如我们有个user服务，但user服务中有很多个接口，我们不想将所有的调用接口都定义在一个类中，比如UserFeignClientA、UserFeignClentB，当不同的Feign的name一致的时候，这时候Bean的名称就会冲突，解决方式可以通过指定不同的contextId来解决问题。

配置了contextId属性，就会采用contextId作为bean的名称注入进容器中，如果没有配置就会去找value然后是name

在真正的项目开发中，这种情况很少，一般是定义在一个类中，方便管理。

另外在注册FeignClient中，这个属性还会作为Client别名的一部分，如果配置了qualifier，会有限使用qualifier作为别名。

  1. // 拼接别名
  2.     String alias = contextId + "FeignClient";
  3.     AbstractBeanDefinition beanDefinition = definition.getBeanDefinition();
  4.  
  5.  
  6.     boolean primary = (Boolean) attributes.get("primary"); // has a default, won't be
  7.                                 // null
  8.  
  9.  
  10.     beanDefinition.setPrimary(primary);
  11.  
  12.     // 配置了qualifier优先用qualifier
  13.     String qualifier = getQualifier(attributes);
  14.     if (StringUtils.hasText(qualifier)) {
  15.       alias = qualifier;
  16.     }
  17.  
  18.  
  19.     BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className,
  20.         new String[] { alias });
  21.     BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);

url

用于配置指定的地址，相当于使用http的形式直接请求这个服务，不经过注册中心。如果配置了这个属性，name属性（通过注册中心调用目标服务）将会被覆盖，不会通过配置中心调用服务。

configuration

这个属性是配置feign的配置类，在配置类中可以定义Feign的Encoder、Decoder、loglevel、contract、鉴权信息等

fallback

  1. fallback

定义容错的处理类，也就是回退逻辑，

  1. fallback

的类必须实现

  1. Feign Client

的接口，无法知道熔断的异常信息，只是重写了回退方法。

fallbackFactory

也是容错的处理，可以通过输出Throwable（调用异常的原因）知道熔断的异常信息。

用线程抛出了异常，可以看到底层具体的问题。

path

  1. path

定义当前

  1. FeignClient

访问接口时的统一前缀，比如接口地址是/user/get, 如果你定义了前缀是user, 那么具体方法上的路径就只需要写/get 即可。

qualifier

如果由于某些特殊原因，你必须得去掉

  1. primary=true

的设置，这种情况下我们怎么进行注入，我们可以配置一个

  1. qualifier

，然后使用

  1. @Qualifier

注解进行注入

  1. @FeignClient(name = "optimization-user", path="user", qualifier="userRemoteClient")
  2. public interface UserRemoteClient {
  4.     @GetMapping("/get")
  5.     public User getUser(@RequestParam("id") int id);
  6. }

feign client的注入

  1. @Autowired
  2. @Qualifier("userRemoteClient")
  3. private UserRemoteClient userRemoteClient;

primary

primary对应的是@Primary注解，默认为true，官方这样设置也是有原因的。当我们的Feign实现了fallback后，也就意味着FeignClient有多个相同的Bean在Spring容器中，当我们在使用@Autowired进行注入的时候，不知道注入哪个，所以我们需要设置一个优先级高的，@Primary注解就是干这件事情的。

实际用例

在微服务的框架中，每个服务一般会再定义一个api的模块，用来专门存放feign client。

假设在job模块调用order的模块的接口

首先在order模块的api中定义feign client

1.导入feign的依赖

2.设置接口类

在这里，我定义了contextId，value，fallbackFactory，path四个参数信息

  1. package com.qingdao2world.settle.api;
  3. import com.qingdao2world.settle.api.domain.BmsExpressMonthDetailDto;
  4. import com.qingdao2world.settle.api.factory.RemoteBizExpressMonthDetailFallbackFactory;
  5. import com.ruoyi.common.core.constant.SecurityConstants;
  6. import com.ruoyi.common.core.constant.ServiceNameConstants;
  7. import com.ruoyi.common.core.domain.R;
  8. import org.springframework.cloud.openfeign.FeignClient;
  9. import org.springframework.web.bind.annotation.GetMapping;
  10. import org.springframework.web.bind.annotation.RequestHeader;
  11. import org.springframework.web.bind.annotation.RequestParam;
  13. import java.util.List;
  15. /**
  16.  * @author linaibo
  17.  */
  18. @FeignClient(contextId = "remoteBizExpressMonthDetailService",value= ServiceNameConstants.SETTLE_SERVICE,fallbackFactory= RemoteBizExpressMonthDetailFallbackFactory.class,path="/express")
  19. public interface RemoteBizExpressMonthDetailService {
  21.     @GetMapping("/selectDetails")
  22.     public R<List<BmsExpressMonthDetailDto>> selectBmsExpressMonthDetailByStatus(@RequestParam("expressStatus") Integer expressStatus, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
  24.     @GetMapping("/updateDetail")
  25.     public R<String> updateCompanyByLogistics(@RequestParam("logisticsNo") String logisticsNo,@RequestParam("expressStatus") Integer expressStatus, @RequestHeader(SecurityConstants.FROM_SOURCE) String source);
  26. }

3.设置容错处理类

这里使用的fallbackFactory，因为可以看到出错的原因

  1. package com.qingdao2world.settle.api.factory;
  3. import com.qingdao2world.settle.api.RemoteBizExpressMonthDetailService;
  4. import com.qingdao2world.settle.api.domain.BmsExpressMonthDetailDto;
  5. import com.ruoyi.common.core.domain.R;
  6. import org.springframework.cloud.openfeign.FallbackFactory;
  8. import java.util.List;
  10. /**
  11.  * @author linaibo
  12.  * @version 1.0
  13.  * Create by 2022/8/17 15:12
  14.  */
  16. public class RemoteBizExpressMonthDetailFallbackFactory implements FallbackFactory<RemoteBizExpressMonthDetailService> {
  17.     @Override
  18.     public RemoteBizExpressMonthDetailService create(Throwable cause) {
  19.         return new RemoteBizExpressMonthDetailService(){
  20.             @Override
  21.             public R<List<BmsExpressMonthDetailDto>> selectBmsExpressMonthDetailByStatus(Integer expressStatus, String source) {
  22.                 return R.fail("查询快递费用明细失败" + cause.getMessage());
  23.             }
  24.             @Override
  25.             public R<String> updateCompanyByLogistics(String logisticsNo, Integer expressStatus, String source) {
  26.                 return R.fail("更新快递费用明细失败" + cause.getMessage());
  27.             }
  28.         };
  29.     }
  30. }

4.将容错处理类交由spring容器进行管理

将容错处理类添加在下面这个文件中

billsys-api/billsys-api-settle/src/main/resources/META-INF/spring.factories

  1. org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
  2.   com.qingdao2world.settle.api.factory.RemoteBizExpressMonthDetailFallbackFactory,\
  3.   com.qingdao2world.settle.api.factory.RemoteBmsDayBillsDetailServiceFallbackFactory

5.在order模块定义一个apiController专门处理feign调用的接口

在order模块中api文件夹中专门设置了一个controler类来处理feign的调用，可以和其他的接口调用区分开，使整个框架更加清晰。可以让这个controller类实现feign client的接口，这样可以避免一些错误。

  1. package com.qingdao2world.settle.api;
  3. import com.qingdao2world.settle.api.domain.BmsExpressMonthDetailDto;
  4. import com.qingdao2world.settle.service.IBmsExpressMonthDetailService;
  5. import com.ruoyi.common.core.domain.R;
  6. import org.springframework.beans.factory.annotation.Autowired;
  7. import org.springframework.web.bind.annotation.*;
  9. import java.util.List;
  11. /**
  12.  * @author linaibo
  13.  * @version 1.0
  14.  * Create by 2022/8/17 13:43
  15.  */
  16. @RestController
  17. @RequestMapping("/express")
  18. public class ApiBmsExpressMonthDetailController {
  20.     @Autowired
  21.     private IBmsExpressMonthDetailService expressMonthDetailService;
  23.     @GetMapping("/selectDetails")
  24.     public R<List<BmsExpressMonthDetailDto>> selectBmsExpressMonthDetailByStatus(@RequestParam("expressStatus") Integer expressStatus, @RequestHeader(required = false) String source) {
  25.         List<BmsExpressMonthDetailDto> bmsExpressMonthDetailDtoList = expressMonthDetailService.selectBmsExpressMonthDetailByStatus(expressStatus);
  26.         return R.ok(bmsExpressMonthDetailDtoList);
  27.     }
  29.     @GetMapping("/updateDetail")
  30.     public R<String> updateCompanyByLogistics(@RequestParam("logisticsNo") String logisticsNo, @RequestParam("expressStatus") Integer expressStatus, @RequestHeader(required = false) String source) {
  31.         int updateNum = expressMonthDetailService.updateCompanyByLogistics(logisticsNo, expressStatus);
  32.         return updateNum > 0 ? R.ok("快递信息锁定成功") : R.fail("快递信息锁定失败");
  33.     }
  35. }

6.在job模块中引入order的api模块的依赖

  1.         <dependency>
  2.             <groupId>com.qingdao2world</groupId>
  3.             <artifactId>billsys-api-settle</artifactId>
  4.             <version>1.0-SNAPSHOT</version>
  5.             <scope>compile</scope>
  6.         </dependency>

7.在job模块的启动类中天添加@EnableFeignClients注解

8.在job模块的service中注入order的api模块的feign client，直接使用就可以

  1. package com.ruoyi.job.queue.disruptor.expressDetailWmsProcess;
  3. import cn.hutool.json.JSONUtil;
  4. import com.lmax.disruptor.WorkHandler;
  5. import com.qingdao2world.settle.api.RemoteBizExpressMonthDetailService;
  6. import com.qingdao2world.settle.api.domain.BmsExpressMonthDetailDto;
  7. import com.qingdao2world.settle.api.domain.ExpressWmsDto;
  8. import com.ruoyi.common.core.constant.SecurityConstants;
  9. import com.ruoyi.common.core.domain.R;
  10. import com.ruoyi.common.core.enums.ExpressStatusEnum;
  11. import com.ruoyi.job.manager.WmsManager;
  12. import lombok.RequiredArgsConstructor;
  13. import lombok.extern.slf4j.Slf4j;
  14. import org.springframework.beans.BeanUtils;
  16. /**
  17.  * 推送wms系统
  18.  *
  19.  * @author linaibo
  20.  */
  22. @RequiredArgsConstructor
  23. @Slf4j
  24. public class ExpressDetailWmsProcessEventHandler implements WorkHandler<ExpressDetailWmsProcessEvent> {
  26.     private final RemoteBizExpressMonthDetailService remoteBizExpressMonthDetailService;
  27.     private final WmsManager wmsManager;
  29.     @Override
  30.     public void onEvent(ExpressDetailWmsProcessEvent event) {
  31.         //锁住信息，将状态更新为对接中
  32.         BmsExpressMonthDetailDto express = event.getValue();
  33.         R<String> result =  remoteBizExpressMonthDetailService.updateCompanyByLogistics(express.getLogisticsNo(), ExpressStatusEnum.DOCKING.expressStatus, SecurityConstants.INNER);
  34.         if(!result.isSuccess()){
  35.             log.error("快递明细更新失败"+ JSONUtil.toJsonStr(express));
  36.             event.setStop(true);
  37.             return;
  38.         }
  39.         //将信息推送到wms
  40.         ExpressWmsDto expressWmsDto = new ExpressWmsDto();
  41.         BeanUtils.copyProperties(express,expressWmsDto);
  42.         R<String> result2 = wmsManager.importExpress(expressWmsDto);
  43.         if (!result2.isSuccess()) {
  44.             event.setStop(true);
  45.             log.info("快递信息推送WMS系统失败" + JSONUtil.toJsonStr(expressWmsDto));
  46.             //更新快递状态为3（对接失败）
  47.             remoteBizExpressMonthDetailService.updateCompanyByLogistics(express.getLogisticsNo(),ExpressStatusEnum.DOCKFAIL.expressStatus, SecurityConstants.INNER);
  48.             return;
  49.         }
  50.     }
  52. }

api模块的构成

注意：

feign client中的请求url一定要和被请求接口在controller中的url保持一致

参数一定要设置正确

容错处理类要明确出错的原因，方便对异常的处理

标签： spring cloud 后端 java
本文转载自: https://blog.csdn.net/m0_72167535/article/details/127948633
版权归原作者 linab112 所有， 如有侵权，请联系我们删除。
登录后发布评论

“Spring Cloud中的Feign调用”的评论:

还没有评论
关于作者
...
overfit同步小助手
文章同步
相关阅读

网络安全法-网络运行安全

使用selenium/drissionpage时如何阻止chrome自动跳转http到https

docker desktop 里部署的Open WebUI 管理员密码忘记了的处理方法

在ubuntu20.04中搭建onsite比赛运行环境

利用开源的低代码表单设计器FcDesigner高效管理和渲染复杂表单结构

Kafka学习笔记

【前端】浏览器输入url到页面呈现发生了什么？