如何实现自定义注解

如何实现自定义注解

  在我们实际开发过程中如果能合理的运用自定义注解，则会大大减少我们代码的开发量。那怎么才能实现自定义注解呢？废话不多说，直接上干货！

一、创建注解

  这一步呢，我们可以理解成对应的实体类，我们要自定义注解，也需要这么一个东西，注解的名称，有哪些属性等等。

package org.disp.kingmouse.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD, ElementType.TYPE, ElementType.PARAMETER, ElementType.METHOD})
public @interface KingMouse {
    String value() default "";
}

• @Retention: 表示该注解的生命周期，是RetentionPolicy类型的，该类型是一个枚举类型，可提供三个值选择，分别是：CLASS、RUNTIME、SOURCE

  • RetentionPolicy.CLASS: 注解被保留到class文件，但jvm加载class文件时候被遗弃，这是默认的生命周期；
  • RetentionPolicy.RUNTIME: 注解不仅被保存到class文件中，jvm加载class文件之后，仍然存在；
  • RetentionPolicy.SOURCE: 注解只保留在源文件，当Java文件编译成class文件的时候，注解被遗弃；

由此可见生命周期关系：SOURCE < CLASS < RUNTIME，我们一般用RUNTIME

• @Target: 表示该注解的作用范围，是ElementType类型的，该类型是一个枚举类型，一共提供了10个值选择，我们最常用的几个：FIELD、TYPE、PARAMETER、METHOD

  • ElementType.FIELD:用于接口、类、枚举、注解
  • ElementType.TYPE:用于字段、枚举的常量
  • ElementType.PARAMETER:用于方法参数
  • ElementType.METHOD:用于方法

在KingMouse这个类里面可以根据实际需求写上所需要的属性，到这里，我们的第一步就完成！

二、定义注解行为

  这一步就是我们需要如何去处理我们的注解，这里面有四个方法，分别是@Before、@after、@Around、AfterReturning、AfterThrowing,我们常用的一般是前三个，看具体需求选择适合自己的就行

• @Before: 前置通知, 在方法执行之前执行，这个通知不能阻止连接点前的执行（除非它抛出一个异常）。
• @After: 后置通知, 在方法执行之后执行（不论是正常返回还是异常退出）。
• @Around: 包围一个连接点（join point）的通知，如方法调用。这是最强大的一种通知类型。 环绕通知可以在方法调用前后完成自定义的行为。它也会选择是否继续执行连接点或直接返回它们自己的返回值或抛出异常来结束执行。
• @AfterRunning:返回通知, 在方法正常返回结果之后执行 。
• @AfterThrowing: 异常通知, 在方法抛出异常之后。

我们这里演示@Before、@after，老规矩，直接上代码！

package org.disp.kingmouse.annotations;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.After;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class KingmouseAspect {

    private final static Logger LOGGER = LoggerFactory.getLogger(KingmouseAspect.class);

    @Before("@annotation(kingMouse)")
    public void doBefore(KingMouse kingMouse) {
        String value = kingMouse.value();
        LOGGER.info("@KingMouse before msg: [{}]", value);
        //do something
    }


    @After(value = "@annotation(kingMouse)")
    public void testAround(KingMouse kingMouse) {
        String value = kingMouse.value();
        LOGGER.info("@KingMouse around msg: [{}]", value);
        //do something
    }
}

  这个类里面我们就可以做我们想做的事情，我这里就直接打印KingMouse中的值代替了，上面这两步做完，我们的自定义注解就完成了，剩下的就是我们如何去使用了

三、验证测试

我们直接将KingMouse这个注解写到方法上，上代码！

package org.disp.kingmouse.controller;


import lombok.extern.java.Log;
import org.disp.kingmouse.annotations.KingMouse;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Created with IntelliJ IDEA
 *
 * @auther KingMouse
 * @date 2020/6/02 11:26
 * Description:
 */
@Log
@Controller
@RequestMapping("/e")
public class TestController {
    @RequestMapping("/test")
    @KingMouse(value = "自定义注解-controller")
    public void test(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse){
        log.info("KingMouse - test");
        test2();
    }

    @KingMouse(value = "自定义注解-method")
    public void test2(){
        log.info("KingMouse - test2");
    }
}

运行日志：

INFO  o.d.k.annotations.KingmouseAspect[21] [TxId :  , SpanId : ]- @KingMouse before msg: [自定义注解-controller]
INFO  o.d.k.controller.TestController[26] [TxId :  , SpanId : ]- KingMouse - test
INFO  o.d.k.controller.TestController[32] [TxId :  , SpanId : ]- KingMouse - test2
INFO  o.d.k.annotations.KingmouseAspect[29] [TxId :  , SpanId : ]- @KingMouse around msg: [自定义注解-controller]

  这里面我们可以清楚的看到@KingMouse before msg: [自定义注解-controller]和@KingMouse around msg: [自定义注解-controller]分别对应@Before、@After两个方法，看到这里，有不少小伙伴应该会发现，为什么自定义注解-method这个内容没有打印，但是看日志，test2方法命名是执行了的，这是为什么？其实，注解的本质还是aop，所有当我们发起调用的时候，是可以拦截的，但是我们通过类直接调用方法是不行的，如果需要调用方法也可以被拦截，有两种方法：

• 添加切面，上代码！

package org.disp.kingmouse.annotations;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class KingmouseAspect {

   private final static Logger LOGGER = LoggerFactory.getLogger(KingmouseAspect.class);

   @Pointcut("@annotation(org.disp.kingmouse.annotations.KingMouse)")
   public void kingmouse() {
   }

   @Before("kingmouse() && @annotation(kingMouse)")
   public void doBefore(KingMouse kingMouse) {
       String value = kingMouse.value();
       LOGGER.info("@KingMouse before msg: [{}]", value);
       //do something
   }


   @After(value = "kingmouse() && @annotation(kingMouse)")
   public void testAround(KingMouse kingMouse) {
       String value = kingMouse.value();
       LOGGER.info("@KingMouse around msg: [{}]", value);
       //do something
   }
}

• 改变方法引用，上代码！

package org.disp.kingmouse.controller;
import lombok.extern.java.Log;
import org.disp.kingmouse.annotations.KingMouse;
import org.springframework.aop.framework.AopContext;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * Created with IntelliJ IDEA
 *
 * @auther KingMouse
 * @date 2020/6/02 11:26
 * Description:
 */
@Log
@Controller
@RequestMapping("/e")
public class TestController {
    @RequestMapping("/test")
    @KingMouse(value = "自定义注解-controller")
    public void test(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse) {
        log.info("KingMouse - test");
        ((TestController) AopContext.currentProxy()).test2();
    }

    @KingMouse(value = "自定义注解-method")
    public void test2() {
        log.info("KingMouse - test2");
    }
}

这步改完，我们重启服务，测试，结果！！！！报错了！！
报错信息：

ERROR o.a.c.c.C.[.[.[.[dispatcherServlet][175] [TxId :  , SpanId : ]- Servlet.service() for servlet [dispatcherServlet] in context with path [] threw exception [Request processing failed; nested exception is java.lang.IllegalStateException: Cannot find current proxy: Set 'exposeProxy' property on Advised to 'true' to make it available.] with root cause
java.lang.IllegalStateException: Cannot find current proxy: Set 'exposeProxy' property on Advised to 'true' to make it available.
	at org.springframework.aop.framework.AopContext.currentProxy(AopContext.java:69)
	at org.disp.kingmouse.controller.TestController.test(TestController.java:28)

通过代码我们不难看出，被禁用了，其实springboot默认是关闭的，不允许我们这么用，打开就好了，我们只需要在我们的启动类上增加@EnableAspectJAutoProxy(exposeProxy=true,proxyTargetClass=true),上代码！

package org.disp.kingmouse;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.EnableAspectJAutoProxy;

@SpringBootApplication
@EnableAspectJAutoProxy(exposeProxy = true, proxyTargetClass = true)
public class KingmouseApplication {

    public static void main(String[] args) {
        SpringApplication.run(KingmouseApplication.class, args);
    }

}

改完重启服务测试，运行结果：

INFO  o.d.k.annotations.KingmouseAspect[22] [TxId :  , SpanId : ]- @KingMouse before msg: [自定义注解-controller]
INFO  o.d.k.controller.TestController[27] [TxId :  , SpanId : ]- KingMouse - test
INFO  o.d.k.annotations.KingmouseAspect[22] [TxId :  , SpanId : ]- @KingMouse before msg: [自定义注解-method]
INFO  o.d.k.controller.TestController[33] [TxId :  , SpanId : ]- KingMouse - test2
INFO  o.d.k.annotations.KingmouseAspect[30] [TxId :  , SpanId : ]- @KingMouse around msg: [自定义注解-method]
INFO  o.d.k.annotations.KingmouseAspect[30] [TxId :  , SpanId : ]- @KingMouse around msg: [自定义注解-controller]

好了，今天的分享就到这里了！