基于spring注解AOP的異常處理

一、前言

　　項目剛剛開發的時候，并沒有做好充足的準備。開發到一定程度的時候才會想到還有一些問題沒有解決。就比如今天我要說的一個問題：異常的處理。寫程序的時候一般都會通過try...catch...finally對異常進行處理，但是我們真的能在寫程序的時候處理掉所有可能發生的異常嗎？以及發生異常的時候執行什么邏輯，返回什么提示信息，跳轉到什么頁面，這些都是要考慮到的。

二、基于@ControllerAdvice（加強的控制器）的異常處理

　　參考文檔：http://jinnianshilongnian.iteye.com/blog/1866350

　　@ControllerAdvice注解內部使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法應用到所有的?@RequestMapping注解的方法。本例子中使用ExceptionHandler應用到所有@RequestMapping注解的方法，處理發生的異常。

　　示例代碼：

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StringUtils;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;@ResponseBody
public class ExceptionAdvice {private static final Logger LOGGER = LoggerFactory.getLogger(ExceptionAdvice.class);/*** 攔截web層異常，記錄異常日志，并返回友好信息到前端* 目前只攔截Exception，是否要攔截Error需再做考慮** @param e 異常對象* @return 異常提示*/@ExceptionHandler(Exception.class)public ResponseEntity<String> handleException(Exception e) {//不需要再記錄ServiceException，因為在service異常切面中已經記錄過if (!(e instanceof ServiceException)) {LOGGER.error(ExceptionUtils.getExcTrace(e));}HttpHeaders headers = new HttpHeaders();headers.set("Content-type", "text/plain;charset=UTF-8");headers.add("icop-content-type", "exception");String message = StringUtils.isEmpty(e.getMessage()) ? "系統異常!!" : e.getMessage();return new ResponseEntity<>(message, headers, HttpStatus.OK);}
}

　　如果不起作用，請檢查 spring-mvc的配置文件，是否有ControllerAdvice的如下配置

<context:component-scan base-package="com.xxx.xx" use-default-filters="false">  <context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>  <context:include-filter type="annotation" expression="org.springframework.web.bind.annotation.ControllerAdvice"/>  </context:component-scan>

?　　附上：Spring MVC的Controller統一異常處理：HandlerExceptionResolver

三、基于AOP的異常處理

　　1.處理controller層的異常?WebExceptionAspect.java

import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.PrintWriter;/*** web異常切面* 默認spring aop不會攔截controller層，使用該類需要在spring公共配置文件中注入改bean，* 另外需要配置<aop:aspectj-autoproxy proxy-target-class="true"/>*/
@Aspect
public class WebExceptionAspect {private static final Logger LOGGER = LoggerFactory.getLogger(WebExceptionAspect.class);@Pointcut("@annotation(org.springframework.web.bind.annotation.RequestMapping)")private void webPointcut() {}/*** 攔截web層異常，記錄異常日志，并返回友好信息到前端* 目前只攔截Exception，是否要攔截Error需再做考慮** @param e 異常對象*/@AfterThrowing(pointcut = "webPointcut()", throwing = "e")public void handleThrowing(Exception e) {//不需要再記錄ServiceException，因為在service異常切面中已經記錄過if (!(e instanceof ServiceException)) {LOGGER.error(ExceptionUtils.getExcTrace(e));}String errorMsg = StringUtils.isEmpty(e.getMessage()) ? "系統異常" : e.getMessage();writeContent(errorMsg);}/*** 將內容輸出到瀏覽器** @param content 輸出內容*/private void writeContent(String content) {HttpServletResponse response = ((ServletRequestAttributes) RequestContextHolder.getRequestAttributes()).getResponse();response.reset();response.setCharacterEncoding("UTF-8");response.setHeader("Content-Type", "text/plain;charset=UTF-8");response.setHeader("icop-content-type", "exception");PrintWriter writer = null;try {writer = response.getWriter();} catch (IOException e) {e.printStackTrace();}writer.print(content);writer.flush();writer.close();}
}

　　2.處理service層的異常ServiceExceptionAspect?.java

import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;import com.hjz.exception.ServiceException;
import com.hjz.exception.utils.ExceptionUtils;@Aspect
public class ServiceExceptionAspect {private static final Logger LOGGER = LoggerFactory.getLogger(ServiceExceptionAspect.class);/*** @within(org.springframework.stereotype.Service)，攔截帶有 @Service 注解的類的所有方法* @annotation(org.springframework.web.bind.annotation.RequestMapping)，攔截帶有@RquestMapping的注解方法*/@Pointcut("@within(org.springframework.stereotype.Service) && execution(public * *(..))")private void servicePointcut() {}/*** 攔截service層異常，記錄異常日志，并設置對應的異常信息* 目前只攔截Exception，是否要攔截Error需再做考慮** @param e 異常對象*/@AfterThrowing(pointcut = "servicePointcut()", throwing = "e")public void handle(JoinPoint point, Exception e) {LOGGER.error(ExceptionUtils.getExcTrace(e));String signature = point.getSignature().toString();String errorMsg = getMessage(signature) == null ? (StringUtils.isEmpty(e.getMessage()) ? "服務異常" : e.getMessage()) : getMessage(signature);throw new ServiceException(errorMsg, e);}/*** 獲取方法簽名對應的提示消息** @param signature 方法簽名* @return 提示消息*/private String getMessage(String signature) {return null;}
}

?　　3.使用方式，在spring的公共配置文件中加入如下配置：

<aop:aspectj-autoproxy proxy-target-class="true" />
<bean class="com.hjz.exception.aspect.ServiceExceptionAspect" />
<bean class="com.hjz.exception.aspect.WebExceptionAspect" />

　　或者自定義一個注冊類，ServiceExceptionAspect.java和WebExceptionAspect.java都加入@Component注解

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;/*** 異常相關bean注冊類*/
@Configuration
@EnableAspectJAutoProxy
@ComponentScan("com.hjz.exception.aspect")
public class ExceptionConfig {}

　　注：spring 公共配置文件中的配置改成?<bean class="com.hjz.exception.config.ExceptionConfig"/>，如果controller層的異常無法攔截，請將配置換到springmvc的配置文件中，原因請見（SpringMVC關于AOP攔截controller的注意事項）

@Aspect
@Component
public class WebExceptionAspect {..........  
}@Aspect
@Component
public class ServiceExceptionAspect {.........
}

四、疑惑

?　　@within(org.springframework.stereotype.Service)，攔截帶有 @Service 注解的類的所有方法
?　　@annotation(org.springframework.web.bind.annotation.RequestMapping)，攔截帶有@RquestMapping的注解方法