spring全局異常攔截器怎么實現

這篇文章給大家分享的是有關spring全局異常攔截器怎么實現的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。

你可能會問，Spring已經自帶了全局異常攔截，為什么還要重復造輪子呢？

這是個好問題，我覺得有以下幾個原因

1. 裝逼

2. Spring的全局異常攔截只是針對于Spring MVC的接口，對于你的RPC接口就無能為力了

3. 無法定制化

4. 除了寫業務代碼，我們其實還能干點別的事

我覺得上述理由已經比較充分的解答了為什么要重復造輪子，接下來就來看一下怎么造輪子

造個什么樣的輪子？

我覺得全局異常攔截應該有如下特性

1. 使用方便，最好和spring原生的使用方式一致，降低學習成本

2. 能夠支持所有接口

3. 調用異常處理器可預期，比如說定義了RuntimeException的處理器和Exception的處理器，如果這個時候拋出NullPointException，這時候要能沒有歧義的選擇預期的處理器

如何造輪子？

由于現在的應用基本上都是基于spring的，因此我也是基于SpringAop來實現全局異常攔截

首先先定義幾個注解

@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Componentpublic @interface ExceptionAdvice {} @Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ExceptionHandler {Class<? extends Throwable>[] value();} @Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface ExceptionIntercept {}

@ExceptionAdvice 的作用是標志定義異常處理器的類，方便找到異常處理器

@ExceptionHandler 的作用是標記某個方法是處理異常的，里面的值是能夠處理的異常類型

@ExceptionIntercept 的作用是標記需要異常攔截的方法

接下來定義統一返回格式，以便出現錯誤的時候統一返回

@Datapublic class BaseResponse<T> {private Integer code;private String message;private T data; public BaseResponse(Integer code, String message) {this.code = code;this.message = message;}}

然后定義一個收集異常處理器的類

public class ExceptionMethodPool {private List<ExceptionMethod> methods;private Object excutor; public ExceptionMethodPool(Object excutor) {this.methods = new ArrayList<ExceptionMethod>();this.excutor = excutor;} public Object getExcutor() {return excutor;} public void add(Class<? extends Throwable> clazz, Method method) {methods.add(new ExceptionMethod(clazz, method));}  	//按序查找能夠處理該異常的處理器public Method obtainMethod(Throwable throwable) {return methods.stream().filter(e -> e.getClazz().isAssignableFrom(throwable.getClass())).findFirst().orElseThrow(() ->new RuntimeException("沒有找到對應的異常處理器")).getMethod();} @AllArgsConstructor@Getterclass ExceptionMethod {private Class<? extends Throwable> clazz;private Method method;}}

ExceptionMethod 里面有兩個屬性

• clazz：這個代表著能夠處理的異常

• method：代表著處理異常調用的方法

ExceptionMethodPool 里面按序存放所有異常處理器，excutor是執行這些異常處理器的對象

接下來把所有定義的異常處理器收集起來

@Componentpublic class ExceptionBeanPostProcessor implements BeanPostProcessor {private ExceptionMethodPool exceptionMethodPool;@Autowiredprivate ConfigurableApplicationContext context; @Overridepublic Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {Class<?> clazz = bean.getClass();ExceptionAdvice advice = clazz.getAnnotation(ExceptionAdvice.class);if (advice == null) return bean;if (exceptionMethodPool != null) throw new RuntimeException("不允許有兩個異常定義類");exceptionMethodPool = new ExceptionMethodPool(bean); //保持處理異常方法順序Arrays.stream(clazz.getDeclaredMethods()).filter(method -> method.getAnnotation(ExceptionHandler.class) != null).forEach(method -> {ExceptionHandler exceptionHandler = method.getAnnotation(ExceptionHandler.class);Arrays.stream(exceptionHandler.value()).forEach(c -> exceptionMethodPool.add(c,method));});//注冊進spring容器context.getBeanFactory().registerSingleton("exceptionMethodPool",exceptionMethodPool);return bean;}}

ExceptionBeanPostProcessor 通過實現BeanPostProcessor 接口，在bean初始化之前，把所有異常處理器塞進 ExceptionMethodPool,并把其注冊進Spring容器

然后定義異常處理器

@Componentpublic class ExceptionProcessor {@Autowiredprivate ExceptionMethodPool exceptionMethodPool; public BaseResponse process(Throwable e) {return (BaseResponse) FunctionUtil.computeOrGetDefault(() ->{Method method = exceptionMethodPool.obtainMethod(e);method.setAccessible(true);return method.invoke(exceptionMethodPool.getExcutor(),e);},new BaseResponse(0,"未知錯誤"));}}

這里應用了我自己通過函數式編程封裝的一些語法糖，有興趣的可以看下

最后通過AOP進行攔截

@Aspect@Componentpublic class ExceptionInterceptAop {@Autowiredprivate ExceptionProcessor exceptionProcessor; @Pointcut("@annotation(com.example.exception.intercept.ExceptionIntercept)")public void pointcut() {} @Around("pointcut()")public Object around(ProceedingJoinPoint point) {return computeAndDealException(() -> point.proceed(),e -> exceptionProcessor.process(e));} public static <R> R computeAndDealException(ThrowExceptionSupplier<R> supplier, Function<Throwable, R> dealFunc) {try {return supplier.get();} catch (Throwable e) {return dealFunc.apply(e);}}@FunctionalInterfacepublic interface ThrowExceptionSupplier<T> {T get() throws Throwable;}}

到這里代碼部分就已經完成了，我們來看下如何使用

@ExceptionAdvicepublic class ExceptionConfig {@ExceptionHandler(value = NullPointerException.class)public BaseResponse process(NullPointerException e){return new BaseResponse(0,"NPE");} @ExceptionHandler(value = Exception.class)public BaseResponse process(Exception e){return new BaseResponse(0,"Ex");} } @RestControllerpublic class TestControler { @RequestMapping("/test")@ExceptionInterceptpublic BaseResponse test(@RequestParam("a") Integer a){if (a == 1){return new BaseResponse(1,a+"");}else if (a == 2){throw new NullPointerException();}else throw new RuntimeException();}}

我們通過@ExceptionAdvice標志定義異常處理器的類，然后通過@ExceptionHandler標注處理異常的方法，方便收集

最后在需要異常攔截的方法上面通過@ExceptionIntercept進行異常攔截

我沒有使用Spring那種匹配最近父類的方式尋找匹配的異常處理器，我覺得這種設計是一個敗筆，理由如下

• 代碼復雜

• 不能一眼看出要去調用哪個異常處理器，尤其是定義的異常處理器非常多的時候，要是弄多個定義類就更不好找了，可能要把所有的處理器看完才知道應該調用哪個

出于以上考慮，我只保留了一個異常處理器定義類，并且匹配順序和方法定義順序一致，從上到下依次匹配，這樣只要找到一個能夠處理的處理器，那么就知道了會如何調用

感謝各位的閱讀！關于“spring全局異常攔截器怎么實現”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！