1. Spring Boot 无侵入式API接口统一格式, 变得具有侵入性的那回事
19年我在csdn上发布了《Spring Boot 无侵入式 实现API接口统一JSON格式返回》,得到的广泛的转载,同时也在Spring Boot多个项目进行了实践操作,得到大家一致好评。
可是最近几年随着Spring Cloud的流行,我发现基于ResponseBodyAdvice
在Spring Cloud OpenFeign
的继承模式下 具有了侵入性
,而且侵入性还很强大还导致resfulAPI接口反序列化出现失败的问题(哈哈哈,挖坑了很对不起大家)。
既然发现了问题,那就好好解决一下吧,解决方式有多种,至于选择就看大家喜欢了吧
return object
, 简单轻松和谐return Result<?>
,简单轻松和谐,但是client需要 调用Result.getData()方法feign.codec.Decoder
不轻松,需要自己去自定义Decoder规则
第一方案和第二方案都是硬编码,没有多少可延展性可说的,现在我们就把feign.codec.Decoder
如何解决这种侵入性的问题解决了吧,其实也没有多少东西可说的,就说说第三方案是如何解决的吧,就是为了填坑罢了
2. Decoder解决ResponseBodyAdvice的侵入性
使用 Spring Cloud 2021.0.1
Decoder的使用百度上面一大堆,我就不展开说了
定义feignService api接口, 因为篇幅问题,我们就忽略 Controller实现和client调用了
/**
* 定义 各种不同情况下对
* @author changjin wei(魏昌进)
* @since 2022/4/8
*/
public interface UserService {
/** 原生 ResponseBody返回 */
@RequestMapping(method = RequestMethod.GET, value = "/users/{id}")
User getUser(@PathVariable("id") long id);
/** 自定义 ResultResponseBody 统一返回 */
@RequestMapping(method = RequestMethod.GET, value = "/Resultv1")
@ResultResponseBody
User getResultv1();
/** 硬编码 Result<User> 返回同时带上ResultResponseBody统一返回 */
@RequestMapping(method = RequestMethod.GET, value = "/Resulv2")
@ResultResponseBody
Result<User> getResultv2();
}
Decoder
对Result
进行解析
/**
* @author changjin wei(魏昌进)
* @since 2022/4/8
*/
public class ResultDecoder implements Decoder {
private Decoder decoder;
public ResultDecoder(Decoder decoder) {
this.decoder = decoder;
}
@Override
public Object decode(Response response, Type type) throws IOException, FeignException {
Method method = response.request().requestTemplate().methodMetadata().method();
boolean isResult = method.getReturnType() != Result.class && method.isAnnotationPresent(ResultResponseBody.class);
if (isResult) {
ParameterizedTypeImpl resultType = ParameterizedTypeImpl.make(Result.class, new Type[]{type}, null);
Result<?> result = (Result<?>) this.decoder.decode(response, resultType);
return result.getData();
}
return this.decoder.decode(response, type);
}
}
注册
ResultDecoder
到feign
中
/**
* @author changjin wei(魏昌进)
* @since 2022/4/8
*/
@Configuration(proxyBeanMethods = false)
public class FeignConfiguration {
@Autowired
private ObjectFactory<HttpMessageConverters> messageConverters;
@Bean
public Decoder feignDecoder(ObjectProvider<HttpMessageConverterCustomizer> customizers) {
return new OptionalDecoder(new ResponseEntityDecoder(new ResultDecoder(new SpringDecoder(this.messageConverters, customizers))));
}
}
这样子就解决了在Spring Boot中无侵入性,但是在Spring Cloud中具有侵入性的问题,没有多少技术含量的,纯属为了填坑