在spring中手寫(xiě)全局異常攔截器
為什么要重復(fù)造輪子
你可能會(huì)問(wèn),Spring已經(jīng)自帶了全局異常攔截,為什么還要重復(fù)造輪子呢?
這是個(gè)好問(wèn)題,我覺(jué)得有以下幾個(gè)原因
裝逼 Spring的全局異常攔截只是針對(duì)于Spring MVC的接口,對(duì)于你的RPC接口就無(wú)能為力了 無(wú)法定制化 除了寫(xiě)業(yè)務(wù)代碼,我們其實(shí)還能干點(diǎn)別的事我覺(jué)得上述理由已經(jīng)比較充分的解答了為什么要重復(fù)造輪子,接下來(lái)就來(lái)看一下怎么造輪子
造個(gè)什么樣的輪子?
我覺(jué)得全局異常攔截應(yīng)該有如下特性
使用方便,最好和spring原生的使用方式一致,降低學(xué)習(xí)成本 能夠支持所有接口 調(diào)用異常處理器可預(yù)期,比如說(shuō)定義了RuntimeException的處理器和Exception的處理器,如果這個(gè)時(shí)候拋出NullPointException,這時(shí)候要能沒(méi)有歧義的選擇預(yù)期的處理器如何造輪子?
由于現(xiàn)在的應(yīng)用基本上都是基于spring的,因此我也是基于SpringAop來(lái)實(shí)現(xiàn)全局異常攔截
首先先定義幾個(gè)注解
@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 的作用是標(biāo)志定義異常處理器的類(lèi),方便找到異常處理器
@ExceptionHandler 的作用是標(biāo)記某個(gè)方法是處理異常的,里面的值是能夠處理的異常類(lèi)型
@ExceptionIntercept 的作用是標(biāo)記需要異常攔截的方法
接下來(lái)定義統(tǒng)一返回格式,以便出現(xiàn)錯(cuò)誤的時(shí)候統(tǒng)一返回
@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; }}
然后定義一個(gè)收集異常處理器的類(lèi)
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('沒(méi)有找到對(duì)應(yīng)的異常處理器')).getMethod(); } @AllArgsConstructor @Getter class ExceptionMethod { private Class<? extends Throwable> clazz; private Method method; }}
ExceptionMethod 里面有兩個(gè)屬性
clazz:這個(gè)代表著能夠處理的異常 method:代表著處理異常調(diào)用的方法ExceptionMethodPool 里面按序存放所有異常處理器,excutor是執(zhí)行這些異常處理器的對(duì)象
接下來(lái)把所有定義的異常處理器收集起來(lái)
@Componentpublic class ExceptionBeanPostProcessor implements BeanPostProcessor { private ExceptionMethodPool exceptionMethodPool; @Autowired private ConfigurableApplicationContext context; @Override public 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('不允許有兩個(gè)異常定義類(lèi)'); 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));}); //注冊(cè)進(jìn)spring容器 context.getBeanFactory().registerSingleton('exceptionMethodPool',exceptionMethodPool); return bean; }}
ExceptionBeanPostProcessor 通過(guò)實(shí)現(xiàn)BeanPostProcessor 接口,在bean初始化之前,把所有異常處理器塞進(jìn) ExceptionMethodPool,并把其注冊(cè)進(jìn)Spring容器
然后定義異常處理器
@Componentpublic class ExceptionProcessor { @Autowired private 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,'未知錯(cuò)誤')); }}
這里應(yīng)用了我自己通過(guò)函數(shù)式編程封裝的一些語(yǔ)法糖,有興趣的可以看下
最后通過(guò)AOP進(jìn)行攔截
@Aspect@Componentpublic class ExceptionInterceptAop { @Autowired private 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); } } @FunctionalInterface public interface ThrowExceptionSupplier<T> { T get() throws Throwable; }}
到這里代碼部分就已經(jīng)完成了,我們來(lái)看下如何使用
@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') @ExceptionIntercept public 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(); }}
我們通過(guò)@ExceptionAdvice標(biāo)志定義異常處理器的類(lèi),然后通過(guò)@ExceptionHandler標(biāo)注處理異常的方法,方便收集
最后在需要異常攔截的方法上面通過(guò)@ExceptionIntercept進(jìn)行異常攔截
我沒(méi)有使用Spring那種匹配最近父類(lèi)的方式尋找匹配的異常處理器,我覺(jué)得這種設(shè)計(jì)是一個(gè)敗筆,理由如下
代碼復(fù)雜 不能一眼看出要去調(diào)用哪個(gè)異常處理器,尤其是定義的異常處理器非常多的時(shí)候,要是弄多個(gè)定義類(lèi)就更不好找了,可能要把所有的處理器看完才知道應(yīng)該調(diào)用哪個(gè)出于以上考慮,我只保留了一個(gè)異常處理器定義類(lèi),并且匹配順序和方法定義順序一致,從上到下依次匹配,這樣只要找到一個(gè)能夠處理的處理器,那么就知道了會(huì)如何調(diào)用
原創(chuàng)不易,如果覺(jué)得對(duì)你有幫助,麻煩點(diǎn)個(gè)贊!
我會(huì)不定期分享一些有意思的技術(shù),點(diǎn)個(gè)關(guān)注不迷路-。 -
以上就是在spring中手寫(xiě)全局異常攔截器的詳細(xì)內(nèi)容,更多關(guān)于spring 全局異常攔截的資料請(qǐng)關(guān)注好吧啦網(wǎng)其它相關(guān)文章!
相關(guān)文章:
1. XML入門(mén)的常見(jiàn)問(wèn)題(二)2. jsp cookie+session實(shí)現(xiàn)簡(jiǎn)易自動(dòng)登錄3. ASP.NET Core實(shí)現(xiàn)中間件的幾種方式4. asp中response.write("中文")或者js中文亂碼問(wèn)題5. JSP 中request與response的用法詳解6. asp取整數(shù)mod 有小數(shù)的就自動(dòng)加17. ASP基礎(chǔ)知識(shí)Command對(duì)象講解8. css代碼優(yōu)化的12個(gè)技巧9. phpstudy apache開(kāi)啟ssi使用詳解10. CSS3中Transition屬性詳解以及示例分享
