Spring MVC Controller返回值及异常的统一处理方法

旧的设计方案

开发api的时候,需要先定义好接口的数据响应结果.如下是一个很简单直接的Controller实现方法及响应结果定义.

@RestController
@RequestMapping("/users")
public class UserController {

 @Inject
 private UserService userService;

 @GetRequest("/{userId:\\d+}")
 public ResponseBean signin(@PathVariable long userId) {
  try {
   User user = userService.getUserBaseInfo(userId);
   return ResponseBean.success(user);
  } catch (ServiceException e) {
   return new ReponseBean(e.getCode(), e.getMsg());
  } catch (Exception e) {
   return ResponseBean.systemError();
  }
 }
}
{
 code: "",
 data: {}, // 可以是对象或者数组
 msg: ""
}

从上面的代码,我们可以看到对于每个 Controller 方法,都会有很多重复的代码出现,我们应该设法去避免重复的代码。将重复的代码移除之后,可以得到如下的代码,简单易懂。

@RestController
@RequestMapping("/users")
public class UserController {

 @Inject
 private UserService userService;

 @GetRequest("/{userId:\\d+}")
 public User signin(@PathVariable long userId) {
  return userService.getUserBaseInfo(userId);
 }
}

在以上的实现中,还做了一个必要的要求,就是 ServiceException 需要定义为 RuntimeException的子类,而不是 Exception的子类。由于 ServiceException 表示服务异常,一般发生这种异常是应该直接提示前端,而无需进行其他特殊处理的。在定义为 RuntimeException 的子类之后,会减少大量的异常抛出声明,而且不再需要在事务@Transactional 中进行特殊声明。

统一 Controller 返回值格式

在开发的过程中,我发现上面的结构

@ControllerAdvice
public class ControllerResponseHandler implements ResponseBodyAdvice<Object> {

 private Logger logger = LogManager.getLogger(getClass());

 @Override
 public boolean supports(MethodParameter returnType, Class<? extends HttpMessageConverter<?>> converterType) {
  // 支持所有的返回值类型
  return true;
 }

 @Override
 public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
   Class<? extends HttpMessageConverter<?>> selectedConverterType, ServerHttpRequest request,
   ServerHttpResponse response) {
  if(body instanceof ResponseBean) {
   return body;
  } else {
   // 所有没有返回 ResponseBean 结构的结果均认为是成功的
   return ResponseBean.success(body);
  }
 }
}

统一异常处理

如下的代码中,ServiceException ServiceMessageException ValidatorErrorType FieldValidatorError 均为自定义类。

@ControllerAdvice
public class ControllerExceptionHandler {

 private Logger logger = LogManager.getLogger(getClass());

 private static final String logExceptionFormat = "[EXIGENCE] Some thing wrong with the system: %s";

 /**
  * 自定义异常
  */
 @ExceptionHandler(ServiceMessageException.class)
 public ResponseBean handleServiceMessageException(HttpServletRequest request, ServiceMessageException ex) {
  logger.debug(ex);
  return new ResponseBean(ex.getMsgCode(), ex.getMessage());
 }

 /**
  * 自定义异常
  */
 @ExceptionHandler(ServiceException.class)
 public ResponseBean handleServiceException(HttpServletRequest request, ServiceException ex) {
  logger.debug(ex);
  String message = codeToMessage(ex.getMsgCode());
  return new ResponseBean(ex.getMsgCode(), message);
 }

 /**
  * MethodArgumentNotValidException: 实体类属性校验不通过
  * 如: listUsersValid(@RequestBody @Valid UserFilterOption option)
  */
 @ExceptionHandler(MethodArgumentNotValidException.class)
 public ResponseBean handleMethodArgumentNotValid(HttpServletRequest request, MethodArgumentNotValidException ex) {
  logger.debug(ex);
  return validatorErrors(ex.getBindingResult());
 }

 private ResponseBean validatorErrors(BindingResult result) {
  List<FieldValidatorError> errors = new ArrayList<FieldValidatorError>();
  for (FieldError error : result.getFieldErrors()) {
   errors.add(toFieldValidatorError(error));
  }
  return ResponseBean.validatorError(errors);
 }

 /**
  * ConstraintViolationException: 直接对方法参数进行校验,校验不通过。
  * 如: pageUsers(@RequestParam @Min(1)int pageIndex, @RequestParam @Max(100)int pageSize)
  */
 @ExceptionHandler(ConstraintViolationException.class)
 public ResponseBean handleConstraintViolationException(HttpServletRequest request,
   ConstraintViolationException ex) {
  logger.debug(ex);
  //
  List<FieldValidatorError> errors = new ArrayList<FieldValidatorError>();

  for (ConstraintViolation<?> violation : ex.getConstraintViolations()) {
   errors.add(toFieldValidatorError(violation));
  }
  return ResponseBean.validatorError(errors);
 }

 private FieldValidatorError toFieldValidatorError(ConstraintViolation<?> violation) {
  Path.Node lastNode = null;
  for (Path.Node node : violation.getPropertyPath()) {
   lastNode = node;
  }

  FieldValidatorError fieldNotValidError = new FieldValidatorError();
  // fieldNotValidError.setType(ValidatorTypeMapping.toType(violation.getConstraintDescriptor().getAnnotation().annotationType()));
  fieldNotValidError.setType(ValidatorErrorType.INVALID.value());
  fieldNotValidError.setField(lastNode.getName());
  fieldNotValidError.setMessage(violation.getMessage());
  return fieldNotValidError;
 }

 private FieldValidatorError toFieldValidatorError(FieldError error) {
  FieldValidatorError fieldNotValidError = new FieldValidatorError();
  fieldNotValidError.setType(ValidatorErrorType.INVALID.value());
  fieldNotValidError.setField(error.getField());
  fieldNotValidError.setMessage(error.getDefaultMessage());
  return fieldNotValidError;
 }

 /**
  * BindException: 数据绑定异常,效果与MethodArgumentNotValidException类似,为MethodArgumentNotValidException的父类
  */
 @ExceptionHandler(BindException.class)
 public ResponseBean handleBindException(HttpServletRequest request, BindException ex) {
  logger.debug(ex);
  return validatorErrors(ex.getBindingResult());
 }

 /**
  * 返回值类型转化错误
  */
 @ExceptionHandler(HttpMessageConversionException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request,
   HttpMessageConversionException ex) {
  return internalServiceError(ex);
 }

 /**
  * 对应 Http 请求头的 accept
  * 客户器端希望接受的类型和服务器端返回类型不一致。
  * 这里虽然设置了拦截,但是并没有起到作用。需要通过http请求的流程来进一步确定原因。
  */
 @ExceptionHandler(HttpMediaTypeNotAcceptableException.class)
 public ResponseBean handleHttpMediaTypeNotAcceptableException(HttpServletRequest request,
   HttpMediaTypeNotAcceptableException ex) {
  logger.debug(ex);
  StringBuilder messageBuilder = new StringBuilder().append("The media type is not acceptable.")
    .append(" Acceptable media types are ");
  ex.getSupportedMediaTypes().forEach(t -> messageBuilder.append(t + ", "));
  String message = messageBuilder.substring(0, messageBuilder.length() - 2);

  return new ResponseBean(HttpStatus.NOT_ACCEPTABLE.value(), message);
 }

 /**
  * 对应请求头的 content-type
  * 客户端发送的数据类型和服务器端希望接收到的数据不一致
  */
 @ExceptionHandler(HttpMediaTypeNotSupportedException.class)
 public ResponseBean handleHttpMediaTypeNotSupportedException(HttpServletRequest request,
   HttpMediaTypeNotSupportedException ex) {
   logger.debug(ex);
  StringBuilder messageBuilder = new StringBuilder().append(ex.getContentType())
    .append(" media type is not supported.").append(" Supported media types are ");
  ex.getSupportedMediaTypes().forEach(t -> messageBuilder.append(t + ", "));
  String message = messageBuilder.substring(0, messageBuilder.length() - 2);
  System.out.println(message);
  return new ResponseBean(HttpStatus.UNSUPPORTED_MEDIA_TYPE.value(), message);
 }

 /**
  * 前端发送过来的数据无法被正常处理
  * 比如后天希望收到的是一个json的数据,但是前端发送过来的却是xml格式的数据或者是一个错误的json格式数据
  */
 @ExceptionHandler(HttpMessageNotReadableException.class)
 public ResponseBean handlerHttpMessageNotReadableException(HttpServletRequest request,
   HttpMessageNotReadableException ex) {
  logger.debug(ex);
  String message = "Problems parsing JSON";
  return new ResponseBean(HttpStatus.BAD_REQUEST.value(), message);
 }

 /**
  * 将返回的结果转化到响应的数据时候导致的问题。
  * 当使用json作为结果格式时,可能导致的原因为序列化错误。
  * 目前知道,如果返回一个没有属性的对象作为结果时,会导致该异常。
  */
 @ExceptionHandler(HttpMessageNotWritableException.class)
 public ResponseBean handlerHttpMessageNotWritableException(HttpServletRequest request,
   HttpMessageNotWritableException ex) {
  return internalServiceError(ex);
 }

 /**
  * 请求方法不支持
  */
 @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request, HttpRequestMethodNotSupportedException ex) {
  logger.debug(ex);
  StringBuilder messageBuilder = new StringBuilder().append(ex.getMethod())
    .append(" method is not supported for this request.").append(" Supported methods are ");

  ex.getSupportedHttpMethods().forEach(m -> messageBuilder.append(m + ","));
  String message = messageBuilder.substring(0, messageBuilder.length() - 2);
  return new ResponseBean(HttpStatus.METHOD_NOT_ALLOWED.value(), message);
 }

 /**
  * 参数类型不匹配
  */
 @ExceptionHandler(MethodArgumentTypeMismatchException.class)
 public ResponseBean methodArgumentTypeMismatchExceptionHandler(HttpServletRequest request,
   MethodArgumentTypeMismatchException ex) {
  logger.debug(ex);
  String message = "The parameter '" + ex.getName() + "' should of type '"
    + ex.getRequiredType().getSimpleName().toLowerCase() + "'";

  FieldValidatorError fieldNotValidError = new FieldValidatorError();
  fieldNotValidError.setType(ValidatorErrorType.TYPE_MISMATCH.value());
  fieldNotValidError.setField(ex.getName());
  fieldNotValidError.setMessage(message);

  return ResponseBean.validatorError(Arrays.asList(fieldNotValidError));
 }

 /**
  * 缺少必填字段
  */
 @ExceptionHandler(MissingServletRequestParameterException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request,
   MissingServletRequestParameterException ex) {
  logger.debug(ex);
  String message = "Required parameter '" + ex.getParameterName() + "' is not present";

  FieldValidatorError fieldNotValidError = new FieldValidatorError();
  fieldNotValidError.setType(ValidatorErrorType.MISSING_FIELD.value());
  fieldNotValidError.setField(ex.getParameterName());
  fieldNotValidError.setMessage(message);

  return ResponseBean.validatorError(Arrays.asList(fieldNotValidError));
 }

 /**
  * 文件上传时,缺少 file 字段
  */
 @ExceptionHandler(MissingServletRequestPartException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request, MissingServletRequestPartException ex) {
  logger.debug(ex);
  return new ResponseBean(HttpStatus.BAD_REQUEST.value(), ex.getMessage());
 }

 /**
  * 请求路径不存在
  */
 @ExceptionHandler(NoHandlerFoundException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request, NoHandlerFoundException ex) {
  logger.debug(ex);
  String message = "No resource found for " + ex.getHttpMethod() + " " + ex.getRequestURL();
  return new ResponseBean(HttpStatus.NOT_FOUND.value(), message);
 }

 /**
  * 缺少路径参数
  * Controller方法中定义了 @PathVariable(required=true) 的参数,但是却没有在url中提供
  */
 @ExceptionHandler(MissingPathVariableException.class)
 public ResponseBean exceptionHandle(HttpServletRequest request, MissingPathVariableException ex) {
  return internalServiceError(ex);
 }

 /**
  * 其他所有的异常
  */
 @ExceptionHandler()
 public ResponseBean handleAll(HttpServletRequest request, Exception ex) {
  return internalServiceError(ex);
 }

 private String codeToMessage(int code) {
  //TODO 这个需要进行自定,每个 code 会匹配到一个相应的 msg
  return "The code is " + code;
 }

 private ResponseBean internalServiceError(Exception ex) {
  logException(ex);
  // do something else
  return ResponseBean.systemError();
 }

 private <T extends Throwable> void logException(T e) {
  logger.error(String.format(logExceptionFormat, e.getMessage()), e);
 }
}

通过上面的配置,可以有效地将异常进行统一的处理,同时对返回的结果进行统一的封装。

总结

以上就是这篇文章的全部内容了,希望本文的内容对大家的学习或者工作具有一定的参考学习价值,谢谢大家对我们的支持。

(0)

相关推荐

  • bootstrap fileinput组件整合Springmvc上传图片到本地磁盘

    整合前的准备步骤 1.搭建好基础框架,本文用的是SSM(Spring+SpringMVC+Mybatis),这里的过程就不在本文中讲了,之前我做个一个demo(ssm整合+用户模块),可以参考这个搭建好. 2.下载bootstrap fileinput组件源码: https://github.com/kartik-v/bootstrap-fileinput/ 搭建后的效果图 图1. 图2. 图3. 图4. 图5. 在需要编写的jsp页面引入组件 本工程的路径界面如下: 在jsp引入组件需要的js

  • Springmvc的运行流程图文详解

    一.常见类及其作用 HandlerExecutionChain : Handler执行链对象, 包含了请求处理器对象 以及所有的拦截器对象. HandlerMapping : 定义了所有的请求与 所有的请求处理器之间的映射. HandlerAdaptor: 请求处理器适配器对象, 负责完成请求处理器对象的调用 . 方法的执行等- 二. 运行流程: 浏览器端发送请求到服务器端: 1.1 当前的请求在DispatcherServlet中不存在对应的映射 ① 是否配置mvc:default-servl

  • springmvc流程图以及配置解析

    springmvc:是完成数据的封装和跳转的功能 流程图如下: springmvc的配置流程 1.导入jar包 2.配置servlet文件 init-param的作用是在启动servlet启动时规定其地地址及名称去搜寻其springmvc配置文件 3.配置springmvc配置文件 进行handlermapping的配置,不进行配置时BeanNameUrlHandlerMapping, handlermapping的三种方式 1.默认方式BeanNameUrlHandlerMapping,根据b

  • springboot+springmvc实现登录拦截

    这篇文章主要介绍了springboot+springmvc实现登录拦截,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 LoginInterceptor 实现 HandlerInterceptor 接口,自定义拦截器处理方法 LoginConfiguration 实现 WebMvcConfigurer 接口,注册拦截器 ResourceBundle 加载 properties文件数据,配置不进行拦截的路径 LoginInterceptor pac

  • 浅谈SpringMVC的执行流程

    #简易版 1.客户发送请求经过 DisPatcherServlet 核心过滤器 2.DisPatcherServlet 核心控制器在去找一个或多个HandlerMappering 找到需要处理的Controller 3.DisPatcherServlet 通过HandlerAdapter将请求转发给 Controller 4.Controller 调用业务处理后返回结果给 ModelAndView 5.DisPatcherServlet 找到一个或者多个 ViewResolver 视图解析器 找

  • SpringMVC的执行流程及组件详解

    这篇文章主要介绍了SpringMVC的执行流程及组件详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 一.核心模块 数据库访问技术与集成:JDBC.XML等 Web与远程调用技术:SpringMVC.WebServlet.WebSocket等 面向切面编程:AOP 基础设施:Tomcat Spring核心容器:Beans.Core.Context.Expression.ContestSupport 测试:Test 二.执行流程 1.用户通过页

  • SpringMVC日期类型接收空值异常问题解决方法

    最近遇到SpringMVC写个controller类,传一个空串的字符类型过来,正常情况是会自动转成date类型的,因为数据表对应类类型就是date的 解决方法是在controller类的后面加个注解: @InitBinder protected void initDateFormatBinder(WebDataBinder binder) { SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd"); binde

  • SpringMVC的执行过程浅析

    前言 通过深入分析Spring源码,我们知道Spring框架包括大致六大模块, 如Web模块,数据库访问技术模块,面向切面模块,基础设施模块,核心容器模块和模块, 其中,在Spring框架的Web模块中,又包含很多前端技术,如SpringMVC,Spring WebSocket,Spring WebPortlet等,在本篇文章中,我们主要分析SpringMVC模块, 在分析SpringMVC技术时,本篇文章将通过解读SpringMVC源码,并通过编译器断点调试追踪,研究Spring核心类的UML

  • SpringMVC实现多文件上传

    本文实例为大家分享了Spring MVC多文件上传的具体代码,供大家参考,具体内容如下 1)创建工程并导入JAR包 2)创建多文件选择页面 在 WebContent 目录下创建 JSP 页面 multiFiles.jsp,在该页面中使用表单上传多个文件,具体代码如下: <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%&g

  • Spring MVC Controller返回值及异常的统一处理方法

    旧的设计方案 开发api的时候,需要先定义好接口的数据响应结果.如下是一个很简单直接的Controller实现方法及响应结果定义. @RestController @RequestMapping("/users") public class UserController { @Inject private UserService userService; @GetRequest("/{userId:\\d+}") public ResponseBean signin

  • Spring MVC Controller传递枚举值的实例

    目录 Spring MVC Controller传递枚举值 功能描述 枚举定义 定义Controller类 请求示例 结论 Spring MVC 枚举传值问题 最后找到解决方案 Spring MVC Controller传递枚举值 功能描述 本文将通过一个小示例,展示在请求参数中传递枚举值. 枚举定义 角色类定义: public enum RoleEnum { EMPLOYEE((short)1, "Employee"), MANAGER((short)2, "Manager

  • SpringBoot全局Controller返回值格式统一

    目录 一.返回值格式统一 1.返回值介绍 2.基础类功能 3.基础实现 二.附录说明 一.返回值格式统一 1.返回值介绍 在使用controller对外提供服务的时候,很多时候都需要统一返回值格式,例如 { "status": true, "message": null, "code": "200", "data": { "name": "json", "d

  • Spring mvc Controller和RestFul原理解析

    控制器Controller 控制器复杂提供访问应用程序的行为,通常通过接口定义或注解定义两种方法实现. 控制器负责解析用户的请求并将其转换为一个模型. 在Spring MVC中一个控制器类可以包含多个方法 在Spring MVC中,对于Controller的配置方式有很多种 实现Controller接口 Controller是一个接口,在org.springframework.web.servlet.mvc包下,接口中只有一个方法: //实现该接口的类获得控制器功能 public interfa

  • 解析springboot包装controller返回值问题

    1.springboot项目统一包装返回值,通常返回结果包含code.message.data,结构如下 import lombok.AllArgsConstructor; import lombok.Data; import lombok.NoArgsConstructor; @Data @NoArgsConstructor @AllArgsConstructor public class ResponseResult<T> { private int code; private Strin

  • SpringMVC Controller 返回值的可选类型详解

    spring mvc 支持如下的返回方式:ModelAndView, Model, ModelMap, Map,View, String, void. ModelAndView @RequestMapping("/hello") public ModelAndView helloWorld() { String message = "Hello World, Spring 3.x!"; return new ModelAndView("hello"

  • JS模态窗口返回值兼容问题的完美解决方法

    因系统要兼容原IE已使用的关闭方法,经调试测得,需对window.dialogArguments进行再较验,不然易出问题. function OKEnd(vals) { if (vals == null) vals = "TRUE"; if (typeof (window.opener) == "undefined") { if (typeof (window.dialogArguments) != "undefined") { if (wind

  • ASP.NET Core Mvc中空返回值的处理方法详解

    前言 如果你是一个初学者开始学习 ASP.NET 或 ASP.NET MVC, 你可能并不知道什么是. net Framework和. net ore.不用担心!我建议您看下官方文档https://docs.microsoft.com/zh-cn/aspnet/index , 您可以轻松地看到比较和差异. .NET Core MVC在如何返回操作结果方面非常灵活的. 你可以返回一个实现IActionResult接口的对象, 比如我们熟知的ViewResult, FileResult, Conte

  • Spring Mvc下实现以文件流方式下载文件的方法示例

    项目中需要对一个点击事件进行下载操作,同时通过点击事件,已经可以从jsp页面获取到需要访问的URL和下载的文件名(数据库获取,jsp页面显示).点击事件JS如下: function downloadFile(filePath,fileName){ fileName = fileName.substr(0,fileName.lastIndexOf(".")); $.ajax({ async : false, cache:false, type: 'get', dataType : &qu

  • Spring MVC基于注解的使用之JSON数据处理的方法

    目录 1.JSON数据交互 1.1 JSON概述 1.1.1 对象结构 1.1.2 数组结构 1.2 JSON数据转换 2. HttpMessageConverter 2.1 @RequestBody 2.2 @ResponseBody 1.JSON数据交互 1.1 JSON概述 JSON 是一种轻量级的数据交换格式,是一种理想的数据交互语言,它易于阅读和编写,同时也易于机器解析和生成.JSON有两种数据结构: 对象结构 数组结构 1.1.1 对象结构 对象结构是由花括号括起来的逗号分割的键值对

随机推荐