SpringCloud实战三十六,如何优雅的使用Feign?

·  阅读 1835

在SpringCloud架构体系中,微服务间的通信是基于Feign调用。而在实际使用Feign的过程中我们大概率会面临下面几个问题:

  • Feign客户端放在消费端还是独立一个api层?
  • Feign调用的接口如何要不要进行包装?
  • Feign如何抓取业务生产端的业务异常?

这篇文章我们就来一起探讨一下这几个问题,希望看完能对你有所帮助。

首先我们先看看Feign的调用方式如何抉择?

Feign的调用方式如何选择?

总体来说,Feign的调用方式分为两大类:

在生产端API中声明Feign客户端

如上,消费端服务直接依赖生产端提供的API包,然后通过@Autowired注解注入,就可以直接调用生产者提供的接口。

这样做的 好处 是:简单方便,消费端直接使用生产者提供的Feign接口即可。

这样做的 坏处 也很明显:消费端获取到的接口是生产者提供给所有服务的接口列表,当某一生产者接口很多时就会很混乱;而且熔断降级类也在生产端,消费端在调用时由于包路径可能与生产者不一样,必须要通过@SpringBootApplication(scanBasePackages = {"com.javadaily.feign"})扫描Feign的路径,当消费端需要引入很多生产者Feign时那就需要扫描很多个接口路径。

此调用方式在之前两篇文章中有详细说明,感兴趣的可以通过下方链接直达:

SpringCloud Alibaba微服务实战三 - 服务调用

SpringCloud Alibaba微服务实战二十 - 集成Feign的降级熔断

在消费端声明Feign客户端

还是需要独立一个公共的API接口层,生产端消费端都需要引入此jar包,同时在消费端按需编写Feign客户端及熔断类。

这样做的 好处 是:客户端可以按需编写自己需要的接口,熔断降级都由消费者控制;不需要在启动类上加入额外的扫描注解scanBasePackages

这样做的 坏处 是:消费端代码冗余,每个消费者都需要编写Feign客户端;服务间耦合比较紧,修改一处接口三处都要修改。

小结

那么问题来了:既然有两种调用方式,那那种才更合理呢?

我这里建议的是优先使用第二种方式,由客户端自己定制Feign客户端。

从职责来说只有消费端才能明确知道自己要调用哪个服务提供方,需要调用哪些接口。如果直接把@FeignClient写在服务提供方的API上,消费端就很难按需定制,而熔断处理逻辑也应该是由消费端自己定制熔断逻辑。虽然会导致代码冗余,但是职责很清晰,而且可以避免扫描不到接口路径的问题。

当然这里只是个人建议,如果你觉得我说的不对,你可以按照你自己的想法来。

接下来我们再来看看Feign接口要不要封装的问题。

Feign接口要不要包装?

现状分析

在前后端分离项目中,后端给前端返回接口数据时一般会统一返回格式,此时我们的Controller大概会这样写:

@RestController
@Log4j2
@Api(tags = "account接口")
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class AccountController implements AccountApi {

    private final AccountService accountService;
  
  	...
    public ResultData<AccountDTO> getByCode(@PathVariable(value = "accountCode") String accountCode){   
        AccountDTO accountDTO = accountService.selectByCode(accountCode);
        return ResultData.success(accountDTO);
    }
    ...
}
复制代码

而Feign的接口定义需要跟实现类保持一致,那么现在order-service获取订单详情时也要返回用户信息,此时我们通过feign调用account-service的getByCode()接口会这样写:

/**
 * 获取Order详情
 * @param orderNo order编号
 * @return ResultData<OrderDTO>
*/
@GetMapping("/order/{orderNo}")
public ResultData<OrderDTO> getById(@PathVariable("orderNo") String orderNo){
  OrderDTO orderDTO = orderService.selectByNo(orderNo);
  return ResultData.success(orderDTO);
}
复制代码
public OrderDTO selectByNo(String orderNo) {
    OrderDTO orderDTO = new OrderDTO();

    //1. 查询订单基础信息
    Order order = orderMapper.selectByNo(orderNo);
    BeanUtils.copyProperties(order,orderDTO);

    //2. 获取用户信息
    ResultData<AccountDTO> accountResult = accountClient.getByCode("javadaily");
  	if(accountResult.isSuccess()){
    	orderDTO.setAccountDTO(accountResult.getData());
  	}

    return orderDTO;
}
复制代码

这里要先获取到ResultData包装类,再通过判断返回结果解成具体的AccountDTO对象,很明显这段代码有两个问题:

  1. 每个Controller接口都需要手动使用ResultData.success对结果进行包装,Repeat Yourself !
  2. Feign调用时又需要从包装类解装成需要的实体对象,Repeat Yourself !

如果有很多这样的接口调用,那...

image-20210716084136689

优化包装

这样丑陋的代码我们当然需要进行优化,优化的目标也很明确:当我们通过Feign调用时,直接获取到实体对象,不需要额外的解装。而前端通过网关直接调用时,返回统一的包装体。

这里我们可以借助ResponseBodyAdvice来实现,通过对Controller返回体进行增强,如果识别到是Feign的调用就直接返回对象,否则给我们加上统一包装结构。

至于为什么前后端需要统一返回格式以及如何实现,在我的老鸟系列文章 SpringBoot 如何统一后端返回格式?老鸟们都是这样玩的! 有详细讲述,感兴趣的可以移步。

现在问题是:如何识别出是Feign的调用还是网关直接调用呢?

这又有两种方法,基于自定义注解实现和基于Feign拦截器实现。

基于自定义注解实现

自定义一个注解,比如Inner,给Feign的接口标注上此注解,这样在使用ResponseBodyAdvice匹配时可以通过此注解进行匹配。

不过这种方法有个弊端,就是前端和feign没法公用,如一个接口user/get/{id}既可以通过feign调用也可以通过网关直接调用,采用这种方法就需要写2个不同路径的接口。

基于Feign拦截器实现

对于Feign的调用,在Feign拦截器上加上特殊标识,在转换对象时如果发现是feign调用就直接返回对象。

具体实现过程

这里我们使用第二种方法来实现(第一种方法也很简单,大家可自行尝试)

  1. 在feign拦截器中给feign请求添加特定请求头T_REQUEST_ID
/**
 * 给Feign设置请求头
 */
@Bean
public RequestInterceptor requestInterceptor(){
  return requestTemplate -> {
    ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
    if(null != attributes){
      HttpServletRequest request = attributes.getRequest();
      Map<String, String> headers = getRequestHeaders(request);

      // 传递所有请求头,防止部分丢失
      //此处也可以只传递认证的header
      //requestTemplate.header("Authorization", request.getHeader("Authorization"));
      for (Map.Entry<String, String> entry : headers.entrySet()) {
        requestTemplate.header(entry.getKey(), entry.getValue());
      }

      // 微服务之间传递的唯一标识,区分大小写所以通过httpServletRequest获取
      if (request.getHeader(T_REQUEST_ID)==null) {
        String sid = String.valueOf(UUID.randomUUID());
        requestTemplate.header(T_REQUEST_ID, sid);
      }

    }
  };
}
复制代码
  1. 自定义BaseResponseAdvice并实现ResponseBodyAdvice
@RestControllerAdvice(basePackages = "com.javadaily")
@Slf4j
public class BaseResponseAdvice implements ResponseBodyAdvice<Object> {
    @Autowired
    private ObjectMapper objectMapper;

    @Override
    public boolean supports(MethodParameter methodParameter, Class<? extends HttpMessageConverter<?>> aClass) {
        return true;
    }

    @SneakyThrows
    @Override
    public Object beforeBodyWrite(Object object, MethodParameter methodParameter, MediaType mediaType, Class<? extends HttpMessageConverter<?>> aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {

        //Feign请求时通过拦截器设置请求头,如果是Feign请求则直接返回实体对象
        boolean isFeign = serverHttpRequest.getHeaders().containsKey(OpenFeignConfig.T_REQUEST_ID);

        if(isFeign){
            return object;
        }

        if(object instanceof String){
            return objectMapper.writeValueAsString(ResultData.success(object));
        }

        if(object instanceof ResultData){
            return object;
        }

        return ResultData.success(object);
    }

}
复制代码

如果为Feign请求,则不做转换,否则通过ResultData进行包装。

  1. 修改后端接口返回对象
@ApiOperation("select接口")
@GetMapping("/account/getByCode/{accountCode}")
@ResponseBody
public AccountDTO getByCode(@PathVariable(value = "accountCode") String accountCode){
  return accountService.selectByCode(accountCode);
}
复制代码

不需要在接口上返回封装体ResultData,经由ResponseBodyAdvice实现自动增强。

  1. 修改feign调用逻辑
    @Override
    public OrderDTO selectByNo(String orderNo) {
        OrderDTO orderDTO = new OrderDTO();

        //1. 查询订单基础信息
        Order order = orderMapper.selectByNo(orderNo);
        BeanUtils.copyProperties(order,orderDTO);
				//2. 远程获取用户信息
        AccountDTO accountResult = accountClient.getByCode(order.getAccountCode());
        orderDTO.setAccountDTO(accountResult);

        return orderDTO;
    }
复制代码

经过上面四个步骤,在正常情况下 达到了我们优化目标,通过Feign调用直接返回实体对象,通过网关调用返回统一包装体。看上去很完美,但是实际很糟糕,这又导致了第三个问题,Feign如何处理异常?

Feign异常处理

现状分析

生产者对于提供的接口方法会进行业务规则校验,对于不符合业务规则的调用请求会抛出业务异常BizException,而正常情况下项目上会有个全局异常处理器,他会捕获业务异常BizException,并将其封装成统一包装体返回给调用方,现在让我们来模拟这种业务场景:

  1. 生产者抛出业务异常
public AccountDTO selectByCode(String accountCode) {
  if("javadaily".equals(accountCode)){
    throw new BizException(accountCode + "用户不存在");
  }
  AccountDTO accountDTO = new AccountDTO();
  Account account = accountMapper.selectByCode(accountCode);
  BeanUtils.copyProperties(account,accountDTO);
  return accountDTO;
}
复制代码

当用户名为 “javadaily” 的时候直接抛出业务异常BizException

  1. 全局异常拦截器捕获业务异常
/**
 * 自定义业务异常处理
 * @param e the e
 * @return ResultData
 */
@ExceptionHandler(BaseException.class)
public ResultData<String> exception(BaseException e) {
  log.error("业务异常 ex={}", e.getMessage(), e);
  return ResultData.fail(e.getErrorCode(),e.getMessage());
}
复制代码

捕获BaseException,BizException属于BaseException的子类,同样会被捕获。

  1. 调用方直接模拟异常数据调用
public OrderDTO selectByNo(String orderNo) {
  OrderDTO orderDTO = new OrderDTO();
  //1. 查询订单基础信息
  Order order = orderMapper.selectByNo(orderNo);
  BeanUtils.copyProperties(order,orderDTO);

  //2. 远程获取用户信息
  AccountDTO accountResult = accountClient.getByCode("javadaily");
  orderDTO.setAccountDTO(accountResult);
  return orderDTO;
}
复制代码

调用getByCode()方法时传递 “javadaily” ,触发生产者的业务异常规则。

Feign捕获不到异常

此时我们调用selectByNo()方法,会发现调用方捕获不到异常,accountDTO全部被设置成为null,如下:

返回结果

将Feign的日志级别设置为FULL查看返回结果:

image-20211102113222395

通过日志可以看到Feign其实获取到了全局异常处理器转换后的统一对象ResultData,并且响应码为200,正常响应。而消费者接受对象为AccountDTO,属性无法转换,全部当作NULL值处理。

很显然,这不符合我们正常业务逻辑,我们应该要直接返回生产者抛出的异常,那如何处理呢?

很简单,我们只需要给全局异常拦截器中业务异常设置一个非200的响应码即可,如:

/**
 * 自定义业务异常处理。
 * @param e the e
 * @return ResultData
 */
@ExceptionHandler(BaseException.class)
@ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
public ResultData<String> exception(BaseException e) {
  log.error("业务异常 ex={}", e.getMessage(), e);
  return ResultData.fail(e.getErrorCode(),e.getMessage());
}
复制代码

这样消费者就可以正常捕获到生产者抛出的业务异常,如下图所示:

image-20211102143348001

异常被额外封装

虽然能获取到异常,但是Feign捕获到异常后又在业务异常的基础上再进行了一次封装。

原因是当feign调用结果为非200的响应码时就触发了Feign的异常解析,Feign的异常解析器会将其包装成FeignException,即在我们业务异常的基础上再包装一次

可以在feign.codec.ErrorDecoder#decode()方法上打上断点观察执行结果,如下:

image-20211102110247523

很显然,这个包装后的异常我们并不需要,我们应该直接将捕获到的生产者的业务异常直接抛给前端,那这又该如何解决呢?

很简单,我们只需要重写Feign的异常解析器,重新实现decode逻辑,返回正常的BizException即可,而后全局异常拦截器又会捕获BizException!(感觉有点无限套娃的感觉)

代码如下:

  1. 重写Feign异常解析器
/**
 * 解决Feign的异常包装,统一返回结果
 * @author 公众号:JAVA日知录
 */
@Slf4j
public class OpenFeignErrorDecoder implements ErrorDecoder {
    /**
     * Feign异常解析
     * @param methodKey 方法名
     * @param response 响应体
     * @return BizException
     */
    @Override
    public Exception decode(String methodKey, Response response) {
        log.error("feign client error,response is {}:",response);
        try {
            //获取数据
            String errorContent = IOUtils.toString(response.body().asInputStream());
            String body = Util.toString(response.body().asReader(Charset.defaultCharset()));

            ResultData<?> resultData = JSON.parseObject(body,ResultData.class);
            if(!resultData.isSuccess()){
                return new BizException(resultData.getStatus(),resultData.getMessage());
            }

        } catch (IOException e) {
            e.printStackTrace();
        }

        return new BizException("Feign client 调用异常");
    }
}
复制代码
  1. 在Feign配置文件中注入自定义的异常解码器
@ConditionalOnClass(Feign.class)
@Configuration
public class OpenFeignConfig {  
		/**
     * 自定义异常解码器
     * @return OpenFeignErrorDecoder
     */
    @Bean
    public ErrorDecoder errorDecoder(){
        return new OpenFeignErrorDecoder();
    }
}
复制代码
  1. 再次调用,符合预期。

image-20211102150719270

此时通过自定义Feign的异常解码器,直接抛出生产者的业务异常信息,完成目标。

总结

本文对Feign在使用过程中会遇到的问题做了个小小的总结,也提出了自己可能不太成熟的解决方案。当然,由于本人水平有限,提出的解决方案不一定是最好的,如果你有更好的解决方案,还请留言告诉我,谢谢!

此文为SpringCloud实战系列的第三十六篇,如果要看其他文章可以关注公号 java日知录 哟

分类:
后端
分类:
后端
收藏成功!
已添加到「」, 点击更改