Java 自定义注解

Java 自定义注解

 

 

 

1、简介

 注解是一种能被添加到java源代码中的元数据，方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记，可以用在方法、类、参数和包上，程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

 

2、元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解：

1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited

这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

2.1、@Target

表明该注解可以应用的java元素类型：

Target类型	描述
ElementType.TYPE	应用于类、接口（包括注解类型）、枚举
ElementType.FIELD	应用于属性（包括枚举中的常量）
ElementType.METHOD	应用于方法
ElementType.PARAMETER	应用于方法的形参
ElementType.CONSTRUCTOR	应用于构造函数
ElementType.LOCAL_VARIABLE	应用于局部变量
ElementType.ANNOTATION_TYPE	应用于注解类型
ElementType.PACKAGE	应用于包
ElementType.TYPE_PARAMETER	1.8版本新增，应用于类型变量
ElementType.TYPE_USE	1.8版本新增，应用于任何使用类型的语句中（例如声明语句、泛型和强制转换语句中的类型）

2.2、@Retention
  表明该注解的生命周期

生命周期类型	描述
RetentionPolicy.SOURCE	编译时被丢弃，不包含在类文件中
RetentionPolicy.CLASS	JVM加载时被丢弃，包含在类文件中，默认值
RetentionPolicy.RUNTIME	由JVM 加载，包含在类文件中，在运行时可以被获取到

2.3、@Document
  表明该注解标记的元素可以被Javadoc 或类似的工具文档化。

 

2.4、@Inherited
  表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解。

 

3、自定义注解

1. 修饰符： 访问修饰符必须为public,不写默认为pubic；
2. 关键字： 关键字为@interface；
3. 注解名称： 注解名称为自定义注解的名称，使用时还会用到；
4. 注解内容： 注解中内容，对注解的描述。

3.1、自定义@MyController注解：

/** * @Author dw * @ClassName MyController * @Description 自定义注解， 可用于类、方法上 * @Date 2022/1/10 21:33 * @Version 1.0 */ @Documented @Target({ElementType.TYPE, ElementType.METHOD}) @Retention(RetentionPolicy.RUNTIME) @Inherited public @interface MyController { String value() default ""; String des() default "我是一个自定义注解"; }

 

3.2、在类上使用自定义的注解

/** * @Author dw * @ClassName TestAnnotation * @Description 自定义注解使用 * @Date 2022/1/10 21:42 * @Version 1.0 */ @MyController(value = "我是指定注解value") public class TestAnnotation { public static void main(String[] args) { try { TestAnnotation testAnnotation = new TestAnnotation(); Class<? extends TestAnnotation> aClass = testAnnotation.getClass(); //判断person对象上是否有Info注解
            if (aClass.isAnnotationPresent(MyController.class)) { System.out.println("TestAnnotation类上配置了MyController注解！"); //获取该对象上Info类型的注解
                MyController myController = aClass.getAnnotation(MyController.class); System.out.println("myController.value :" + myController.value() + ", myController.des:" + myController.des()); }  } catch (Exception e) { e.printStackTrace(); } } }

执行结果如下：

 

 

4、Aop中的应用：

请参考之前的文章：在Aop 中使用自定义注解