基于spring注解AOP的异常处理
一、前言
項(xiàng)目剛剛開發(fā)的時(shí)候,并沒有做好充足的準(zhǔn)備。開發(fā)到一定程度的時(shí)候才會(huì)想到還有一些問題沒有解決。就比如今天我要說的一個(gè)問題:異常的處理。寫程序的時(shí)候一般都會(huì)通過try...catch...finally對(duì)異常進(jìn)行處理,但是我們真的能在寫程序的時(shí)候處理掉所有可能發(fā)生的異常嗎? 以及發(fā)生異常的時(shí)候執(zhí)行什么邏輯,返回什么提示信息,跳轉(zhuǎn)到什么頁(yè)面,這些都是要考慮到的。
二、基于@ControllerAdvice(加強(qiáng)的控制器)的異常處理
參考文檔:http://jinnianshilongnian.iteye.com/blog/1866350
@ControllerAdvice注解內(nèi)部使用@ExceptionHandler、@InitBinder、@ModelAttribute注解的方法應(yīng)用到所有的?@RequestMapping注解的方法。本例子中使用ExceptionHandler應(yīng)用到所有@RequestMapping注解的方法,處理發(fā)生的異常。
示例代碼:
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 異常對(duì)象* @return 異常提示*/@ExceptionHandler(Exception.class)public ResponseEntity<String> handleException(Exception e) {//不需要再記錄ServiceException,因?yàn)樵趕ervice異常切面中已經(jīng)記錄過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()) ? "系統(tǒng)異常!!" : e.getMessage();return new ResponseEntity<>(message, headers, HttpStatus.OK);} }如果不起作用,請(qǐng)檢查 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統(tǒng)一異常處理: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異常切面* 默認(rèn)spring aop不會(huì)攔截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 異常對(duì)象*/@AfterThrowing(pointcut = "webPointcut()", throwing = "e")public void handleThrowing(Exception e) {//不需要再記錄ServiceException,因?yàn)樵趕ervice異常切面中已經(jīng)記錄過if (!(e instanceof ServiceException)) {LOGGER.error(ExceptionUtils.getExcTrace(e));}String errorMsg = StringUtils.isEmpty(e.getMessage()) ? "系統(tǒng)異常" : e.getMessage();writeContent(errorMsg);}/*** 將內(nèi)容輸出到瀏覽器** @param content 輸出內(nèi)容*/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層異常,記錄異常日志,并設(shè)置對(duì)應(yīng)的異常信息* 目前只攔截Exception,是否要攔截Error需再做考慮** @param e 異常對(duì)象*/@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()) ? "服務(wù)異常" : e.getMessage()) : getMessage(signature);throw new ServiceException(errorMsg, e);}/*** 獲取方法簽名對(duì)應(yīng)的提示消息** @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" />或者 自定義一個(gè) 注冊(cè)類,ServiceExceptionAspect.java和WebExceptionAspect.java都加入@Component注解
import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.EnableAspectJAutoProxy;/*** 異常相關(guān)bean注冊(cè)類*/ @Configuration @EnableAspectJAutoProxy @ComponentScan("com.hjz.exception.aspect") public class ExceptionConfig {}注:spring 公共配置文件中的配置 改成?<bean class="com.hjz.exception.config.ExceptionConfig"/>,如果controller層的異常無(wú)法攔截,請(qǐng)將配置換到springmvc的配置文件中,原因請(qǐng)見(SpringMVC關(guān)于AOP攔截controller的注意事項(xiàng))
@Aspect @Component public class WebExceptionAspect {.......... }@Aspect @Component public class ServiceExceptionAspect {......... }四、疑惑
? @within(org.springframework.stereotype.Service),攔截帶有 @Service 注解的類的所有方法
? @annotation(org.springframework.web.bind.annotation.RequestMapping),攔截帶有@RquestMapping的注解方法
五、測(cè)試
分別編寫controller層和service層的異常測(cè)試類。這個(gè)很簡(jiǎn)單,在方法里簡(jiǎn)單的拋一下異常就可以了。最后驗(yàn)證一下,異常發(fā)生的時(shí)候有沒有 執(zhí)行?@AfterThrowing對(duì)應(yīng)的方法就好了。具體還是看我寫的demo吧,嘿嘿嘿!!!
完整項(xiàng)目下載地址:https://github.com/hjzgg/Spring-annotation-AOP-Exception_handling
?
轉(zhuǎn)載于:https://www.cnblogs.com/hujunzheng/p/6255463.html
總結(jié)
以上是生活随笔為你收集整理的基于spring注解AOP的异常处理的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 他克莫司软膏的作用与功效什么时候用合适(
- 下一篇: 讲讲你第一次是什么感觉知乎(女生被进入的