Annotation--注解

Annotation

• 概述：

  • Annotation可以像修饰符一样被使用，可用于修饰包，类，构造器，方法，成员变量，参数，局部变量的声明，这些信息被保存在Annotation的“name = value”对中

  • 可以说框架 = 注解 + 反射 + 设计模式

常见的Annotation示例

• 示例一：生成文档相关的注解

  • @author：标明开发该类模块的作者，多个作者之间使用，分隔

  • @version：标明该类模块的版本

  • @see：参考转向，也就是相关的主题

  • @since：从哪个版本开始增加的

  • @param：对方法中某参数的说明，如果没有参数就不能写

  • @return：对方法返回值的说明，如果方法返回值为void就不能写

  • @exception:对方法中可能抛出的异常进行说明，如果方法没有用throws显式抛出的异常就不能写入其中

  • @param @return @exception这三个标记都只是用于方法的

  • @param 的格式要求：@param 形参名 形参类型 形参说明

  • @return 的格式要求：@return 返回值类型 返回值说明

  • @exception 的格式要求：@exception 异常类型 异常说明

  • @param 和@exception 可以并列多个

• 示例二：在编译时进行格式检查(JDK内置的三个基本注解)

  • @Override：限定重写父类方法，该注解只能用于方法

  • @Deprecated：用于表示所修饰类的元素(类、方法等)已过时，通常是因为所修饰的结构危险或存在更好的选择

  • @SuppressWarnings：抑制编译器警告

• 示例三：跟踪代码依赖性，实现替代配置文件功能

  • Servlet3.0提供了注解，使得不在需要在web.xml文件中进行servlet的部署

  • spring框架中关于事物的管理

元注解

对现有的注解进行解释说明的注解

自定义注解通常都会指明两个元注释：Retention、Target

• Retention：只能用于修饰一个Annotation定义，用于指定该Annotation的生命周期，@Retention包含一个RetentionPolicy类型的成员变量，使用@Rentention时必须为该value成员变量指定值

  • RetentionPolicy.SOURCE：在源文件中有效(即源文件保留)，编译器直接丢弃这种策略注释

  • RetentionPolicy.CLASS：在class文件中有效(即class保留)，当运行Java程序时，JVM不会保留注释。这是默认值

  • RetentionPolicy.RUNTIME：在运行时有效(即运行时保留)，当运行Java程序时，JVM会保留注释。程序可以通过反射获取该注释(只有声明为RUNTIME生命周期的注解，才能通过反射获取)

• Target：用于指定被修饰的Annotation能用于修饰哪些程序元素

以下两种注解使用很少

• Documented：用于指定被该Annotation修饰的Annotation类将被javadoc工具提取成文档。默认情况下，javadoc是不包括注解的。

  • 定义为Documented的注解必须设置Retention值为RUNTIME

• Inherited：被它修饰的Annotation将具有继承性。如果某个类使用了被@Inherited修饰的Annotation，则其子类将自动具有该注解