1、作用
代替手动封装每个接口的返回值,否则每个有返回值的controller接口,都需要手动使用Resonse类包装返回结果
2、实现
方法返回值handler,需要实现接口HandlerMethodReturnValueHandler,并重写supportsReturnType和handleReturnValue方法。只有在supportsReturnType方法返回值为true的情况下才会执行handleReturnValue方法。
@Service
public class ResponseReturnValueHandler implements HandlerMethodReturnValueHandler {
/**
* 当前handler是否能够处理 MethodParameter returnType
*
* @param returnType
* @return
*/
@Override
public boolean supportsReturnType(MethodParameter returnType) {
ApiResponseBody methodAnnotation = returnType.getMethodAnnotation(ApiResponseBody.class);
if (Objects.nonNull(methodAnnotation)) {
ApiResponseBodyType type = methodAnnotation.type();
if (ApiResponseBodyType.HTML.equals(type) || ApiResponseBodyType.XML.equals(type) || ApiResponseBodyType.IGNORE.equals(type)) {
return false;
}
}
return true;
}
/**
* 处理返回结果
*
* @param returnValue
* @param returnType
* @param mavContainer
* @param webRequest
* @throws Exception
*/
@Override
public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
// 使用Result包装返回值returnValue
Result jsonResult = Result.success(returnValue);
HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
PrintWriter writer = response.getWriter();
writer.write(JsonHelper.parseToJson(jsonResult));
writer.flush();
writer.close();
}
}
包装器wrapper(把处理器handler加入到RequestMappingHandlerAdapter的list中)文章来源:https://www.toymoban.com/news/detail-540835.html
@Configuration
public class RequestMappingHandlerAdapterWrapper {
/**
* 解析参数和返回结果
*/
@Autowired
private RequestMappingHandlerAdapter requestMappingHandlerAdapter;
/**
* 自定义的返回值处理器
*/
@Autowired
private ResponseReturnValueHandler responseReturnInterceptor;
@PostConstruct
public void init() {
List<HandlerMethodReturnValueHandler> originalHandlers = new ArrayList<>();
originalHandlers.add(responseReturnInterceptor);
requestMappingHandlerAdapter.setReturnValueHandlers(originalHandlers);
}
}
方法返回值类型注解(此注解使用在controller的方法上,用来标识接口返回的数据类型,可以有json、html或者ingore),只要不是ignore、html或xml,就当做json,在方法handleReturnValue中使用Result来统一包装。文章来源地址https://www.toymoban.com/news/detail-540835.html
@Getter
public enum ApiResponseBodyType {
/**
* JSON序列化格式
*/
JSON,
HTML,
IGNORE,
XML
}
到了这里,关于springboot统一拦截包装接口返回值的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!