SpringBoot中利用AOP和攔截器實現(xiàn)自定義注解

更新時間：2022年06月27日 11:38:57 作者：WX7251

本文將通過攔截器+AOP實現(xiàn)自定義注解，在這里攔截器充當(dāng)在指定注解處要執(zhí)行的方法，aop負(fù)責(zé)將攔截器的方法和要注解生效的地方做一個織入，感興趣的可以嘗試一下

前言

最近遇到了這樣一個工作場景，需要寫一批dubbo接口，再將dubbo接口注冊到網(wǎng)關(guān)中，但是當(dāng)dubbo接口異常的時候會給前端返回非常不友好的異常。所以就想要對異常進(jìn)行統(tǒng)一捕獲處理，但是對于這種service接口使用@ExceptionHandler注解進(jìn)行異常捕獲也是捕獲不到的，應(yīng)為他不是Controller的接口。這時就想到了自定義一個注解去實現(xiàn)異常捕獲的功能。

Spring實現(xiàn)自定義注解

通過攔截器+AOP實現(xiàn)自定義注解的實現(xiàn)，在這里攔截器充當(dāng)在指定注解處要執(zhí)行的方法，aop負(fù)責(zé)將攔截器的方法和要注解生效的地方做一個織入（通過動態(tài)注解生成代理類實現(xiàn)）。

1.引入相關(guān)依賴

spring-boot-starter：spring的一些核心基礎(chǔ)依賴

spring-boot-starter-aop：spring實現(xiàn)Aop的一些相關(guān)依賴

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

2.相關(guān)類

1.自定義注解類

@Target({ElementType.TYPE})  //說明了Annotation所修飾的對象范圍,這里，的作用范圍是類、接口(包括注解類型) 或enum
@Retention(RetentionPolicy.RUNTIME)  //自定義注解的有效期，Runtime：注解不僅被保存到class文件中，jvm加載class文件之后，仍然存在
@Documented //標(biāo)注生成javadoc的時候是否會被記錄
public @interface EasyExceptionResult {
}

2.攔截器類

/**
 * MethodInterceptor是AOP項目中的攔截器（注：不是動態(tài)代理攔截器），
 * 區(qū)別與HandlerInterceptor攔截目標(biāo)時請求，它攔截的目標(biāo)是方法。
 */
public class EasyExceptionIntercepter implements MethodInterceptor {
    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        AnnotatedElement element=invocation.getThis().getClass();
        EasyExceptionResult easyExceptionResult=element.getAnnotation(EasyExceptionResult.class);
        if (easyExceptionResult == null) {
            return invocation.proceed();
        }
        try {
            return invocation.proceed();
        } catch (Exception rpcException) {
            //不同環(huán)境下的一個異常處理
            System.out.println("發(fā)生異常了");
            return null;
        }
    }
}

3.切點切面類

MethodInterceptor的實現(xiàn)類能作為切面的執(zhí)行方式是應(yīng)為Interceptor的父類是Advice。

@Configuration
public class EasyExceptionAdvisor {
 
    /**
     * 放在最后執(zhí)行
     * 等待ump/日志等記錄結(jié)束
     *
     * @return {@link DefaultPointcutAdvisor}對象
     */
    @Bean
    @Order(Integer.MIN_VALUE)
    public DefaultPointcutAdvisor easyExceptionResultAdvisor() {
        DefaultPointcutAdvisor advisor = new DefaultPointcutAdvisor();
        //針對EasyExceptionResult注解創(chuàng)建切點
        AnnotationMatchingPointcut annotationMatchingPointcut = new AnnotationMatchingPointcut(EasyExceptionResult.class, true);
        EasyExceptionIntercepter interceptor = new EasyExceptionIntercepter();
        advisor.setPointcut(annotationMatchingPointcut);
        //在切點執(zhí)行interceptor中的invoke方法
        advisor.setAdvice(interceptor);
        return advisor;
    }
 
}

4.自定義注解的使用

@Service
@EasyExceptionResult  //自定義異常捕獲注解
public class EasyServiceImpl {
 
    public void testEasyResult(){
        throw new NullPointerException("測試自定義注解");
    }
 
}

5.效果

@SpringBootApplication
public class JdStudyApplication {
 
    public static void main(String[] args) {
        ConfigurableApplicationContext context=SpringApplication.run(JdStudyApplication.class, args);
        EasyServiceImpl easyService=context.getBean(EasyServiceImpl.class);
        easyService.testEasyResult();
    }
 
}

至此就實現(xiàn)了通過spring實現(xiàn)自定義注解。

Java實現(xiàn)自定義注解

雖然通過Spring實現(xiàn)了自定義注解但是還有辦法讓我們不通過Spring也能實現(xiàn)自定義注解，畢竟注解是早于Spring的。

JDK中有一些元注解，主要有@Target，@Retention,@Document,@Inherited用來修飾注解,如下為一個自定義注解。

@Target({ElementType.TYPE})  //說明了Annotation所修飾的對象范圍,這里，的作用范圍是類、接口(包括注解類型) 或enum
@Retention(RetentionPolicy.RUNTIME)  //自定義注解的有效期，Runtime：注解不僅被保存到class文件中，jvm加載class文件之后，仍然存在
@Documented //標(biāo)注生成javadoc的時候是否會被記錄
public @interface EasyExceptionResult {
}

@Target

表明該注解可以應(yīng)用的java元素類型

Target類型	描述
ElementType.TYPE	應(yīng)用于類、接口（包括注解類型）、枚舉
ElementType.FIELD	應(yīng)用于屬性（包括枚舉中的常量）
ElementType.METHOD	應(yīng)用于方法
ElementType.PARAMETER	應(yīng)用于方法的形參
ElementType.CONSTRUCTOR	應(yīng)用于構(gòu)造函數(shù)
ElementType.LOCAL_VARIABLE	應(yīng)用于局部變量
ElementType.ANNOTATION_TYPE	應(yīng)用于注解類型
ElementType.PACKAGE	應(yīng)用于包
ElementType.TYPE_PARAMETER	1.8版本新增，應(yīng)用于類型變量）
ElementType.TYPE_USE	1.8版本新增，應(yīng)用于任何使用類型的語句中（例如聲明語句、泛型和強制轉(zhuǎn)換語句中的類型）

@Retention

表明該注解的生命周期

生命周期類型	描述
RetentionPolicy.SOURCE	編譯時被丟棄，不包含在類文件中
RetentionPolicy.CLASS	JVM加載時被丟棄，包含在類文件中，默認(rèn)值
RetentionPolicy.RUNTIME	由JVM 加載，包含在類文件中，在運行時可以被獲取到

@Document

表明該注解標(biāo)記的元素可以被Javadoc 或類似的工具文檔化

@Inherited

表明使用了@Inherited注解的注解，所標(biāo)記的類的子類也會擁有這個注解

通過Cglib實現(xiàn)

在我們定義好注解之后就需要考慮如何將注解和類綁定到一起，在運行期間達(dá)到我們想要的效果，這里就可以引入動態(tài)代理的機制，將注解想要做的操作在方法執(zhí)行前，類編譯時就進(jìn)行一個織入的操作如下。

public static void main(String[] args) {
        Class easyServiceImplClass=EasyServiceImpl.class;
        //判斷該對象是否有我們自定義的@EasyExceptionResult注解
        if(easyServiceImplClass.isAnnotationPresent(EasyExceptionResult.class)){
            final EasyServiceImpl easyService=new EasyServiceImpl();
            //cglib的字節(jié)碼加強器
            Enhancer enhancer=new Enhancer();
            將目標(biāo)對象所在的類作為Enhaner類的父類
            enhancer.setSuperclass(EasyServiceImpl.class);
            通過實現(xiàn)MethodInterceptor實現(xiàn)方法回調(diào)，MethodInterceptor繼承了Callback
            enhancer.setCallback(new MethodInterceptor() {
                @Override
                public Object intercept(Object proxy, Method method, Object[] objects, MethodProxy methodProxy) throws Throwable {
                    try{
                        method.invoke(easyService, args);
                        System.out.println("事務(wù)結(jié)束...");
                    }catch (Exception e){
                        System.out.println("發(fā)生異常了");
                    }
                    return proxy;
                }
            });
 
            Object obj= enhancer.create();;
            EasyServiceImpl easyServiceProxy=(EasyServiceImpl)obj;
            easyServiceProxy.testEasyResult();
        }
 
    }

運行效果：

通過JDk動態(tài)代理實現(xiàn)

public class EasyServiceImplProxy implements InvocationHandler {
 
    private EasyServiceImpl target;
 
    public void setTarget(EasyServiceImpl target)
    {
        this.target = target;
    }
 
    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        // 這里可以做增強
        System.out.println("已經(jīng)是代理類啦");
        try{
            return  method.invoke(proxy, args);
        }catch (Exception e){
            System.out.println("發(fā)生異常了");
            return null;
        }
    }
 
 
    /**
     * 生成代理類
     * @return 代理類
     */
    public Object CreatProxyedObj()
    {
        return Proxy.newProxyInstance(target.getClass().getClassLoader(), target.getClass().getInterfaces(), this);
    }
}