前言

大家在使用Spring框架編寫Controller的時候，都會遇到這樣一種情況，就是想做一個全域性異常處理，目的是不要每個人都單獨攔截處理系統類的異常。

正文

下面我將介紹一種方法，利用HandlerExceptionResolver做一個統一的異常攔截處理，當然這種方式只適用於沒有手動攔截異常請求的情況，如果某一個Controller自己攔截並處理了異常，不會被這個統一異常處理所覆蓋到。

實現

步驟一，準備Resolver

package com.op.exception;

import com.google.gson.Gson;
import com.op.common.ResultJson;
import
 
 org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;

/**
 */
 

public class ServiceExceptionResolver implements HandlerExceptionResolver {
    private static final Logger logger = LoggerFactory.getLogger(ServiceExceptionResolver.class);

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        try
 
 {
            PrintWriter printWriter = response.getWriter();

            //返回結果封裝類
            ResultJson resultJson = new ResultJson();
            //業務異常的時候，按照各業務自身的異常訊息進行返回
            if (ex instanceof ServiceDataException) {
                resultJson.setCode(((ServiceDataException) ex).getCode());
                resultJson.setMessage(ex.getMessage());
            } else {//非業務異常的時候，統一處理為系統異常訊息進行返回
                resultJson.setCode(500);
                logger.error("系統異常，請稍後嘗試！", ex);
                resultJson.setMessage("系統異常，請稍後嘗試！");
            }

            Gson gson = new Gson();
            String json = gson.toJson(resultJson);
            logger.error("全域性異常處理！返回結果：{}", json, ex);
            response.setContentType("application/json;charset=UTF-8");
            //返回json資料。
            printWriter.println(json);
            printWriter.close();
        } catch (IOException e) {
            logger.error(e.getMessage(), e);
        }

        return null;
    }
}

這個示例圍繞兩個異常點來設計：

一個是業務異常，即開發者自己攔截的可以預知的異常；
一個是非業務異常，即開發者未攔截的不可預知的異常；

從實現中可以看出來這個異常處理最終應該返回到指定的頁面，但是我們這裡作為對前端提供的API介面，我們會統一處理為Json的形式並直接返回此內容。因此這裡的return null並不是沒有處理，而是直接將返回內容輸出到了終端！

步驟二，返回處理結果類ResultJson

示例中涉及到一個ResultJson返回處理結果類，其實其內容很簡單：

package com.op.common;

public class ResultJson {
    public int code;
    public String message;
    public Object data;

    public ResultJson(int code, String message) {
        this.code = code;
        this.message = message;
    }

    public ResultJson() {
        this.code = Constants.SUCCESS_CODE;
        this.message = "success";
    }

    public int getCode() {
        return code;
    }

    public void setCode(int code) {
        this.code = code;
    }

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }

    public Object getData() {
        return data;
    }

    public ResultJson setData(Object data) {
        this.data = data;
        return this;
    }
}

步驟三，配置該Bean

<bean class="com.op.exception.ServiceExceptionResolver"/>

在你的配置檔案中定義該Bean即可，Spring容器會掃描所有實現了HandlerExceptionResolver介面的異常處理器，統一處理！