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
注解

SpringBoot整合Jackson的过程详解
这篇文章给大家介绍了SpringBoot整合Jackson的整合过程,文中通过代码示例给给大家介绍的非常详细,并附带附工具类与使用案例,对大家的学习或工作有一定的帮助,需要的朋友可以参考下
2023-12-12
SpringBoot实现邮件发送功能的姿势分享
我们在日常开发中,经常会碰到email邮件发送的场景,如发送验证码,向客户发送邮件等等,这篇文章主要给大家介绍了关于SpringBoot实现邮件发送的相关资料,需要的朋友可以参考下
2021-08-08
Sentinel中实现限流的两种方法
本文给大家介绍了Sentinel中实现限流的两种方法,限流是一种通过控制系统对外提供的资源、服务或接口的访问数量或速率,以保护系统免受过载的一种策略,需要的朋友可以参考下
2024-02-02
easyexcel读取excel合并单元格数据的操作代码
这篇文章主要介绍了easyexcel读取excel合并单元格数据的操作代码,本文通过实例代码给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2023-05-05
Java对象的四种引用方式实例分析
这篇文章主要介绍了Java对象的四种引用方式,简单描述了四种引用方式的概念、应用场景并结合实例形式分析了弱引用所引用对象的垃圾回收过程,需要的朋友可以参考下
2019-08-08
浅谈SpringCloud的微服务架构组件
这篇文章主要介绍了浅谈SpringCloud的微服务架构组件,Spring Cloud根据分布式服务协调治理的需求成立了许多子项目，每个项目通过特定的组件去实现,需要的朋友可以参考下
2023-04-04
关于json解析多层嵌套并转为对应类(List)
在进行JSON解析时,遇到多层嵌套结构可通过递归或专用库来实现,重要的是将嵌套的JSON对象准确转化为对应的Java类,通常需要依赖如Gson或Jackson等库,将JSONObject转为JavaBean时,关注字段匹配与数据类型转换
2024-10-10
String.replaceAll方法详析(正则妙用)
这篇文章主要给大家介绍了关于String.replaceAll方法，正则妙用的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面来一起学习学习吧
2019-07-07
基于Java代码配置MyBatis Generator
这篇文章主要介绍了基于Java代码配置MyBatis Generator,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-06-06
通过FeignClient调用微服务提供的分页对象IPage报错的解决
这篇文章主要介绍了通过FeignClient调用微服务提供的分页对象IPage报错的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-03-03