Java SpringCloud OpenFeign

1、关于 Spring Boot 无侵入式API接口统一格式变得具有侵入性

可是最近几年随着Spring Cloud的流行,基于ResponseBodyAdvice在Spring Cloud OpenFeign的继承模式下 具有了侵入性,而且侵入性还很强大,还导致resfulAPI接口反序列化出现失败的问题。
既然发现了问题,那就好好解决一下吧,解决方式有多种,至于选择就看大家喜欢了吧

  1. return object,简单轻松和谐
  2. return Result<?>,简单轻松和谐,但是client需要 调用Result.getData()方法
  3. feign.codec.Decoder 不轻松,需要自己去自定义Decoder规则

第一方案和第二方案都是硬编码,没有多少可延展性可说的,现在就把feign.codec.Decoder如何解决这种侵入性的问题解决。

2、Decoder解决ResponseBodyAdvice的侵入性

使用 Spring Cloud 2021.0.1
定义feignService api接口,因为篇幅问题,就忽略 Controller实现和client调用了

  1. public interface UserService {
  2. /** 原生 ResponseBody返回 */
  3. @RequestMapping(method = RequestMethod.GET, value = "/users/{id}")
  4. User getUser(@PathVariable("id") long id);
  5. /** 自定义 ResultResponseBody 统一返回 */
  6. @RequestMapping(method = RequestMethod.GET, value = "/Resultv1")
  7. @ResultResponseBody
  8. User getResultv1();
  9. /** 硬编码 Result<User> 返回同时带上ResultResponseBody统一返回 */
  10. @RequestMapping(method = RequestMethod.GET, value = "/Resulv2")
  11. @ResultResponseBody
  12. Result<User> getResultv2();
  13. }

Decoder对Result进行解析

  1. public class ResultDecoder implements Decoder {
  2. private Decoder decoder;
  3. public ResultDecoder(Decoder decoder) {
  4. this.decoder = decoder;
  5. }
  6. @Override
  7. public Object decode(Response response, Type type) throws IOException, FeignException {
  8. Method method = response.request().requestTemplate().methodMetadata().method();
  9. boolean isResult = method.getReturnType() != Result.class && method.isAnnotationPresent(ResultResponseBody.class);
  10. if (isResult) {
  11. ParameterizedTypeImpl resultType = ParameterizedTypeImpl.make(Result.class, new Type[]{type}, null);
  12. Result<?> result = (Result<?>) this.decoder.decode(response, resultType);
  13. return result.getData();
  14. }
  15. return this.decoder.decode(response, type);
  16. }
  17. }

注册ResultDecoder到feign中

  1. @Configuration(proxyBeanMethods = false)
  2. public class FeignConfiguration {
  3. @Autowired
  4. private ObjectFactory<HttpMessageConverters> messageConverters;
  5. @Bean
  6. public Decoder feignDecoder(ObjectProvider<HttpMessageConverterCustomizer> customizers) {
  7. return new OptionalDecoder(new ResponseEntityDecoder(new ResultDecoder(new SpringDecoder(this.messageConverters, customizers))));
  8. }
  9. }

这样子就解决了在Spring Boot中无侵入性,但是在Spring Cloud中具有侵入性的问题。