自定义注解

声明

本文主要是对自定义注解的理解，如果有什么需要改进的地方还请大佬指出

作者简介：大家好，我是青衿
博客首页：CSDN主页石马农青衿
每日一句：努力一点，优秀一点

一、定义注解

  自定义注解类似于定义接口，但是需要指明注解的作用范围、生命周期等属性，使用关键字@interface定义一个类，如：

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

    String moduleName() default "";
    String operaName() default "";
    String operaType() default "";

}

二.元注解

想要自定义一个注解，就必须了解5大元注解

@Retention 
@Target
@Documented
@Inherited（JDK8 引入）  
@Repeatable（JDK8 引入）

@Retention 指定注解的生命周期

@Retention(RetentionPolicy.SOURCE)

其中Retention是一个枚举类

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

@Target指定注解可以修饰的元素类型

@Target(ElementType.Field)

*   ElementType.ANNOTATION_TYPE - 标记的注解可以应用于注解类型。
*   ElementType.CONSTRUCTOR - 标记的注解可以应用于构造函数。
*   ElementType.FIELD - 标记的注解可以应用于字段或属性。
*   ElementType.LOCAL_VARIABLE - 标记的注解可以应用于局部变量。
*   ElementType.METHOD - 标记的注解可以应用于方法。
*   ElementType.PACKAGE - 标记的注解可以应用于包声明。
*   ElementType.PARAMETER - 标记的注解可以应用于方法的参数。
*   ElementType.TYPE - 标记的注解可以应用于类的任何元素。

@Documented

指定注解会被JavaDoc工具提取成文档。默认情况下，JavaDoc是不包括文档的

@Inherited

表示该注解会被子类继承，注意，仅针对类，成员属性、方法并不受此注释的影响。

@Repeatable

表示注解可以重复使用，为了解决同一个注解不能重复在同一类/方法/属性上使用的问题。

三.自定义注解

自定义注解使用方法

既然指定了自定义注解，那我们怎么使用自定义注解呢？

• 运行时处理注解：使用反射
• 编译时期处理注解：使用注解处理器AbstractProcessor处理注解

Aop操作记录日志demo

首先，我们需要在Spring Boot项目中引入AOP依赖，这可以在pom.xml文件中添加如下内容：

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

然后，我们可以创建一个注解类来标记需要记录日志的方法，如下所示：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogAnnotation {
    String value() default "";
}

接下来，我们创建一个切面类来实现日志记录的逻辑：

@Aspect
@Component
public class LogAspect {
    @Autowired
    private HttpServletRequest request;

    @Pointcut("@annotation(com.example.demo.annotation.LogAnnotation)")
    public void logPointCut() {
    }

    @Around("logPointCut()")
    public Object around(ProceedingJoinPoint point) throws Throwable {
        long beginTime = System.currentTimeMillis();
        // 执行方法
        Object result = point.proceed();
        // 执行时长(毫秒)
        long time = System.currentTimeMillis() - beginTime;
        // 保存日志
        saveLog(point, time);
        return result;
    }

    private void saveLog(ProceedingJoinPoint point, long time) {
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        LogAnnotation logAnnotation = method.getAnnotation(LogAnnotation.class);

        // 请求的方法名
        String className = point.getTarget().getClass().getName();
        String methodName = signature.getName();
        System.out.println(String.format("Class Method: %s.%s()", className, methodName));

        // 请求的参数
        Object[] args = point.getArgs();
        try {
            String params = new ObjectMapper().writeValueAsString(args);
            System.out.println("Params: " + params);
        } catch (Exception e) {
            e.printStackTrace();
        }

        // 获取request
        String ip = request.getRemoteAddr();
        System.out.println("IP: " + ip);

        // 执行时长
        System.out.println("Execution Time: " + time + "ms");

        // 系统当前时间
        String dateStr = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(new Date());
        System.out.println("Current Time: " + dateStr);

        // 保存日志
        // 这里可以将日志信息保存到数据库或者输出到日志文件
    }
}

在这个切面类中，我们定义了一个切点logPointCut()，该切点指向所有使用了@LogAnnotation注解的方法。然后，我们定义了一个环绕通知around()，它会在目标方法执行前后执行，我们在这里记录了请求的方法名、参数、IP、执行时长和当前时间等信息。

最后，我们可以在需要记录日志的方法上使用@LogAnnotation注解，如下所示：

@RestController
public class HelloController {

    @LogAnnotation
    @GetMapping("/hello")
    public String hello(String name) {
        return "Hello, " + name;
    }
}

这样，当我们访问/hello接口时，就会自动记录并输出日志信息。

文章到此就结束了，感谢各位小伙伴儿们的支持，点个关注把