JavaSE学习之注解

Posted 2021-03-05 yfyyy

Java SE 注解(Annotation)

• JDK5.0 开始，Java增加了对元数据(MetaData)的支持，也就是Annotation(注解)
• Annotation 其实就是代码里的特殊标记，这些标记可以在编译，类加载，运行时被读取，并执行相应的处理。通过使用Annotation，程序员可以在不改变原有逻辑的情况下、在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署
• Annotation 可以像修饰符一样被使用，可用于修饰包，类，构造器，方法，成员变量，参数，局部变量的声明，这些信息被保存在 Annotation 的"name = value"对中。
• JavaEE的开发模式基本上基于注解
• 一定程度上，框架 = 注解 + 反射 + 设计模式

常见的Annotation示例

生成文档相关注解

• @author：标明开发该类模块的作者，多个作者之间使用 , 分割
• @version：标明该类模块的版本
• @see：参考转向（相关主题）
• @since：从哪个版本开始增加
• @param：对方法中某个参数的说明
• @return：对方法返回值的说明
• @exception：对方法可能抛出的异常进行说明，若方法没有用theows显式抛出的异常就不能写

编译时进行格式检查(JDK内置的三个基本注解)

• @Override：限定重写父类方法，该注解只能用于方法
• @Deprecated：用于表示所修饰的元素已经过时
• @SupperssWarnings：抑制编译器警告

跟踪代码依赖性，实现替代配置文件功能

• @WebServlet：Servlet3.0之后提供的注解，可以不在web.xml中进行Servlet的部署

• @Transactional：Spring框架中关于"事务"的管理

  @Transactional(propagation=Propagation.REQUIRES_NEW,Isolation=Isolation.READ_COMMITTED,isolation=Islation.READ_COMMITTED,readOnly=false,timeout=3)

Junit单元测试

• @Test：标记在非静态方法上，只有标记@Test的方法才能作为测试方法
• @BeforeClass：标记在静态方法上，只执行一次，在类初始化时执行
• @AfterClass：标记在静态方法上，只执行一次，在所有方法完成后执行
• @Before：标记在非静态方法上，在@Test之前执行，每一个@Test方法前都执行
• @After：标记在非静态方法上，在@Test之后执行，每一个@Test方法后都执行
• @Ignore：标记在本次不参与测试的方法上

注意：后五个注解是配合@Test使用的，单独使用无意义

自定义Annotation

• 定义新的Annotation类型使用 @interface 关键字
• 自定义注解自动继承了 java.lang.annotation.Annotation接口
• Annotation 的成员变量在 Annotation 定义中以无参方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称之为配置参数。类型只能是八种基本类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组

• 可以在定义 Annotation 的成员变量时，为其指定初始值，指定成员变量的初始值可以使用 default关键字

• 如果只有一个参数成员，建议使用 参数名为value
• 如果定义的注解含有配置参数，那么使用时必须指定参数值

• 没有成员定义的 Annotation 称为 标记 ，包含成员变量的 Annotation 称为元数据 Annotation

注意：自定义注解必须配上注解的信息处理流程才有意义

JDK 中的元注解

JDK 的元 Annotation 用于修饰其他 Annotation 定义！

JDK5.0 提供了4个标准的meta-annotation类型，分别是：

• Retention：用于修饰一个 Annotation 定义，用于指定该 Annotation 的生命周期，@Rentention 包含一个 RetentionPolicy 类型的成员变量，使用@Rentention 时，必须为该 value成员变量指定值
  • RetentionPolicy.SOURCE：在源文件中有效，编译器直接丢弃这种策略的注释
  • RetentionPolicy.CLASS：在class文件中有效，运行Java程序时，JVM不会保留注释，默认值
  • RetentionPolicy.TUNTIME：在运行时有效，运行Java程序时，JVM会保留注释。程序可以通过反射获取该注释
• Target：用于修饰 Annotation 定义，用于指定被修饰的 Annotation 能用于修饰哪些程序元素，@Target 也包含一个名为value的成员变量
  • CONSTRUCTOR：描述构造器
  • FIELD：描述域
  • LOCAL_VARIABLE：描述局部变量
  • METHOD：描述方法
  • PACKAGE：描述包
  • PARAMETER：描述参数
  • TYPE：描述类、接口或enum声明
• Documented：用于指定被该元 Annotation 修饰的 Annotation类将被javadoc 工具提取成文档，默认情况，javadovc是不包括注解的
  • 定义Documented的注解必须设置Retention值为RUNTIME
• Inherited：被它修饰的 Annotation 将具有 继承性，若某个类使用了被 @Inherited 修饰的 Annotation，则其子类将自动具有该注解
  • 应用较少