java 自定义注解的实例详解

下面是关于“Java自定义注解的实例详解”的完整攻略：

1. 什么是Java自定义注解

Java自定义注解是一种注解工具，它可以在编写代码时增加代码的可读性和可维护性。注解是一种语言级别的元数据，它可以与代码元素（类、方法、成员变量等）进行关联并提供额外的信息。

Java自定义注解也称为元注解，在Java语言中已经内置了一些常用的注解，例如 @Override、@Deprecated、@SuppressWarnings 等，但是程序员可以自己创建新的注解类型。

在注解中，可以定义属性（也称为元素）并给它们指定默认值。应用于注解的代码元素可以通过反射机制来获取注解及其属性值。

2. 如何自定义注解

我们可以使用 Java 语言内置的 @interface 关键字来定义注解。注解的属性也称为元素，它们是定义注解的必要组件。在定义注解时，必须在关键字 @interface 后写注解名称，并且在花括号中指定注解的元素。

下面是一个自定义注解 MyAnnotation 的示例：

public @interface MyAnnotation {

    /**
     * 注解的描述信息
     */
    String value() default "";

    /**
     * 是否隐藏属性
     */
    boolean hidden() default false;
}

在这个示例中，我们定义了一个注解 MyAnnotation，并且定义了两个元素：value 和 hidden。其中，value 是一个字符串类型的元素，用于描述注解的作用；hidden 是一个布尔类型的元素，用于控制是否显示注解。

3. 如何使用自定义注解

有了一个自定义注解后，我们需要在代码中使用它。我们可以在类、方法、成员变量等代码元素上使用注解。对于类、方法等代码元素，我们可以在它们的前面加上注解名称和对应的属性值。

下面是一个在类上应用注解的示例：

@MyAnnotation(value = "这是一个测试注解", hidden = true)
public class MyClass {

    @MyAnnotation(value = "这是一个测试属性")
    private String myProperty;

    @MyAnnotation(hidden = true)
    public void myMethod() {
        System.out.println("这是一个测试方法");
    }
}

在这个示例中，我们在类 MyClass 上应用了注解 @MyAnnotation，并定义了两个元素。在类中，我们也在成员变量 myProperty 和方法 myMethod 中应用了注解。

4. 示例说明

下面是两个示例说明，来说明如何应用自定义注解。

示例一

假设我们有一个业务系统，需要对每个方法调用的时间进行记录。我们可以自定义一个 @LogTime 注解，应用于需要记录时间的方法上。

首先，我们定义 @LogTime 注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogTime {

    /**
     * 描述信息
     */
    String value() default "";
}

然后，我们在需要记录时间的方法上应用注解。

public class ApiService {

    @LogTime("获取用户信息")
    public void getUserInfo(String userId) {
        System.out.println("获取用户信息：" + userId);
    }

    @LogTime("获取订单信息")
    public void getOrderInfo(String orderId) {
        System.out.println("获取订单信息：" + orderId);
    }
}

最后，我们在 AOP 切面中，捕捉到方法调用事件，并对应用了 @LogTime 注解的方法进行时间记录。

@Aspect
@Component
public class LogAspect {

    @Around("@annotation(logTime)")
    public Object logTimeAround(ProceedingJoinPoint pjp, LogTime logTime) {
        long startTime = System.currentTimeMillis();

        Object result = null;
        try {
            result = pjp.proceed();
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        } finally {
            long endTime = System.currentTimeMillis();

            System.out.println(logTime.value() + "，耗时：" + (endTime - startTime) + "ms");
        }

        return result;
    }
}

示例二

假设我们要实现一个通过检查身份证号码是否合法的程序，我们可以自定义一个 @IdCard 注解，并应用到需要验证身份证号码的属性上。

首先，我们定义 @IdCard 注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface IdCard {
}

然后，在使用该注解的代码中，我们可以定义一个字符串类型的属性，并应用 @IdCard 注解：

public class User {

    @IdCard
    private String idCardNumber;

    public String getIdCardNumber() {
        return idCardNumber;
    }

    public void setIdCardNumber(String idCardNumber) {
        this.idCardNumber = idCardNumber;
    }
}

最后，我们可以定义一个工具类 IdCardUtils，实现身份证号码的验证逻辑。

public class IdCardUtils {

    /**
     * 验证身份证号码是否合法
     *
     * @param idCardNumber 身份证号码
     * @return true：合法，false：不合法
     */
    public static boolean verify(@IdCard String idCardNumber) {
        // 身份证验证逻辑
        return true;
    }
}

使用示例：

User user = new User();
user.setIdCardNumber("110101199003071234");

if (IdCardUtils.verify(user.getIdCardNumber())) {
    System.out.println("身份证号码合法");
} else {
    System.out.println("身份证号码不合法");
}

以上两个示例，简要演示了自定义注解的使用，可以通过这些示例，深刻理解自定义注解提高代码可读性、可维护性的作用。