Java案例怎么自定义注解？

wen java案例 2026-06-10 8

Java自定义注解从入门到实战（附完整案例）

📖 目录导读

什么是Java注解？核心概念解析
自定义注解的语法与规则
实战案例一：日志记录注解
实战案例二：参数校验注解
注解的处理器实现（反射+动态代理）
常见问题与避坑指南（Q&A）
自定义注解的最佳实践

什么是Java注解？核心概念解析

在Java世界中,注解（Annotation）是一种元数据形式，它为代码提供额外信息而不直接改变程序行为，自Java 5引入以来，注解已成为Spring、MyBatis等框架的核心基石。

Java案例怎么自定义注解？

关键要点：

注解以@interface声明，本质是特殊接口
注解本身不执行逻辑,依赖处理器实现功能
常见内置注解：@Override、@Deprecated、@SuppressWarnings

自定义注解的语法与规则

要创建自己的注解,需要掌握以下元注解：

元注解	作用
`@Target`	指定注解适用位置（方法、字段、类等）
`@Retention`	注解生命周期（源码、编译、运行时）
`@Inherited`	是否允许子类继承
`@Documented`	是否包含在JavaDoc中

示例：一个简单的自定义注解

import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecutionTime {
    String value() default "default"; // 可配置参数
}

规则：

注解方法不能有参数和异常声明
返回值类型必须是基本类型、String、Class、枚举、注解或它们的数组
可使用default设置默认值

实战案例一：日志记录注解

很多开发者需要统计方法执行时间,通过自定义注解可以优雅实现。

步骤1：定义注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecution {
    String module() default "System";
}

步骤2：编写处理器（AOP或代理）

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
@Aspect
@Component
public class LogAspect {
    @Around("@annotation(logExecution)")
    public Object logTime(ProceedingJoinPoint pjp, LogExecution logExecution) throws Throwable {
        long start = System.currentTimeMillis();
        Object result = pjp.proceed();
        long elapsed = System.currentTimeMillis() - start;
        System.out.println(logExecution.module() + " 执行耗时: " + elapsed + "ms");
        return result;
    }
}

步骤3：使用注解

@Service
public class UserService {
    @LogExecution(module = "用户服务")
    public User findUser(Long id) {
        // 业务逻辑...
    }
}

实战案例二：参数校验注解

很多业务需要对方法参数进行空值或范围校验,手动判断非常繁琐。

定义校验注解：

@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface NotNull {
    String message() default "参数不能为空";
}

处理器实现：

import java.lang.reflect.Method;
import java.lang.reflect.Parameter;
public class ValidationUtil {
    public static void validate(Object[] args, Method method) {
        Parameter[] parameters = method.getParameters();
        for (int i = 0; i < parameters.length; i++) {
            if (parameters[i].isAnnotationPresent(NotNull.class) && args[i] == null) {
                NotNull annotation = parameters[i].getAnnotation(NotNull.class);
                throw new IllegalArgumentException(annotation.message());
            }
        }
    }
}

结合代理使用：

public class ProxyFactory {
    public static <T> T createProxy(T target) {
        return (T) Proxy.newProxyInstance(
            target.getClass().getClassLoader(),
            target.getClass().getInterfaces(),
            (proxy, method, args) -> {
                ValidationUtil.validate(args, method);
                return method.invoke(target, args);
            }
        );
    }
}

注解的处理器实现（反射+动态代理）

自定义注解的核心在于处理器，主要实现方式有：

运行时反射处理：最常用，通过getAnnotation()获取注解信息
编译时处理：使用APT（Annotation Processing Tool）生成代码
字节码增强：通过ASM或Javassist在类加载时修改字节码

反射处理核心代码：

Method method = obj.getClass().getMethod("someMethod");
if (method.isAnnotationPresent(MyAnnotation.class)) {
    MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);
    // 根据注解属性执行逻辑
}

注意： 只有RetentionPolicy.RUNTIME的注解才能通过反射获取。