• Java 基础【14】@注解


    1.注解简介

       JDK 1.5 中引入的 java.lang.annotation 包提供注解编程支持,可以让类在编译、类加载、运行时被读取,并执行相应的处理。

       在 Java EE应用的时候,总是免不了与各种配置文件打交道。

       以Java EE中典 型的S(pring)S(truts)H(ibernate)架构来说,Spring、Struts和Hibernate这三个框架都有自己的XML格式的配置文件。

       这些配置文件需要与Java源代码保存同步,否则的话就可能出现错误。而且这些错误有可能到了运行时刻才被发现。

       理想的情况是在一个地方维护这些信息就好了。其它部分所需的信息则通过自动的方式来生成。

       注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。Java注解已经在很多框架中得到了广泛的使用,用来简化程序中的配置。

    • 生成文档。这是最常见的,也是java 最早提供的注解。常用的有@see @param @return 等;
    • 跟踪代码依赖性,实现替代配置文件功能。比较常见的是spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量;
    • 编译时进行格式检查。如@Override 放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出。

    2.使用注解

        注解的语法比较简单,除了@符号的使用之外,它基本与Java固有语法一致。

       Java SE5内置了三种标准注解:  @Override,表示当前的方法定义将覆盖超类中的方法。 

       @Deprecated,使用了注解为它的元素编译器将发出警告,因为注解@Deprecated是不赞成使用的代码,被弃用的代码。 

       @SuppressWarnings,关闭不当编译器警告信息。 上面这三个注解多少我们都会在写代码的时候遇到。Java还提供了4中注解,专门负责新注解的创建。

    @Target

    表示该注解可以用于什么地方,可能的ElementType参数有:

    CONSTRUCTOR:构造器的声明

    FIELD:域声明(包括enum实例)

    LOCAL_VARIABLE:局部变量声明

    METHOD:方法声明

    PACKAGE:包声明

    PARAMETER:参数声明

    TYPE:类、接口(包括注解类型)或enum声明

    @Retention

    表示需要在什么级别保存该注解信息。可选的RetentionPolicy参数包括:

    SOURCE:注解将被编译器丢弃

    CLASS:注解在class文件中可用,但会被VM丢弃

    RUNTIME:VM将在运行期间保留注解,因此可以通过反射机制读取注解的信息。

    @Document

    将注解包含在Javadoc中

    @Inherited

    允许子类继承父类中的注解

       在一般的Java开发中,最常接触到的可能就是@Override和@SupressWarnings这两个注解。

       使用@Override的时候只需要一个简单的声明即可。这种称为标记注解(markerannotation ),它的出现就代表了某种配置语义。

       而其它的注解是可以有自己的配置参数的。配置参数以名值对的方式出现。使用 @SupressWarnings的时候需要类似@SupressWarnings({"uncheck", "unused"})这样的语法。

       在括号里面的是该注解可供配置的值。由于这个注解只有一个配置参数,该参数的名称默认为value,并且可以省略。

       而花括号则表示是数组类型。在JPA中的@Table注解使用类似@Table(name = "Customer", schema = "APP")这样的语法。

       从这里可以看到名值对的用法。在使用注解时候的配置参数的值必须是编译时刻的常量。 

       从某种角度来说,可以把注解看成是一个XML元素,该元素可以有不同的预定义的属性。

       而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解,就相当于把一部分元数据从XML文件移到了代码本身之中,在一个地方管理和维护。

    3.开发注解

       在一般的开发中,只需要通过阅读相关的API文档来了解每个注解的配置参数的含义,并在代码中正确使用即可。

       在有些情况下,可能会需要开发自己的注解。这在库的开发中比较常见。注解的定义有点类似接口。

       下面的代码给出了一个简单的描述代码分工安排的注解。通过该注解可以在源代码中记录每个类或接口的分工和进度情况。

    1 @Retention(RetentionPolicy.RUNTIME)
    2 @Target(ElementType.TYPE)
    3 public @interface Assignment {
    4 String assignee();
    5 int effort();
    6 double finished() default 0;
    7 } 

        @interface用来声明一个注解,其中的每一个方法实际上是声明了一个配置参数。

       方法的名称就是参数的名称,返回值类型就是参数的类型。可以通过default来声明参数的默认值。

       在这里可以看到@Retention和@Target这样的元注解,用来声明注解本身的行为。

       @Retention用来声明注解的保留策略,有CLASS、RUNTIME和SOURCE这三种,分别表示注解保存在类文件、JVM运行时刻和源代码中。

       只有当声明为RUNTIME的时候,才能够在运行时刻通过反射API来获取到注解的信息。

       @Target用来声明注解可以被添加在哪些类型的元素上,如类型、方法和域等。

  • 相关阅读:
    我最讨厌画图,这辈子我都不想再画图
    bzoj1218[HNOI2003]激光炸弹
    bzoj1196[HNOI2006]公路修建问题
    bzoj1588[HNOI2002]营业额统计
    bzoj2039[2009国家集训队]employ人员雇佣
    bzoj3874[Ahoi2014]宅男计划
    bzoj2282[Sdoi2011]消防
    bzoj1798[Ahoi2009]Seq 维护序列seq
    bzoj4003[JLOI2015]城池攻占
    bzoj2809[Apio2012]dispatching
  • 原文地址:https://www.cnblogs.com/java-class/p/4756667.html
Copyright © 2020-2023  润新知