Spring controller层异常的统一处理

最新推荐文章于 2023-10-20 11:09:37 发布

weixin_33985507

最新推荐文章于 2023-10-20 11:09:37 发布

阅读量300

点赞数

CC 4.0 BY-SA版权

文章标签： java 前端 python ViewUI

原文链接：https://my.oschina.net/u/3136014/blog/983785

本文介绍如何在Spring MVC项目中实现异常的统一处理，通过AOP技术捕获所有@RequestMapping注解的方法产生的异常，并根据不同情况返回合适的响应或记录日志。

2019独角兽企业重金招聘Python工程师标准>>>

1、Spring controller层异常的统一处理

该方法是在 https://my.oschina.net/u/3136014/blog/904643 上的某一方面扩展，使其在异常（包括RuntimeException和各种自定义异常）的抓取与前端显示上的统一。

1.1 spring-mvc.xml：配置xml

此处class为该ExceptionAspect.java的路径

	<!-- 异常捕获aop -->
	<bean id="exceptionHandler" class="*.*.ExceptionAspect" />

1.2 ExceptionAspect.java：

这里取了个巧：Pointcut切点选择了所有被@RequestMapping注解修饰的方法,按照代码规范，所有被注解修饰的方法均在controller里。

利用aop的around(环绕)，对异常进行抓取并进行相应的处理

同时判断其是否为ajax请求，同时可根据抓取的异常里的e.getMessage()来接收自定义异常的报错内容，使其交互更符合实际需求。


/**
 * @Description: 切面：统一的异常处理
 */

@Aspect
@Component
public class ExceptionAspect  extends BaseAction {

    @Autowired
    private HttpServletRequest request;
    
    //日志相关的service层，将相关数据以日志形式保存下来
    @Resource
    private SysLogService sysLogService;

    // Controller层切点
    @Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")
    
    //@annotation用于匹配当前执行方法持有指定注解的方法；
    public void exceptionAspect() {
    }

    @Around("exceptionAspect()")
    public Object around(ProceedingJoinPoint joinPoint){
        Object object = null;
        Result result = new Result();
        try {
            object = joinPoint.proceed();
            return object;
        } catch (Exception e) {
            e.printStackTrace();
            String message = e.getMessage();
            if(StringUtils.isNotBlank(message)){
                if(message.length() > 100){
                    message = message.substring(0,100);
                }
                result.setMsg(message);
            }else {
                result.setMsg("" + e.getClass());
            }
            sysLogService.saveByJoinPoint(joinPoint,SecurityConstants.OPER_LOG_STATUS.OPER_LOG_STATUS_FAIL_4ENUM.getValue(),result.getMsg());
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        //request.getHeader("x-requested-with")为 null，则为传统同步请求，为 XMLHttpRequest，则为 Ajax 异步请求。
        if("XMLHttpRequest".equals(request.getHeader("x-requested-with"))){
            return result;//是ajax请求
        } else {
            Map<String,Object> context = new HashMap<String,Object>();
            context.put("result",result);
            JSONObject jsonObject =  coverJson("/test/common/page/error.vm",context);
            ModelAndView mav = new ModelAndView("/common/page/error");
            mav.addAllObjects(jsonObject);
            return mav;
        }
    }
}