JAVA自定义注解

什么是注解？

注解是一种特殊的接口，用于为Java代码提供元数据。它们不会直接影响代码的执行，但可以被编译器、开发工具或运行时环境读取和使用。
Java内置了一些常用的注解，如：
@Override - 表示方法重写父类方法
@Deprecated - 表示代码已过时
@SuppressWarnings - 抑制编译器警告
注解的基本语法

定义注解

使用@interface关键字来定义注解：
 

1. public @interface AutoFill {
2. }

复制代码

 
元注解

元注解是用来注解其他注解的注解，Java提供了以下几种元注解：
@Target - 指定注解可以应用的目标元素类型
@Retention - 指定注解的保留策略
@Documented - 表示注解应该被包含在Javadoc中
@Inherited - 表示注解可以被继承
 

1. @Target(ElementType.METHOD)
2. @Retention(RetentionPolicy.RUNTIME)
3. public @interface AutoFill {
4.     /**
5.      * 数据库操作类型：INSERT、UPDATE
6.      */
7.     OperationType value();
8. }

复制代码

 
示例代码展示了一个用于公共字段自动填充的自定义注解，@Target明确注解可在方法上使用，@Retention明确在程序运行时可见。
 
注解元素

 
注解中可以定义元素，这些元素可以有默认值：
 

1. public enum OperationType {
3.     /**
4.      * 更新操作
5.      */
6.     UPDATE,
8.     /**
9.      * 插入操作
10.      */
11.     INSERT
13. }

复制代码

 
示例自定义注解中的value方法则用来返回上示枚举类型数据，明确 使用该注解的方法 的作用，使用方式如下：
 

1. /**
2.       * 更新员工信息
3.       * @param employee
4.       */
5.      @AutoFill(OperationType.UPDATE)
6.      void updateById(Employee employee);

复制代码

 
当注解只有一个方法且方法名为 value 时，使用时可以省略方法名，如果方法不叫 value，就必须明确指定方法名：

1. @Target(ElementType.METHOD)
2. @Retention(RetentionPolicy.RUNTIME)
3. public @interface AutoFill {
4.     /**
5.      * 数据库操作类型：INSERT、UPDATE
6.      */
7.     OperationType type();
8. }<br><br>

复制代码

1. /**
2.       * 更新员工信息
3.       * @param employee
4.       */
5.      @AutoFill(type = OperationType.UPDATE)
6.      void updateById(Employee employee);

复制代码

自定义注解的使用

通过反射处理注解

我们可以使用反射机制在运行时读取和处理注解：
 

1. @Aspect
2. @Component
3. @Slf4j
4. public class AutoFillAspect {
6.     /**
7.      * 公共字段自动填充切入点
8.      */
9.     @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
10.     public void autoFillPointCut() {}
12.     /**
13.      * 公共字段自动填充
14.      */
15.     @Before("autoFillPointCut()")
16.     public void autoFill(JoinPoint joinPoint) throws Throwable {
17.         log.info("公共字段自动填充通知开始");
18.         MethodSignature signature = (MethodSignature)joinPoint.getSignature();
19.         AutoFill autoFill= signature.getMethod().getAnnotation(AutoFill.class);
20.         // 获取数据库操作类型
21.         Enum operationType = autoFill.value();
22.         // 从ThreadLocal中获取当前登录用户的id
23.         Long currentId = BaseContext.getCurrentId();
24.         // 获取当前时间
25.         LocalDateTime now = LocalDateTime.now();
26.         // 从joinPoint中获取参数
27.         Object[] args = joinPoint.getArgs();
28.         if(args==null || args.length==0){
29.             return;
30.         }
31.         // 从参数中获取实体对象
32.         Object entity = args[0];
33.         // 调用实体对象的方法，设置创建时间、创建人、更新时间、更新人
34.         if(operationType==OperationType.INSERT){
35.             try{
36.                 Method setCreateTime = entity.getClass().getDeclaredMethod("setCreateTime", LocalDateTime.class);
37.                 Method setUpdateTime = entity.getClass().getDeclaredMethod("setUpdateTime", LocalDateTime.class);
38.                 Method setCreateUser = entity.getClass().getDeclaredMethod("setCreateUser", Long.class);
39.                 Method setUpdateUser = entity.getClass().getDeclaredMethod("setUpdateUser", Long.class);
40.                 setCreateTime.invoke(entity, now);
41.                 setUpdateTime.invoke(entity, now);
42.                 setCreateUser.invoke(entity, currentId);
43.                 setUpdateUser.invoke(entity, currentId);
44.             }catch (Exception e){
45.                 log.error("公共字段自动填充通知异常", e);
46.             }
47.         }else if(operationType==OperationType.UPDATE){
48.             try{
49.                 Method setUpdateTime = entity.getClass().getDeclaredMethod("setUpdateTime", LocalDateTime.class);
50.                 Method setUpdateUser = entity.getClass().getDeclaredMethod("setUpdateUser", Long.class);
51.                 setUpdateTime.invoke(entity, now);
52.                 setUpdateUser.invoke(entity, currentId);
53.             }catch (Exception e){
54.                 log.error("公共字段自动填充通知异常", e);
55.             }
56.         }
58.     }
59. }

复制代码

 
上述示例展示的是@AutoFill注解进行公共字段自动填充必要的切面类。

1. @Aspect

复制代码

该注解用于声明切面类。

1. /**
2.      * 公共字段自动填充切入点
3.      */
4.     @Pointcut("execution(* com.sky.mapper.*.*(..)) && @annotation(com.sky.annotation.AutoFill)")
5.     public void autoFillPointCut() {}

复制代码

这一部分用于声明哪些部分需要拦截。（在com.sky.mapper包下的所有类及其所有方法 且 被自定义注解（@AutoFill）所标注）

1.     /**
2.      * 公共字段自动填充
3.      */
4.     @Before("autoFillPointCut()")
5.     public void autoFill(JoinPoint joinPoint) throws Throwable

复制代码

@Before: 表示这是一个前置通知，在目标方法执行之前运行。
autoFillPointCut(): 引用一个切点表达式，定义了哪些方法需要被拦截。
 
JoinPoint: AOP 连接点对象，可以获取被拦截方法的详细信息：方法名、参数、目标对象等。通过 joinPoint.getArgs() 获取方法参数。
 

1. MethodSignature signature = (MethodSignature)joinPoint.getSignature();
2. AutoFill autoFill= signature.getMethod().getAnnotation(AutoFill.class);
3. // 获取数据库操作类型
4. Enum operationType = autoFill.value();

复制代码

 
joinPoint.getSignature(): 获取连接点的签名信息。
(MethodSignature): 强制转换为 MethodSignature 类型，因为 Spring AOP 只拦截方法。
signature.getMethod(): 获取被拦截的 Method 对象。
.getAnnotation(AutoFill.class): 从方法上获取 @AutoFill 注解。
autoFill.value(): 调用注解的 value() 方法，获取注解中定义的枚举值。
 

1. // 从joinPoint中获取参数
2.         Object[] args = joinPoint.getArgs();
3.         if(args==null || args.length==0){
4.             return;
5.         }
6.         // 从参数中获取实体对象
7.         Object entity = args[0];

复制代码

 
利用从joinPoint中获取的参数获得原本方法中传递的实体对象。

1. Method setCreateTime = entity.getClass().getDeclaredMethod("setCreateTime", LocalDateTime.class);
2. Method setCreateUser = entity.getClass().getDeclaredMethod("setCreateUser", Long.class);
3. setCreateTime.invoke(entity, now);
4. setCreateUser.invoke(entity, currentId);

复制代码

利用反射为对象设置公共字段。
最终效果
 

@AutoFill注解能有效替代原本冗长且重复的公共字段设置代码。
 

来源：程序园用户自行投稿发布，如果侵权，请联系站长删除
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！