乐山网站建设

专注高端品牌网站建设行业优质供应商！认准小谭建站！
028-86922220135-1821-9792
  • 首页
  • 网站建设
    网站设计包含服务 网站制作流程 有效沟通方式 售后服务
  • 微信开发
  • 案例展示
    乐山小谭建站公司作品案例展示
  • 新闻资讯
  • 解决方案
  • 小谭建站
  • 联系我们

    • 如何处理SpringMVCController返回值及异常

    这篇文章主要为大家展示了“如何处理Spring MVC Controller返回值及异常”，内容简而易懂，条理清晰，希望能够帮助大家解决疑惑，下面让小编带领大家一起研究并学习一下“如何处理Spring MVC Controller返回值及异常”这篇文章吧。

    创新互联公司主营清河门网站建设的网络公司,主营网站建设方案,成都app开发,清河门h5微信小程序搭建,清河门网站营销推广欢迎清河门等地区企业咨询

    旧的设计方案

    开发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 {
 
 private Logger logger = LogManager.getLogger(getClass());

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

 @Override
 public Object beforeBodyWrite(Object body, MethodParameter returnType, MediaType selectedContentType,
   Class> 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 errors = new ArrayList();
  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 errors = new ArrayList();

  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  void logException(T e) {
  logger.error(String.format(logExceptionFormat, e.getMessage()), e);
 }
}
    通过上面的配置，可以有效地将异常进行统一的处理，同时对返回的结果进行统一的封装。
    以上是“如何处理Spring MVC Controller返回值及异常”这篇文章的所有内容，感谢各位的阅读！相信大家都有了一定的了解，希望分享的内容对大家有所帮助，如果还想学习更多知识，欢迎关注创新互联行业资讯频道！
                
            
                        
    
            分享名称：如何处理SpringMVCController返回值及异常            
    
            URL地址：http://lszwz.com/article/ighjps.html
        
    
    
    
        
    其他资讯
    
        
    
    


    
    
    
        
    
            
    
            
    售后响应及时
    7×24小时客服热线
        
    
        
    
            
    
            
    数据备份
    更安全、更高效、更稳定
        
    
        
    
            
    
            
    价格公道精准
    项目经理精准报价不弄虚作假
        
    
        
    
            
    
            
    合作无风险
    重合同讲信誉，无效全额退款
        
    
    
    

    

    
    
    
        
    
            
    
                
    
                    
    联系我们
    
                    TEL
                
    
                
    
                    
    135-1821-9792
    
                    
    028-86922220
    
                    
    地址：乐山市太升南路288号锦天国际
    

                
    
            
    
            
    
                
    
                    
    快捷导航
    
                    Shortcut
                
    
                
    
                    
      
                    
    
                    
                    
                    
                    
                    
    
                
    
            
    
            
    
                
    
                    
    二维码
    
                    QR CODE
                
    
                
    
                    
      
                        
    • 
                            
      微信公众号
      
                        
      • 
                        
    • 
                            
      手机端网站
      
                        
      • 
                        
      
                    
    
                
    
            
    
            
    
        
    
    
    
    
    
        
    乐山小谭建站工作室是一家专注从事于高品质视觉体验及互联网设计开发，乐山网站建设，乐山网站设计，乐山网页设计，乐山网站制作，品牌网站建设，营销网站建设，集团网站建设，企业网站建设，外贸网站建设，响应式网站建设，小程序开发，微信开发，企业形象设计，企业宣传视频等服务，小谭建站位于乐山市龙岗区大运软件小镇，小谭建站拥有经验丰富的高级网站建设工程师和一流的网页高端设计人员，具备各种规模与类型网站建设的雄厚实力，在网站建设领域树立了自己独特的设计风格。
        
    
        
    
            
    
                友情链接
                交换友情链接
            
    
            
    
                
    
                    东电技改   恒温恒湿空调机组   新华建筑装饰   资阳网站建设   网络营销推广   成都做网站建设公司   高端网站设计推广   手机网站建设公司   成都网站建设   成都二枢电信服务器托管                   
    
            
    
        
    
    
    
    
    
        
    
            
            
    Copyright © 2022 青羊区小谭信息技术咨询服务工作室 乐山建站工作室 All Rights Reserved   蜀ICP备2021004003号-25
                

            
    
            
    
        
    
    
    
    
    
        
    
            
            
    Copyright © 2022 青羊区小谭信息技术咨询服务工作室 乐山建站工作室 
    
            
     蜀ICP备2021004003号-25