Java 自定义注解

一、注解定义

Annotation(注解)是JDK1.5及以后版本引入的。它可以用于创建文档，跟踪代码中的依赖性，甚至执行基本编译时检查。注解是以‘@注解名’在代码中存在的，根据注解参数的个数，我们可以将注解分为：标记注解、单值注解、完整注解三类。它们都不会直接影响到程序的语义，只是作为注解（标识）存在，我们可以通过反射机制编程实现对这些元数据（用来描述数据的数据）的访问。另外，你可以在编译时选择代码里的注解是否只存在于源代码级，或者它也能在class文件、或者运行时中出现（SOURCE/CLASS/RUNTIME）。

二. 注解体系图

元注解：java.lang.annotation中提供了元注解，可以使用这些注解来定义自己的注解。主要使用的是Target和Retention注解 和 ElementType、RetentionPolicy 枚举类：

截屏2023-05-31 下午9.47.34.png

注解处理类：既然上面定义了注解，那得有办法拿到我们定义的注解啊。java.lang.reflect.AnnotationElement接口则提供了该功能。注解的处理是通过java反射来处理的。如下，反射相关的类Class, Method, Field都实现了AnnotatedElement接口。

截屏2023-05-31 下午9.52.22.png

因此，只要我们通过反射拿到Class, Method, Field类，就能够通过getAnnotation(Class)拿到我们想要的注解并取值。

三. 常用元注解

Target：描述了注解修饰的对象范围，取值在java.lang.annotation.ElementType定义，常用的包括：

• METHOD：用于描述方法
• PACKAGE：用于描述包
• PARAMETER：用于描述方法变量
• TYPE：用于描述类、接口或enum类型

Retention: 表示注解保留时间长短。取值在java.lang.annotation.RetentionPolicy中，取值为：

• SOURCE：在源文件中有效，编译过程中会被忽略
• CLASS：随源文件一起编译在class文件中，运行时忽略
• RUNTIME：在运行时有效

只有定义为RetentionPolicy.RUNTIME时，我们才能通过注解反射获取到注解。 所以，假设我们要自定义一个注解，它用在字段上，并且可以通过反射获取到，功能是用来描述字段的长度和作用。

四. 示例-反射获取注解

先定义一个注解：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyField {
    String description() default "这是一个字段注解";
    int length();
}

通过反射获取注解

public class ApplicationTest
{
    @MyField(description = "第一个注解",length = 13)
    private String username;

    @Test
    public void testMyField(){
        // 获取类模板
        Class c = ApplicationTest.class;
        // 获取所有字段
        for(Field f : c.getDeclaredFields()){
            // 判断这个字段是否有MyField注解
            if(f.isAnnotationPresent(MyField.class)){
                MyField annotation = f.getAnnotation(MyField.class);
                System.out.println("字段:[" + f.getName() + "], 描述:[" + annotation.description() + "], 长度:[" + annotation.length() +"]");
            }
        }
    }
}

运行结果

    Connected to the target VM, address: '127.0.0.1:57076', transport: 'socket'
    字段:[username], 描述:[第一个注解], 长度:[13]
    Disconnected from the target VM, address: '127.0.0.1:57076', transport: 'socket'

应用场景一：自定义注解+拦截器 实现登录校验

接下来，我们使用springboot拦截器实现这样一个功能，如果方法上加了@LoginRequired，则提示用户该接口需要登录才能访问，否则不需要登录。 首先定义一个LoginRequired注解

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

然后写两个简单的接口，访问sourceA，sourceB资源

@RestController
@RequestMapping("/method")
public class TestMethodController {

    //TODO ElementType.METHOD (4)
    @GetMapping("/A")
    public String loginA(){
        return  "登录A";
    }

    //TODO ElementType.METHOD (5)
    @LoginRequired
    @GetMapping("/B")
    public String loginB(){
        return  "登录B需要登录";
    }
}

实现spring的HandlerInterceptor 类先实现拦截器

public class TestMethodInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("进入拦截器了");
        // 拦截器中实现拦截逻辑
        HandlerMethod handlerMethod = (HandlerMethod)handler;
        LoginRequired loginRequired = handlerMethod.getMethod().getAnnotation(LoginRequired.class);
        if(loginRequired == null){
           return true;
        }
        // 有LoginRequired注解说明需要登录，提示用户登录
        response.setContentType("application/json; charset=utf-8");
        response.getWriter().print("请先登录 才可以访问此接口 ！");
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

实现spring类WebMvcConfigurer，创建配置类把拦截器添加到拦截器链中

@Configuration
public class InterceptorTrainConfigurer implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestMethodInterceptor()).addPathPatterns("/**");
    }
}

运行成功，访问sourceB时需要登录了

截屏2023-05-31 下午10.10.45.png

应用场景二：自定义注解+AOP 实现日志打印

先导入切面需要的依赖包

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

定义一个注解@MyLog

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

定义一个切面类，见如下代码注释理解：

@Aspect // 1.表明这是一个切面类
@Component
public class MyLogAspect {
    // 2. PointCut表示这是一个切点，@annotation表示这个切点切到一个注解上，后面带该注解的全类名
    // 切面最主要的就是切点，所有的故事都围绕切点发生
    // logPointCut()代表切点名称
    @Pointcut("@annotation(org.example.annotation.MyLog)")
    public void logPointCut(){};

    // 3. 环绕通知
    @Around("logPointCut()")
    public Object logAround(ProceedingJoinPoint joinPoint){
        // 获取方法名称
        String methodName = joinPoint.getSignature().getName();
        // 获取入参
        Object[] param = joinPoint.getArgs();

        StringBuilder sb = new StringBuilder();
        for(Object o : param){
            sb.append(o + "; ");
        }
        System.out.println("进入[" + methodName + "]方法,参数为:" + sb.toString());
        // 继续执行方法
        try {

            return joinPoint.proceed();

        } catch (Throwable throwable) {

            throwable.printStackTrace();

        }
        System.out.println(methodName + "方法执行结束");
        return null;
    }
}

给方法添加MyLog注解

@RestController
@RequestMapping("/mylog/aop")
public class TestMyLogController {
    @MyLog
    @GetMapping("/A")
    public String testMyLog(){
        return  "测试日志打印 aop 切面类";
    }
}

调用方法，返回结果

截屏2023-05-31 下午10.19.16.png

打印日志结果

截屏2023-05-31 下午10.18.31.png

参考链接：[https://juejin.cn/post/6844903949233815566)

---

文章持续更新中、希望对各位有所帮助、有问题可留言 大家共同学习.