Spring统一异常处理

Spring基于注解的统一异常处理

@ControllerAdvice

• 全局控制器, 注释在类上, 只能使用一次, 多个只会装备其中一个.
• @RestControllerAdvice是@ControllerAdvice和@ResponseBody的结合.
• 该类中可以使用@ModelAttribute, @InitBinder和 @ExceptionHandler, 这里只介绍异常处理.
• 注意: 这些东西controller中都可以单独配置, 只作用于当前Controller, 当Controller和全局配置中有相同的配置时, 会优先使用私有的

@ControllerAdvice
public class GlobalControllerAdvice {
    private static final Logger logger = LoggerFactory.getLogger(GlobalControllerAdvice.class);

    // 此处将键值对添加到全局，注解了@RequestMapping的方法都可以获得此键值对
    @ModelAttribute
    public void addAttributes(Model model) {
        model.addAttribute("msg", "额外的信息");
    }

    // 此处仅演示忽略request中的参数id
    @InitBinder
    public void initBinder(WebDataBinder webDataBinder) {
        webDataBinder.setDisallowedFields("id");
    }

    /**
     * 异常的默认处理, 并记录请求参数(对于post, 无法记录请求体的内容)
     *
     * @param request 请求
     * @param e       异常
     * @return 结果集
     */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Result exception(HttpServletRequest request, Exception e) {
        String paramsStr = null;
        if ("GET".equalsIgnoreCase(request.getMethod())) {
            paramsStr = request.getQueryString();
        } else {
            Map<String, String[]> params = request.getParameterMap();
            if (params != null && params.size() != 0) {
                StringBuilder sb = new StringBuilder();
                for (String key : params.keySet()) {
                    sb.append(key);
                    sb.append("=");
                    String[] values = params.get(key);
                    if (values == null || values.length == 0) {
                        sb.append("");
                    } else if (values.length == 1) {
                        sb.append(params.get(key)[0]);
                    } else {
                        sb.append(Arrays.toString(params.get(key)));
                    }
                    sb.append("&");
                }
                paramsStr = sb.deleteCharAt(sb.length() - 1).toString();
            }
        }
        if (paramsStr != null && paramsStr.length() > 500) {
            paramsStr = paramsStr.substring(0, 500);
        }
        logger.error("统一异常处理,请求参数:{},异常:", paramsStr, e);
        return new Result("FAIL", "服务器异常");
    }

    /**
     * 业务异常处理
     *
     * @param e
     * @return
     */
    @ExceptionHandler(BizException.class)
    //@ResponseStatus(value = HttpStatus.OK, reason = "SUCCESS")
    @ResponseBody
    public Result bizException(BizException e) {
        return new Result(e.getCode(), e.getMsg());
    }
}

@ExceptionHandler

• 异常处理, 多个异常规则, 比如BizException.class和Exception.class会优先匹配子类

@ResponseStatus

• 参考文档
• @ResponseStatus(value=HttpStatus.FORBIDDEN,reason=”用户名不匹配”)当value = HttpStatus.OK返回的是空白页
• 修饰异常, 抛出异常时会返回value和reason, 修饰方法, 该方法直接返回异常页面