一、注解概述
- 从JDK5.0开始，Java增加了对元数据的支持，也就是注解（Annotation）
- 注解其实就是代码里的特殊标记，这些标记可以在编译、类加载、运行时被读取，并执行相应的处理。
- 通过使用Annotation，程序员可以在不改变原有逻辑的情况下，在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。
- Annotation可以像修饰符一样被使用，可用于修饰包、类、构造器、方法、成员变量、参数、局部变量的声明，这些信息被保存在Annotation的"name=value"对中。
- 🔸在JavaSE中，注解的使用目的比较简单，例如标记过时的功能，忽略警告等。在JavaEE/Android中注解占据了更重要的角色，例如用来配置应用程序的任何切面，代替JavaEE旧版中所遗留的繁荣的代码和XML配置等
- 🔸未来的开发模式都是基于注解的，注解是一种趋势，一定程度上可以说：框架=注解+反射+设计模式
二、常见的Annotation示例
使用Annotation时要在其前面添加@符号，并把该Annotation当成一个修饰符使用，用于修饰它支持的程序元素
以下实例分为三个方面
1️⃣ 与生成文档相关的注解
在类或者函数前的文档注释中使用，在生成Javadoc时会把注解内容加进去
- @auther 标明开发该类模块的作者，多个作者之间使用逗号分隔
- @version 标明该类模块的版本
- @see 参考转向，也就是相关主题
- @since 从哪个版本开始增加的
- @param 在方法中某参数的说明，如果没有参数就不能写。只能用于方法
格式要求： @param 形参名 形参类型 形参说明 - @return 对方法返回值的说明，如果方法的返回值类型是void就不能写。只能用于方法
格式要求:@return 返回值类型 返回值说明 - @exception 对方法可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写在其中。只能用于方法
格式要求：@exception 异常类型 异常说明
2️⃣ 在编译时进行格式检查，JDK内置的三个基本注解
- @Override：限定重写父类方法，该注解只能用于方法（如果加了该注解，就会检查是否按照正确的格式进行重写）
- @Deprecated：用于表示所修饰的元素（类、方法等）已过时。通常是因为所修饰的结构危险或存在更好的选择。过时的元素仍可以使用，但是在后续的编程中不建议继续使用过时的元素(例如Date中的一个构造器)
/**
* Allocates a <code>Date</code> object and initializes it so that
* it represents midnight, local time, at the beginning of the day
* specified by the <code>year</code>, <code>month</code>, and
* <code>date</code> arguments.
*
* @param year the year minus 1900.
* @param month the month between 0-11.
* @param date the day of the month between 1-31.
* @see java.util.Calendar
* @deprecated As of JDK version 1.1,
* replaced by <code>Calendar.set(year + 1900, month, date)</code>
* or <code>GregorianCalendar(year + 1900, month, date)</code>.
*/
@Deprecated
public Date(int year, int month, int date) {
this(year, month, date, 0, 0, 0);
}
-
@SuppressWarnings：抑制编译器警告
warning示例
3️⃣跟踪代码依赖性，实现替代配置文件的功能
@WebServlet("/login")
public class LoginServlet extends HttpServlet{
//..........
}
<servlet>
<servlet-name>LoginServlet</servlet-name>
<servlet-class>com.servlet.LoginServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>LoginServlet</servlet-name>
<url-pattern>/login</url-pattern>
</servlet-mapping>
servlet3.0提供了注解，使得不再需要在web.xml文件中进行Servlet的部署
三、自定义Annotation
- 定义新的Annotation类型使用@interface关键字
- 自定义注解自动继承了java.lang.annotation.Annotation接口
- Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。类型只能是八种基本数据类型、String、class、enum、Annotation
- 可以在定义Annotation的成员变量时为其指定初始值，指定成员变量的初始值可使用default关键字
- 如果只有一个参数成员，建议使用参数名为value
public @interface MyAnnotation {
String value() default "hello";
}
- 自定义注解必须配上注解的信息处理流程才有意义
- 如果自定义注解没有成员，表明是一个标识作用
- 如果注解有成员变量，在使用注解时，需要指明成员的值，格式是“参数名=参数值”，如果只有一个参数变量，且名称为value，可以省略“value=”，并且有默认值的参数可以省略
四、JDK中的元注解
- 元注解用于修饰其他Annotation定义
- JDK5.0提供了4个标准的meta-annotation类型，分别是
Retention、Target、Documented、Inherited - @Retention：只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Retention包含一个RetentionPolicy类型的成员变量，使用该元注解时必须为该value成员变量指定值
①RetentionPolicy.SOURCE：在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注解
②RetentionPolicy.CLASS：在class文件中有效（即class保留），当在运行Java程序时，JVM不会保留注解。这是默认值
③RetentionPolicy.RUNTIME：在运行时有效（即运行时保留），当在运行Java程序时，JVM会保留注释，程序可以通过反射获取该注释 -
@Target：用于修饰Annotation定义，用于指定被修饰的Annotation能用于修饰哪些元素。@Target也包含一个名为value的成员变量。
取值类型 - @Documented：用于指定被该Annotation修饰的Annotation类将被javadoc工具提取成文档。默认情况下，javadoc是不包含该注解的
- @Inherited：被它修饰的Annotation将具有继承性。如果，某个类使用了被@Inherited修饰的注解，则其子类自动具有该注解
五、利用反射获取注解信息（在反射部分涉及）
六、JDK8中注解的新特性（可重复注解与类型注解）
- 可重复注解：
在MyAnnotation上声明@Repeatable，成员值为MyAnnotations.class。注意value类中必须含有需可重复注解的元素的数组。另外MyAnnotation的Target和Retention和MyAnnotations的相同
//没有@Repeatable之前
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
String value() default "hello";
}
@interface MyAnnotations{
MyAnnotation[] value();
}
class MyAnnotationTest{
@Test
@MyAnnotations({@MyAnnotation("ddd"),@MyAnnotation})
public void test1(){
}
}
//使用@Repeatable进行替换
@Repeatable(MyAnnotations.class)
public @interface MyAnnotation {
String value() default "hello";
}
@interface MyAnnotations{
MyAnnotation[] value();
}
class MyAnnotationTest{
@Test
@MyAnnotation
@MyAnnotation
public void test1(){
}
}
- 类型注解：
JDK1.8之后，关于元注解@Target的参数类型ElementType枚举值多了两个
①ElementType.TYPE_PARAMETER 表示该注解能谢在类型变量的声明语句中（如泛型声明）
②ElementType.TYPE_USE 表明该注解能写在任何类型的任何语句中
