Java的注解

注解

注解(Annotation)也被称为元数据(Metadata),用于修饰解释包、类、方法、属性、构造器、局部变量等数据信息。

和注释一样,注解不影响程序逻辑,但注解可以被编译或运行,相当于嵌入在代码中的补充信息。

JavaSE 中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。

JavaEE 中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替java EE 旧版中所遗留的繁冗代码和XML 配置等。



基本注解

使用Annotation 时要在其前面增加@符号, 并把该Annotation 当成一个修饰符使用。用于修饰它支持的程序元素。

注: 源码中@interface不是interface接口,是注解类是jdk5.0之后加入的,表示一个注解类。


@Override

@Override:限定某个方法,是重写父类方法,该注解只能用于方法。

1.指定重写父类的方法(从编译层面验证),如果父类没有该方法,则会报错。

2.如果不写@Override注解,而父类仍有该方法,仍然构成重写。

3.`只能修饰方法,不能修饰其它类,包,属性等等

4.查看@Override注解源码为@Target(ElementType.METHOD), 说明只能修饰方法。(@Target是修饰注解的注解,称为元注解)


@Deprecated

@Deprecated: 用于表示某个程序元素(类, 方法等)已过时

1.用于表示某个程序元素(类,方法等)已过时

2.可以修饰方法,类,字段,包,参数等等

3.@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE,PARAMETER. TYPE})

4.@Deprecated的作用可以做到新旧版本的兼容和过渡


@SuppressWarnings

@SuppressWarnings: 抑制编译器警告

  1. unchecked是忽略没有检查的警告
  2. rawtypes是忽略没有指定泛型的警告(传参时没有指定泛型的警告错误)
  3. unused是忽略没有使用某个变量的警告错误
  4. @SuppressWarnings可以修饰的程序元素为,查看@Target
  5. 生成@SupperssWarnings时,不用背,直接点击左侧的黄色提示,就可以选择(注意可以指定生成的位置)

属性介绍

all,抑制所有警告
boxing,抑制与封装/拆装作业相关的警告
cast,抑制与强制转型作业相关的警告
dep-ann,抑制与淘汰注释相关的警告
deprecation,抑制与淘汰的相关警告
fallthrough,抑制与switch陈述式中遗漏break相关的警告
finally,抑制与未传回finally区块相关的警告
hiding,抑制与隐藏变数的区域变数相关的警告
incomplete-switch,抑制与switch陈述式(enum case)中遗漏项目相关的警告
javadoc,抑制与javadoc相关的警告
nls,抑制与非nls字串文字相关的警告
null,抑制与空值分析相关的警告
rawtypes,抑制与使用raw类型相关的警告
resource,抑制与使用Closeable类型的资源相关的警告
restriction,抑制与使用不建议或禁止参照相关的警告
serial,抑制与可序列化的类别遗漏serialVersionUID栏位相关的警告
static-access,抑制与静态存取不正确相关的警告
static-method,抑制与可能宣告为static的方法相关的警告
super,抑制与置换方法相关但不含super呼叫的警告
synthetic-access,抑制与内部类别的存取未最佳化相关的警告
sync-override,抑制因为置换同步方法而遗漏同步化的警告
unchecked,抑制与未检查的作业相关的警告
unqualified-field-access,抑制与栏位存取不合格相关的警告
unused,抑制与未用的程式码及停用的程式码相关的警告



元注解

JDK 的元Annotation 用于修饰其他 Annotation


@Retention

只能用于修饰一个Annotation 定义, 用于指定该Annotation 可以保留多长时间

@Rentention 包含一个RetentionPolicy类型的成员变量

使用@Rentention 时必须为该value 成员变量指定值: @Retention 的三种值

  1. RetentionPolicy.SOURCE: 编译器使用后,直接丢弃这种策略的注释
  2. RetentionPolicy.CLASS: 编译器将把注解记录在class 文件中. 当运行Java 程序时, JVM 不会保留注解。这是默认值
  3. RetentionPolicy.RUNTIME:编译器将把注解记录在class 文件中. 当运行Java 程序时, JVM 会保留注解. 程序可以通过反射获取该注解。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE) // 编译器编译时生效,不会写入到class文件中
public @interface Override {
}

@Target

用于修饰 Annotation定义,指定被修饰的Annotation能用于修饰哪些程序元素

@Target 也包含一个名为value的成员变量。

@Documented
@Retention(RetentionPolicy.RUNTIME) // 作用范围RUNTIME
@Target(ElementType.ANNOTATION_TYPE) // 只能修饰注解
public @interface Target { // 说明它是注解
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value(); // 这里深入源码再看一下ElementType的取值
}
public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Documented

@Documented:用于指定被该元 Annotation修饰的Annotation类将被javadoc工具提取成文档

即在生成文档时,可以看到该注解。

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


@Inherited

被它修饰的Annotation将具有继承性。

如果某个类使用了被@Inherited修饰的Annotation,则其子类将自动具有该注解。

你可能感兴趣的:(Java,java,开发语言,后端)