Struts2、Spring MVC4 框架下的ajax统一异常处理

本文算是struts2 异常处理3板斧、spring mvc4：异常处理 后续篇章，普通页面出错后可以跳到统一的错误处理页面，但是ajax就不行了，ajax的本意就是不让当前页面发生跳转，仅局部刷新，从而改善用户体验，基本思路是：把异常转换成json数据返回，这样ajax的回调函数，就能解析出错误原因。

一、如何区分ajax请求与普通请求

打开firefox的调试工具观察一下：

普通的页面请求

jquery发起的ajax请求

对比一下，可以发现jquery发生的ajax请求，Request Headers里多出了x-requested-with，用它就可以判断是否ajax请求。

二、struts2框架

a) 先定义一个ajax通用异常

package com.cnblogs.yjmyzz.exception;

public class AjaxException extends Exception {    

    private static final long serialVersionUID = -8503861588580421151L;

    public AjaxException(String message) {
        super(message);
    }

}

b) 然后修改异常拦截器

package com.cnblogs.yjmyzz.interceptor;
import javax.servlet.http.HttpServletRequest;

import org.apache.logging.log4j.*;
import org.apache.struts2.ServletActionContext;
import org.springframework.util.StringUtils;
import com.cnblogs.yjmyzz.exception.AjaxException;
import com.opensymphony.xwork2.*;
import com.opensymphony.xwork2.interceptor.*;

public class ExceptionInterceptor extends AbstractInterceptor {

    private static final long serialVersionUID = -6358803554282730952L;
    Logger logger = LogManager.getLogger();

    @Override
    public String intercept(ActionInvocation ai) throws Exception {
        String result = null;
        try {
            result = ai.invoke();
        } catch (Exception e) {
            logger.error(ai.toString(), e);
            ai.getStack().push(new ExceptionHolder(e));
            result = "error";

            HttpServletRequest request = ServletActionContext.getRequest();
            String xRequestedWith = request.getHeader("X-Requested-With");
            if (!StringUtils.isEmpty(xRequestedWith)) {
                // ajax请求
                // 转换成ajax异常，并放入stack中
                ai.getStack().push(
                        new ExceptionHolder(new AjaxException(e.getMessage())));
                result = "ajax-error";
            }
        }
        return result;
    }

}

c) 修改struts.xml文件

    <package name="base-default" extends="struts-default">
        <global-results>
            <result name="ajax-error">/WEB-INF/common/ajax-error.jsp</result>
            <result name="error">/WEB-INF/common/error.jsp</result>
        </global-results>
        <global-exception-mappings>
            <exception-mapping exception="com.cnblogs.yjmyzz.exception.AjaxException"
                result="ajax-error" />
            <exception-mapping exception="java.lang.Exception"
                result="error" />
        </global-exception-mappings>
    </package>

即：返回ajax-error，异常类型为AjaxException，则交给/WEB-INF/common/ajax-error.jsp处理

d) ajax-error.jsp页面

<%@ page contentType="application/json;charset=UTF-8" language="java"%><%@ taglib prefix="s" uri="/struts-tags"%>{"error":"<s:property value="exception" />"}

即：如果出错，最终返回的是json串，类似：{"error":"com.cnblogs.yjmyzz.exception.AjaxException: / by zero"}

e) 然后调用ajax的地方

            $.ajax({
                type:"GET",
                url:"${pageContext.request.contextPath}/rest/orders/x",               
                success: function(data, textStatus, jqXHR){
                    if (data.error!=undefined){
                        alert("错误：" + data.error);
                        return false;
                    }
                    //正常处理
                    alert("ajax请求成功!");
                },
                error: function(jqXHR, textStatus, errorThrown){
                    alert('error: ' + textStatus);
                }
            });

如果服务端出异常，则ajax调用完成后，会弹出异常信息，否则按正常流程处理

三、Spring MVC4

a) 先修改Controller基类里的异常处理方法

    @ExceptionHandler
    public String exp(HttpServletRequest request, Exception ex) {
        String resultViewName = "errors/error";

        // 记录日志
        logger.error(ex.getMessage(), ex);

        // 根据不同错误转向不同页面
        if (ex instanceof BusinessException) {
            resultViewName = "errors/biz-error";
        } else {
            // 异常转换
            ex = new Exception("系统太累了，需要休息!");
        }
        request.setAttribute("ex", ex);

        String xRequestedWith = request.getHeader("X-Requested-With");
        if (!StringUtils.isEmpty(xRequestedWith)) {
            // ajax请求
            resultViewName = "errors/ajax-error";

        }

        return resultViewName;
    }

大致意思是，如果发现是ajax请求，则有异常，则交给"errors/ajax-error"视图处理

b) ajax-error.jsp页面

<%@ page contentType="application/json;charset=UTF-8" language="java"%><%Exception e = (Exception) request.getAttribute("ex");%>{"error":"<%=e.getClass().getSimpleName()%>","detail":"<%=e.getMessage()%>"}

c) 调用ajax的页面

            $.ajax({
                type:"GET",
                url:"${pageContext.request.contextPath}/common-exception",               
                success: function(d, textStatus, jqXHR){
                    if (d.error!=undefined){
                        alert("错误：" + d.detail);
                        return false;
                    }
                    //其它正常处理
                    alert("ajax请求成功！");
                },
                error: function(jqXHR, textStatus, errorThrown){
                    alert('error: ' + textStatus);
                }
            });

如果服务端返回异常，ajax得到的反馈内容大概是：{"error":"Exception","detail":"系统太累了，需要休息!"}