Java自定义注解

一 简介
注解是Java 1.5引入的,可以提供代码的额外信息,目前正在被广泛应用。除了Java内置注解,我们也可以自定义注解。以下就是一个自定义注解的例子:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Msg {
  String DEFAULT_MSG = "msg";

  String msg() default DEFAULT_MSG
}

自定义注解分析:
1.@interface关键字定义注解,
2.注解可以被其它注解修饰(如果我说注解,这也太绕了),最重要的就是元注解。
3.注解和接口类似,内部可以定义常量和方法。
4.注解定义的方法有一些限制:方法不能有参数;返回值只能是基本类型、字符串、Class、枚举、注解、及以上类型的数组;可以包含默认值。

二 元注解
元注解就是定义注解的注解,包含@Target、@Retention、@Inherited、@Documented这四种。
2.1 @Target
描述注解的使用目标,取值有:
ElementType.PACKAGE 注解作用于包
ElementType.TYPE 注解作用于类型(类,接口,注解,枚举)
ElementType.ANNOTATION_TYPE 注解作用于注解
ElementType.CONSTRUCTOR 注解作用于构造方法
ElementType.METHOD 注解作用于方法
ElementType.PARAMETER 注解作用于方法参数
ElementType.FIELD 注解作用于属性
ElementType.LOCAL_VARIABLE 注解作用于局部变量
默认可以作用于以上任何目标。
@Target注解源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Target {
    ElementType[] value();
}

注解方法返回值是ElementType[],ElementType枚举类型,枚举值就是@Target注解的可取值。方法名value,这样在使用注解时,可以不需要指定方法名。

2.2 @Retention
描述注解的生命周期,取值有:
RetentionPolicy.SOURCE 源码中保留,编译期可以处理
RetentionPolicy.CLASS Class文件中保留,Class加载时可以处理
RetentionPolicy.RUNTIME 运行时保留,运行中可以处理
默认RetentionPolicy.CLASS 值
@Retention注解源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Retention {
    RetentionPolicy value();
}

注解方法返回值是枚举类型RetentionPolicy,枚举值就是@Retention注解的可取值。

2.3 @Inherited
标记注解,使用@Inherited修饰的注解作用于一个类,则该注解将被用于该类的子类。
@Inherited注解源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Inherited {
}

2.4 @Documented
描述注解可以文档化,是一个标记注解。
在生成javadoc的时候,是不包含注释的,但是如果注解被@Documented修饰,则生成的文档就包含该注解。
@Documented注解源码如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Documented {
}

三 自定义注解实例
3.1 自定义注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Msg {
  String DEFAULT_MSG = "msg";

  String msg() default DEFAULT_MSG;
}

3.2 使用自定义注解

@Msg(msg = "Test")
public class Test {
    
}

3.3 获取注解

public class Main {
  public static void main(String[] args) {
      Test test = new Test();
      Class tClass = test.getClass();
      Msg msg = (Msg) tClass.getAnnotation(Msg.class);
      System.out.println(msg.msg());
  }
}

运行结果:Test
因为Msg注解的生命周期为RetentionPolicy.RUNTIME,所以可以运行时通过反射获取。对于编译器处理的注解,可以使用APT处理。

<think>好的,用户想了解如何在Java中创建和使用自定义注解,并需要示例。首先,我需要回忆Java注解的基础知识。自定义注解是通过@interface关键字定义的,这类似于接口,但多了@符号。然后,元注解如@Target和@Retention是必须的,它们指定了注解的使用范围和生命周期。 用户提供的引用内容中提到,@Retention(RetentionPolicy.RUNTIME)让注解在运行时可见,这样可以通过反射读取。@Target指定注解可以应用的位置,比如方法或字段。接下来,自定义注解可以包含元素,这些元素可以有默认值。 在示例部分,我需要展示如何定义注解类,然后如何应用到方法上。使用反射来获取注解信息是关键步骤,用户可能需要看到如何通过Method对象获取注解实例,并读取其属性。 然后,关于使用场景,引用[2]提到结合拦截器或AOP,这部分需要简要说明,但用户的问题主要是创建和使用示例,可能不需要深入框架细节,但可以提及这些高级应用作为扩展。 需要检查语法是否正确,比如注解定义是否正确,反射代码是否恰当。例如,确保使用method.getAnnotation(MyAnnotation.class)来获取注解实例。同时,代码示例需要正确格式化,避免语法错误。 可能还需要考虑用户是否了解反射机制,因此在解释代码时,要提到反射的作用,即运行时处理注解。另外,要提到默认值的作用,当用户不指定值时使用的默认设置。 最后,生成相关问题时要围绕自定义注解的深入应用、注解元素类型和高级用法,确保问题有助于用户进一步学习。例如,处理参数或类的注解,或者结合Spring AOP的使用。 总结回答结构:定义注解类,使用元注解,添加元素,应用注解到方法,通过反射读取,示例代码,使用场景,相关问题。确保每个步骤清晰,代码正确,并且解释到位。</think>### Java自定义注解的创建与使用示例 #### 一、自定义注解的创建 1. **定义注解类** 使用 `@interface` 关键字定义注解,并添加元注解(如 `@Target` 和 `@Retention`): ```java import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Retention(RetentionPolicy.RUNTIME) // 注解在运行时可通过反射读取 @Target(ElementType.METHOD) // 注解仅用于方法 public @interface MyAnnotation { String value() default ""; // 注解属性,默认值为空字符串 int count() default 1; // 注解属性,默认值为1 } ``` 2. **元注解说明** - `@Retention`:定义注解的生命周期 - `RetentionPolicy.SOURCE`:仅源码可见(如 `@Override`) - `RetentionPolicy.CLASS`:编译时可见(默认值) - `RetentionPolicy.RUNTIME`:运行时可见(需反射读取)[^1] - `@Target`:定义注解的适用范围(方法、字段、类等)[^2] --- #### 二、自定义注解的使用 1. **在方法上添加注解** ```java public class ExampleClass { @MyAnnotation(value = "测试方法", count = 3) public void testMethod() { System.out.println("执行测试方法"); } } ``` 2. **通过反射读取注解** ```java import java.lang.reflect.Method; public class AnnotationProcessor { public static void main(String[] args) throws Exception { Method method = ExampleClass.class.getMethod("testMethod"); if (method.isAnnotationPresent(MyAnnotation.class)) { MyAnnotation annotation = method.getAnnotation(MyAnnotation.class); System.out.println("注解值: " + annotation.value()); // 输出 "测试方法" System.out.println("执行次数: " + annotation.count()); // 输出 3 } } } ``` --- #### 三、核心应用场景 1. **框架设计** 结合拦截器或AOP(面向切面编程),实现日志记录、权限校验等功能。 ```java // 示例:通过AOP拦截带有@MyAnnotation的方法 @Aspect public class MyAnnotationAspect { @Around("@annotation(com.example.MyAnnotation)") public Object process(ProceedingJoinPoint joinPoint) throws Throwable { System.out.println("方法执行前处理"); Object result = joinPoint.proceed(); System.out.println("方法执行后处理"); return result; } } ``` 2. **配置化编程** 通过注解替代XML配置,提升代码可读性(如Spring框架的 `@Autowired`)。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值