异常处理

通常一个web框架中，有大量需要处理的异常。比如业务异常，权限不足等等。前端通过弹出提示信息的方式告诉用户出了什么错误。通常情况下我们用try…..catch…. 对异常进行捕捉处理，但是在实际项目中对业务模块进行异常捕捉，会造成代码重复和繁杂，我们希望代码中只有业务相关的操作，所有的异常我们单独设立一个类来处理它。全局异常就是对框架所有异常进行统一管理。我们在可能发生异常的方法里throw抛给控制器。然后由全局异常处理器对异常进行统一处理。如此，我们的Controller中的方法就可以很简洁了。

所谓全局异常处理器就是使用@ControllerAdvice注解。示例如下：

1、统一返回实体定义

  1. package com.ruoyi.common.core.domain;
  3. import java.util.HashMap;
  5. /**
  6.  * 操作消息提醒
  7.  * 
  8.  * @author ruoyi
  9.  */
  10. public class AjaxResult extends HashMap<String, Object>
  11. {
  12.     private static final long serialVersionUID = 1L;
  14.     /**
  15.      * 返回错误消息
  16.      * 
  17.      * @param code 错误码
  18.      * @param msg 内容
  19.      * @return 错误消息
  20.      */
  21.     public static AjaxResult error(String msg)
  22.     {
  23.         AjaxResult json = new AjaxResult();
  24.         json.put("msg", msg);
  25.         json.put("code", 500);
  26.         return json;
  27.     }
  29.     /**
  30.      * 返回成功消息
  31.      * 
  32.      * @param msg 内容
  33.      * @return 成功消息
  34.      */
  35.     public static AjaxResult success(String msg)
  36.     {
  37.         AjaxResult json = new AjaxResult();
  38.         json.put("msg", msg);
  39.         json.put("code", 0);
  40.         return json;
  41.     }
  42. }

2、定义登录异常定义

  1. package com.ruoyi.common.exception;
  3. /**
  4.  * 登录异常
  5.  * 
  6.  * @author ruoyi
  7.  */
  8. public class LoginException extends RuntimeException
  9. {
  10.     private static final long serialVersionUID = 1L;
  12.     protected final String message;
  14.     public LoginException(String message)
  15.     {
  16.         this.message = message;
  17.     }
  19.     @Override
  20.     public String getMessage()
  21.     {
  22.         return message;
  23.     }
  24. }

3、基于@ControllerAdvice注解的Controller层的全局异常统一处理 

  1. package com.ruoyi.framework.web.exception;
  3. import org.slf4j.Logger;
  4. import org.slf4j.LoggerFactory;
  5. import org.springframework.web.bind.annotation.ExceptionHandler;
  6. import org.springframework.web.bind.annotation.RestControllerAdvice;
  7. import com.ruoyi.common.core.domain.AjaxResult;
  8. import com.ruoyi.common.exception.LoginException;
  10. /**
  11.  * 全局异常处理器
  12.  * 
  13.  * @author ruoyi
  14.  */
  15. @RestControllerAdvice
  16. public class GlobalExceptionHandler
  17. {
  18.     private static final Logger log = LoggerFactory.getLogger(GlobalExceptionHandler.class);
  20.     /**
  21.      * 登录异常
  22.      */
  23.     @ExceptionHandler(LoginException.class)
  24.     public AjaxResult loginException(LoginException e)
  25.     {
  26.         log.error(e.getMessage(), e);
  27.         return AjaxResult.error(e.getMessage());
  28.     }
  29. }

4、测试访问请求

  1. @Controller
  2. public class SysIndexController 
  3. {
  4.     /**
  5.      * 首页方法
  6.      */
  7.     @GetMapping("/index")
  8.     public String index(ModelMap mmap)
  9.     {
  10.         /**
  11.          * 模拟用户未登录，抛出业务逻辑异常
  12.          */
  13.         SysUser user = ShiroUtils.getSysUser();
  14.         if (StringUtils.isNull(user))
  15.         {
  16.             throw new LoginException("用户未登录，无法访问请求。");
  17.         }
  18.         mmap.put("user", user);
  19.         return "index";
  20.     }
  21. }

根据上面代码含义，当我们未登录访问/index时就会发生LoginException业务逻辑异常，按照我们之前的全局异常配置以及统一返回实体实例化，访问后会出现AjaxResult格式JSON数据，下面我们运行项目访问查看效果。界面输出内容如下所示：

  1. {
  2.     "msg": "用户未登录，无法访问请求。",
  3.     "code": 500
  4. }

对于一些特殊情况，如接口需要返回json，页面请求返回html可以使用如下方法： 

  1. @ExceptionHandler(LoginException.class)
  2. public Object loginException(HttpServletRequest request, LoginException e)
  3. {
  4.     log.error(e.getMessage(), e);
  6.     if (ServletUtils.isAjaxRequest(request))
  7.     {
  8.         return AjaxResult.error(e.getMessage());
  9.     }
  10.     else
  11.     {
  12.         return new ModelAndView("/error/500");
  13.     }
  14. }

若依系统的全局异常处理器GlobalExceptionHandler注意：如果全部异常处理返回json，那么可以使用@RestControllerAdvice代替@ControllerAdvice，这样在方法上就可以不需要添加@ResponseBody。