自定义目录
- 一、什么是注解
- 二、常见的注解示例
- 三、自定义 annotation
- 四、JDK 中的元注解
- 五、利用反射获取注解信息
- 六、jdk8之后注解的新特性
- 1、可重复注解
- 2、类型注解
一、什么是注解
- 加在包,类, 构造器, 方法, 成员变量, 参数, 局部变量声明上面的特殊标记就称为注解
- 未来的开发模式都是基于注解的。 框架 = 注解 + 反射 + 设计模式。
二、常见的注解示例
1、生成文档相关的注解
@author 标明开发该类模块的作者,多个作者之间使用,分割
@version 标明该类模块的版本
@param 对方法中某参数的说明,如果没有参数就不能写
@return 对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明
2、在编译时进行格式检查(JDK内置的三个基本注解)
@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择
@SuppressWarnings: 抑制编译器警告
3、框架中定义的注解,用于替代配置文件
@Transactional
三、自定义 annotation
/*** 自定义注解*/
@Target({TYPE, FIELD, METHOD, PARAMETER, TYPE_PARAMETER})
public @interface MyAnnotation {// 声明注解属性String value();
}
- 自定义注解使用 @interface 定义
- 注解的成员变量后面需要携带 ()
- 注解的成员变量的类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
- 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
- 如果只有一个参数成员,建议使用参数名为value
四、JDK 中的元注解
JDK 的元注解用于修饰其他 Annotation 定义
JDK5.0提供了4个标准的元注解,分别是:Retention、Target、Documented、Inherited
-
@Retention: 用于指定注解的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值:
- RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
- RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
- RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释
-
@Target: 用于指定被修饰的注解能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量
-
@Documented: 被该元注解修饰的注解类将被javadoc 工具提取成文档
-
@Inherited: 被它修饰的 注解将具有继承性。如果某个类使用了被@Inherited 修饰的注解, 则其子类将自动具有该注解
五、利用反射获取注解信息
见反射章节:
六、jdk8之后注解的新特性
- Java 8对注解处理提供了两点改进:可重复的注解及可用于类型的注解。
1、可重复注解
在某个类、方法…上面可以加多个相同的注解
2、类型注解
- JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个:TYPE_PARAMETER,TYPE_USE
- 在Java 8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方。
- ElementType.TYPE_PARAMETER 表示注解能够应用于类型变量的声明上。类型变量就是泛型中的类型参数
- ElementType.TYPE_USE 表示注解可以用在任何使用类型的地方
class Generic<@MyAnnotation("JHH") T> {}public class Example {public <@MyTypeUseAnnotation T> void myMethod(T t) {}public void exampleMethod() {// 注解可以用在类型转换上Object obj = "This is a string";String str = (@MyTypeUseAnnotation String) obj;// 注解可以用在throws子句上try {myMethod("test");} catch (@MyTypeUseAnnotation Exception e) {e.printStackTrace();}}
}
通过这两种类型的 ElementType,Java 8 在类型注解方面提供了更大的灵活性和更强的类型检查能力。这对于提高代码的质量、增加额外的类型检查以及与一些特定的框架或工具(如依赖注入框架、序列化/反序列化库、静态分析工具等)配合使用都是非常有用的。