JAVA @interface自定义注解（自定义注解+环绕通知 记录操作日志）

已于 2024-07-17 17:56:10 修改
阅读量720 收藏 23
点赞数 11
文章标签： java
于 2024-07-17 17:54:31 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/longtimetoc/article/details/140501434
版权

简介

注解@interface是一种在Java代码中添加元数据（metadata）的方式，它可以用于提供程序的额外信息，但本身并不会直接影响程序的执行。注解可以应用于类、方法、字段和其他程序元素，用于提供关于这些元素的额外信息。
使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口。
在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

自定义注解的应用场景

自定义注解注释在方法上，给方法提供元数据，一般与过滤器，拦截器，SpringAOP配置使用，这些系统自动调用的功能，可以获取自定义元数据的信息做相应的处理。也可以程序在调用的方法中，使用注解的元信息，例如阿里提供的easyExcel，在需要输出excel的数据的类上添加注解提供列名，数据格式等信息，在客户化方法调用生成excel获取这些元数据形成表格。

  • 1.记录操作日志
  • 2.权限校验
  • 3.参数校验
  • 4.easy excel
  • 5.事务管理
  • 6.数据源切换

元注解（可以注解在自定义注解上的注解）

  • @Target：用于指定注解可以应用于的目标元素类型，限定注解可以放在那些对象上

    • ElementType.TYPE: 类、接口或枚举类型
    • ElementType.FIELD: 字段（包括枚举常量）
    • ElementType.METHOD: 方法
    • ElementType.PARAMETER: 方法或构造函数的参数
    • ElementType.CONSTRUCTOR: 构造函数
    • ElementType.LOCAL_VARIABLE: 局部变量
    • ElementType.ANNOTATION_TYPE: 注解类型
    • ElementType.PACKAGE: 包
    • ElementType.TYPE_PARAMETER: 类型参数（Java 8+）
    • ElementType.TYPE_USE: 类型使用（Java 8+）

  • @Retention：用于指定注解的保留策略（retention policy）。保留策略定义了注解在何时有效以及在何时丢弃。

    • RetentionPolicy.SOURCE: 这是最短的保留策略。注解仅保留在源代码中，不会被编译进 class 文件，也不会对运行时产生任何影响。一般用于生成文档等需要在源代码中保留信息的情况。
    • RetentionPolicy.CLASS: 注解会被编译进 class 文件中，但在运行时不会被 JVM 保留。这是默认的保留策略，如果不指定 @Retention，则会使用这种策略。
    • RetentionPolicy.RUNTIME: 注解会被编译进 class 文件中，并在运行时被 JVM 保留，可以通过反射机制获取注解信息。这种保留策略通常用于实现自定义的注解处理器，或者需要在运行时获取注解信息的情况。

  • @Inherited：表示：父类有这个注解，子类继承父类，会一并继承这个注解。

  • @Documented：API 文档中，而不影响注解应用的元素是否包含在文档中。

案例：自定义注解+环绕通知 记录操作日志

要求：知道操作类型（type）：增删改查，操作说明（action）：具体做什么，方法入参，出参数，方法名，执行结果。

定义表：

CREATE TABLE learn.user_operation_log (
    id bigint  ,
    type VARCHAR(30) NOT NULL,
    action VARCHAR(240) NOT NULL,
    method_name VARCHAR(80) NOT NULL,
    method_params TEXT,
    result_code VARCHAR(240),
    result_msg VARCHAR(240) ,
    create_by long NOT NULL,
    update_by long NOT NULL,
    create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
    update_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;

定义DAO


@Data
@TableName("user_operation_log")
public class OperationLogDO extends BaseDO {

    private String type;

    private String action;

    private String methodName;

    private String methodParams;

    private String resultCode;

    private String resultMsg;
}

这里面的ID字段使用mybatis自动填充，也可以手工赋值

@Data
public class BaseDO implements Serializable {

    /**
     *
     */
    // 雪花算法：一位未定 + 41位时间数字 + 10位机器数（5位机器时区+5位机器编码）+ 12位随机数
    @TableId(type = IdType.ASSIGN_ID)
    private Long id;

    /**
     *
     */
    @TableField(fill = FieldFill.INSERT)
    private Long createBy;

    /**
     *
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Long updateBy;

    /**
     *
     */
    @TableField(fill = FieldFill.INSERT)
    private LocalDateTime createTime;

    /**
     *
     */
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private LocalDateTime updateTime;
}

Mapper和持久化Service省略

定义自定义注解

@Documented
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface AuditLog {
    // 1.操作描述
    String action() default "";

    // 2.操作类型（增删改查）
    OperateEnum type() default OperateEnum.MODIFY;

    // 3.是否记录参数
    boolean isRecord() default true;
}

定义切面：环绕通知

@Slf4j
@Aspect
@Component
@RequiredArgsConstructor
public class AuditAspect {
    private final ObjectMapper objectMapper;

    private final OperationLogService operationLogService; 

    @Around("@annotation(auditLog)")
    public Object around(ProceedingJoinPoint joinPoint, AuditLog auditLog) throws Throwable {
        log.info("开始记录日志");
        // 执行连接点前，记录信息
        OperationLogDO userLogRecordDO = buildRequestParams(joinPoint, auditLog);

        try {
            Object result = joinPoint.proceed();
            if (result != null) {
                String resultJson = objectMapper.writeValueAsString(result);
                userLogRecordDO.setResultCode("S");
                userLogRecordDO.setResultMsg(resultJson);
            }
            return result;
        } catch (Exception e) {
            userLogRecordDO.setResultCode("E");
            userLogRecordDO.setResultMsg("后端未知异常，错误消息：" + e.getMessage());
            throw e;
        } finally {
            //操作日志入库
            try {
                if (userLogRecordDO.getId() != null) {
                    operationLogService.updateById(userLogRecordDO);
                }
            } catch (Exception e) {
                log.error("更新用户操作异常", e);
            }
            log.info("结束记录日志");
        }
    }

    private OperationLogDO buildRequestParams(ProceedingJoinPoint joinPoint, AuditLog auditLog) {

        MethodSignature methodSignature = (MethodSignature) joinPoint.getSignature();
        Method method = methodSignature.getMethod();
        // AuditLog auditLog = method.getAnnotation(AuditLog.class);

        OperationLogDO operationLogDO = new OperationLogDO();
        operationLogDO.setAction(auditLog.action());
        operationLogDO.setType(auditLog.type().name());
        // 类名+方法名
        operationLogDO.setMethodName(method.getDeclaringClass().getSimpleName() + "." + method.getName());

        // 处理入参数
        try {
            Parameter[] parameters = methodSignature.getMethod().getParameters();
            HashMap<String, Object> paramMap = new HashMap<>();
            Object[] args = joinPoint.getArgs();
            for (int i = 0; i < parameters.length; i++) {
//            Class<?> type = parameters[i].getType();
//            if (ServletResponse.class.isAssignableFrom(type) || ServletRequest.class.isAssignableFrom(type)) {
//                continue;
//            }
                String name = parameters[i].getName();
                paramMap.put(name, args[i]);
                operationLogDO.setMethodParams(objectMapper.writeValueAsString(paramMap));
            }
        } catch (JsonProcessingException e) {
            log.warn("构建入参异常：{}", e.getMessage());
        }
        //操作日志入库
        try {
            operationLogService.save(operationLogDO);
        } catch (Exception e) {
            log.error("记录用户操作异常:", e);
        }

        return operationLogDO;
    }
}

操作类型常量

public enum OperateEnum {
    ADD,
    DELETE,
    MODIFY,
    SAVE_OR_MODIFY,
    SELECT;
}

方法上添加自定义注解

@Slf4j
@Service
@RequiredArgsConstructor
public class StudentServiceImpl implements StudentService {

    private final StudentRepository studentRepository;


    @Override
    // @MetricTime("createStudent") // 切面与注释配套使用
    @AuditLog(action = "创建学生", type = OperateEnum.ADD, isRecord = true)
    public StudentResult createStudent(StudentCreateCmd cmd) {
        log.info("create student cmd:{}", cmd);
        StudentDO studentDO = StudentCreateCmd.convertToDO(cmd);
        studentRepository.save(studentDO);
        log.info("create student end");
        return StudentResult.convertFromDO(studentDO);
    }
}

运行测试结果
在这里插入图片描述

参考网址：

https://blog.csdn.net/m0_52767002/article/details/133793285

OO好久不见OO
关注
自定义注解——处理环绕通知——MybatisPlus配置类——Redis配置类——redisson配置信息——Swagger2配置信息——Redis常量配置类——全局异常处理类
Princess_Y
05-31 361
自定义注解 package com.edu.shengda.common.cache; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; /** * @author mqx */ @Target({ElementType.METHO
Java自定义注解实现日志记录
yehongzhi1994的博客
03-07 3117
教你怎么使用自定义注解记录日志
Java中自定义注解的使用
最新发布
echola_mendes的博客
08-22 1410
以【记录操作日志】为例，一般在开发中为了记录用户操作，当系统出现问题时，可以追溯日志所提供详细的错误信息，帮助开发者快速定位问题的原因最简单的方法：在每个方法中增加日志信息打印代码，来记录操作日志，但是这样重复代码也很多，也不易扩展，而且易出错使用自定义注解就会方便很多，减少不必要的重复代码，减少非业务代码的侵入性，如果需要扩展操作用户的信息以及IP就会很方便，易于扩展和维护@interface在需要使用自定义注解的地方使用该注解@LogOperation("新增")// 方法实现。
Java - @interface 自定义注解
业精于勤荒于嬉
06-08 383
Java 注解
自定义注解@interface
知行
04-05 2054
使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。
java @interface 自定义注解
u013161431的博客
09-10 332
1. 注解的好处 注解可以替代配置文件完成对某些功能的描述，减少程序配置； 在没有配置文件的情况下，我们去观察代码，并不需要同时打开两个文件来观察这个字段到底对应数据库的哪个列，减少了程序繁琐性，使得代码更加清晰易懂； 目前市面上流行的框架基本上都包含了注解配置，那么针对于开源项目，我们在阅读项目代码时，不懂注解如何实现，真的是举步难坚，所以，学习注解也可以加强我们对开源项目源码的解读。 ...
@interface 自定义注解
zyb2017的博客
12-17 791
一 前言最近一直在搭建各种环境，编码写的少了，工作用到自定义注解，记录学习一下二 Java元注解在开始自定义注解之前我们需要了解元注解，那什么是元注解呢？ 5个字：注解的注解。来帮我们描述定义注解，包括：//Annotation被保留的时间长短，注解的保留位置 @Retention //Annotation所修饰的对象范围 @Target //说明该注解将被包含在javadoc中 @D
JSP 自定义注解及记录操作日志
10-19
在JSP中实现自定义注解和记录操作日志是一种提高程序开发效率、增强系统安全性与可维护性的常用方法。通过这种方式可以简化代码管理，使得业务逻辑与日志记录的代码分离，从而便于跟踪与审计。以下内容将详细介绍...
java+通过注解打印日志_java自定义注解及日志输出
weixin_42620202的博客
03-07 1584
本质是继承Annotation接口，是一种特殊的注释，解析一个类或方法的注解有两种方式，一种是编译器直接扫描，另一种是运行期反射:编译器扫描：如@Override，这种情况只适用于那些编译器已经熟知的注解类，JDK内置的几个注解public interface Override extends Annotation {}四个元注解修饰注解的注解，有下面四个@Target：注解的作用目标@Reten...
java 自定义注解
06-01
Java自定义注解是Java平台提供的一种元数据机制，它允许程序员在代码中添加额外的信息，这些信息可以被编译器、JVM或其他工具在编译时或运行时读取，用于实现各种功能，如代码生成、代码分析、依赖注入等。自定义...
使用自定义注解和@Aspect实现操作日志记录
无忧少年的博客
02-05 1226
使用自定义注解实现操作日志记录 @author lisiwen @createTime 2020/2/5 ​ 在项目中需要对于指定操作进行日志的记录，在我们有的项目中是对于异常时对日志数据进行记录，有的项目是对所有数据进行日志记录。可以使用方法来实现日志记录，也可以使用注解的方式实现，总的来说使用注解的方式，更加的简单，便捷。 ​ 使用注解的方式主要是使用@Aspect这个注解，对使用自定...
@Interface自定义注解
wml_sing的博客
07-20 339
最近一段时间在整理基础的东西, 看到@interface 这个就去具体的查看了下注解的使用, 以下是本人自己整理的代码, 话不多说, 上代码: 自定义注解类 package com.huntkey.rx.sceo.utils; import java.lang.annotation.*; /** * @description: 自定义注解实现特定功能 * 描述: * @interface: 表示继承了java.lang.annotation.A
@interface自定义注解
weixin_30590285的博客
09-07 163
1.@interface : 自定义注解。 自定义注解中的每一个方法定义了这个注解类型的一个元素，特别注意：注解中方法的声明中一定不能包含参数，也不能抛出异常； 方法的返回值被限制为简单类型、String、Class、emnus、注释以及这些类型的数组，并且方法可以有一个缺省值。 2.元注解：用来修饰注解的注解。 比如： @Target({ElementType.METHOD, El...
关于@interface 自定义注解
opzoonzhuzhengke的专栏
03-05 741
自定义注解的话主要就3件事 1.定义注解    Java code? 1 2 3 4   @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.METHOD)    public @interface Test { }      2.加注解到方法上
Java注解Annotation详解：自定义注解、元注解、应用场景
Java注解Annotation与自定义注解详解 Java注解Annotation是Java语言中的一种 metadata 机制，用于在源代码中添加信息，方便编译器、IDE、其他工具或者应用程序来了解代码的意图和结构。Java注解可以分为三类：标记...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值