在spring中手寫全局異常攔截器

更新時(shí)間：2020年11月16日 14:19:25 作者：CrazyMark

這篇文章主要介紹了如何在spring中手寫全局異常攔截器，幫助大家更好的理解和使用spring框架，感興趣的朋友可以了解下

為什么要重復(fù)造輪子

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

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

裝逼
Spring的全局異常攔截只是針對于Spring MVC的接口，對于你的RPC接口就無能為力了
無法定制化
除了寫業(yè)務(wù)代碼，我們其實(shí)還能干點(diǎn)別的事

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

造個(gè)什么樣的輪子？

我覺得全局異常攔截應(yīng)該有如下特性

使用方便，最好和spring原生的使用方式一致，降低學(xué)習(xí)成本
能夠支持所有接口
調(diào)用異常處理器可預(yù)期，比如說定義了RuntimeException的處理器和Exception的處理器，如果這個(gè)時(shí)候拋出NullPointException，這時(shí)候要能沒有歧義的選擇預(yù)期的處理器

如何造輪子？

由于現(xiàn)在的應(yīng)用基本上都是基于spring的，因此我也是基于SpringAop來實(shí)現(xiàn)全局異常攔截

首先先定義幾個(gè)注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ExceptionAdvice {
}

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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionIntercept {
}

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

@ExceptionHandler 的作用是標(biāo)記某個(gè)方法是處理異常的，里面的值是能夠處理的異常類型

@ExceptionIntercept 的作用是標(biāo)記需要異常攔截的方法

接下來定義統(tǒng)一返回格式，以便出現(xiàn)錯誤的時(shí)候統(tǒng)一返回

@Data
public 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è)收集異常處理器的類

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("沒有找到對應(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í)行這些異常處理器的對象

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

@Component
public 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è)異常定義類");
    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));
        });
    //注冊進(jìn)spring容器
    context.getBeanFactory().registerSingleton("exceptionMethodPool",exceptionMethodPool);
    return bean;
  }
}

ExceptionBeanPostProcessor 通過實(shí)現(xiàn)BeanPostProcessor 接口，在bean初始化之前，把所有異常處理器塞進(jìn) ExceptionMethodPool,并把其注冊進(jìn)Spring容器

然后定義異常處理器

@Component
public 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,"未知錯誤"));
  }
}

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

最后通過AOP進(jìn)行攔截

@Aspect
@Component
public 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)完成了，我們來看下如何使用

@ExceptionAdvice
public 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");
  }
  
}

@RestController
public 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();
  }
}

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

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

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