java如何自定义注解

更新时间：2024年02月19日 14:28:31 作者：学、渣

这篇文章主要介绍了java如何自定义注解问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

声明一个注解要用到的东西

修饰符：访问修饰符必须为public,不写默认为pubic
关键字：关键字为@interface
注解名称：注解名称为自定义注解的名称，使用时还会用到
注解类型元素：注解类型元素是注解中内容

其次，JDK中还有一些元注解，这些元注解可以用来修饰注解。

主要有：@Target，@Retention，@Document，@Inherited。

@Target

作用：

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。

取值有：

@Retention

作用：

表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

即：注解的生命周期。

@Document

作用：

表明该注解标记的元素可以被Javadoc 或类似的工具文档化

@Inherited

作用：

表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解。

自定义注解中参数可支持的数据类型：

1.八大基本数据类型

2.String类型

3.Class类型

4.enum类型

5.Annotation类型

6.以上所有类型的数组

自定义一个注解，如下所示：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLog {
 
    String username() default "";
 
    OperationType type();
 
    String content() default "";
 
}

通过AOP加自定义注解简单实现一个操作日志的记录

自定义注解类：

package com.redistext.log;
 
import java.lang.annotation.*;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:23
 * @description: V1.0
 */
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface OperationLog {
 
    String username() default "admin";
 
    String type(); //记录操作类型
 
    String content() default ""; //记录操作内容
 
}

切面类：

package com.redistext.log;
 
import org.aspectj.lang.JoinPoint;
import org.aspectj.lang.Signature;
import org.aspectj.lang.annotation.AfterReturning;
import org.aspectj.lang.annotation.AfterThrowing;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.springframework.stereotype.Component;
 
import java.lang.reflect.Method;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:29
 * @description: V1.0
 */
@Aspect
@Component("logAspect")
public class LogAspect {
 
    // 配置织入点
    @Pointcut("@annotation(OperationLog)")
    public void logPointCut() {
    }
 
    /**
     * 前置通知 用于拦截操作，在方法返回后执行
     *
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "logPointCut()")
    public void doBefore(JoinPoint joinPoint) {
        handleLog(joinPoint, null);
    }
 
    /**
     * 拦截异常操作，有异常时执行
     *
     * @param joinPoint
     * @param e
     */
    @AfterThrowing(value = "logPointCut()", throwing = "e")
    public void doAfter(JoinPoint joinPoint, Exception e) {
        handleLog(joinPoint, e);
    }
 
    private void handleLog(JoinPoint joinPoint, Exception e){
        try {
            // 得到注解
            OperationLog operationLog = getAnnotationLog(joinPoint);
            System.out.println("---------------自定义注解：" + operationLog);
            if (operationLog == null) {
                return;
            }
            // 得到方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            String type = operationLog.type();
            String content = operationLog.content();
            String username = operationLog.username();
            // 打印日志
            System.out.println("操作类型：" + type);
            System.out.println("操作名称：" + content);
            System.out.println("操作人员：" + username);
            System.out.println("类名：" + className);
            System.out.println("方法名：" + methodName);
        } catch (Exception e1) {
            System.out.println("======前置通知异常======");
            e1.printStackTrace();
        }
    }
 
 
    private static OperationLog getAnnotationLog(JoinPoint joinPoint) throws Exception{
        Signature signature = joinPoint.getSignature();
        MethodSignature methodSignature = (MethodSignature) signature;
        Method method = methodSignature.getMethod();
        if (method != null) {
            // 拿到自定义注解中的信息
            return method.getAnnotation(OperationLog.class);
        }
        return null;
    }
 
}

测试类：

package com.redistext.log;
 
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author: maorui
 * @description: TODO
 * @date: 2021/10/27 21:40
 * @description: V1.0
 */
@RestController
@RequestMapping("/operationLog")
public class OperationLogController {
 
    @OperationLog(type = "add", content = "添加")
    @GetMapping(value = "/add")
    public String addOperation(){
        return "add";
    }
 
    @OperationLog(type = "update", username = "adminFather")
    @GetMapping(value = "/update")
    public String updateOperation(){
        return "update";
    }
 
    @OperationLog(type = "delete", content = "删除", username = "adminMother")
    @GetMapping(value = "/delete")
    public String deleteOperation(){
        return "delete";
    }
 
    @OperationLog(type = "find")
    @GetMapping(value = "/find")
    public String findOperation(){
        return "find";
    }
}

依次调用测试类各个接口，记录的操作日志信息如下：

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

java
注解

Spring中bean集合注入的方法详解
Spring作为项目中不可缺少的底层框架，提供的最基础的功能就是bean的管理了。bean的注入相信大家都比较熟悉了，但是有几种不太常用到的集合注入方式，可能有的同学会不太了解，今天我们就通过实例看看它的使用
2022-07-07
Java实现AOP功能的封装与配置的小框架实例代码
这篇文章主要介绍了Java实现AOP功能的封装与配置的小框架实例代码，分享了相关代码示例，小编觉得还是挺不错的，具有一定借鉴价值，需要的朋友可以参考下
2018-02-02
springboot自定义日志注解的实现
本文主要介绍了springboot自定义日志注解的实现，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-03-03
解决版本不兼容Jar包冲突问题
在和三方对接的过程中,我们可能会不断引入一些三方jar包,但这个时候就有可能出现一个项目需要依赖两个版本不同且功能不兼容的jar包,本文主要介绍了解决版本不兼容Jar包冲突问题,感兴趣的可以了解一下
2023-10-10
Java语法糖之个数可变的形参的实现
这篇文章主要介绍了Java语法糖之个数可变的形参的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-06-06
Java 类与对象详细
这篇文章主要介绍了Java 类与对象，在Java中，我们把对象的特征称为属性，对象的用途称为方法，具有相同属性和方法的对象，我们把他们归为一类，简称类。下面文章讲详细介绍什么是Java类与对象,需要的朋友可以参考一下
2021-10-10
SpringCloud的Hystrix简单介绍
这篇文章主要介绍了SpringCloud的Hystrix简单介绍,SpringCloud Hystrix是Netflix开源的一款容错框架，具备服务降级，服务熔断，依赖隔离，监控(Hystrix Dashboard)等功能,同样具有自我保护能力,需要的朋友可以参考下
2023-07-07
Springboot中@RequestParam和@PathVariable的用法与区别详解
这篇文章主要介绍了Springboot中@RequestParam和@PathVariable的用法与区别详解,RESTful API设计的最佳实践是使用路径参数来标识一个或多个特定资源,而使用查询参数来对这些资源进行排序/过滤,需要的朋友可以参考下
2024-01-01
解决maven maven.compiler.source和maven.compiler.target的坑
这篇文章主要介绍了解决maven maven.compiler.source和maven.compiler.target的坑，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-12-12
SpringBoot集成Kaptcha验证码的详细过程
Kaptcha是一个强大而灵活的Java验证码生成库,通过合理的配置和使用,它可以有效地提高web应用的安全性,防止自动化程序的滥用,这篇文章主要介绍了SpringBoot集成Kaptcha验证码,需要的朋友可以参考下
2024-07-07