0
点赞
收藏
分享

微信扫一扫

java注解篇


一、什么是注解

JDK1.5之后引入的一个特性,于接口、枚举、类是同一个层次。可以对包、类、字段、方法、参数、局部变量进行说明、注释。

二、注解有什么作用

从JVM的角度看,注解本身对代码逻辑没有任何影响,如何使用注解完全由工具决定。

Java的注解可以分为三类:

第一类是由编译器使用的注解,例如:

  • ​@Override​​:让编译器检查该方法是否正确地实现了覆写;
  • ​@SuppressWarnings​​:告诉编译器忽略此处代码产生的警告。

这类注解不会被编译进入​​.class​​文件,它们在编译后就被编译器扔掉了。

第二类是由工具处理​​.class​​​文件使用的注解,比如有些工具会在加载class的时候,对class做动态修改,实现一些特殊的功能。这类注解会被编译进入​​.class​​文件,但加载结束后并不会存在于内存中。这类注解只被一些底层库使用,一般我们不必自己处理。

第三类是在程序运行期能够读取的注解,它们在加载后一直存在于JVM中,这也是最常用的注解。例如,一个配置了​​@PostConstruct​​的方法会在调用构造方法后自动被调用(这是Java代码读取该注解实现的功能,JVM并不会识别该注解)。

定义一个注解时,还可以定义配置参数。配置参数可以包括:

  • 所有基本类型;
  • String;
  • 枚举类型;
  • 基本类型、String、Class以及枚举的数组。

因为配置参数必须是常量,所以,上述限制保证了注解在定义时就已经确定了每个参数的值。

注解的配置参数可以有默认值,缺少某个配置参数时将使用默认值。

此外,大部分注解会有一个名为​​value​​的配置参数,对此参数赋值,可以只写常量,相当于省略了value参数。

如果只写注解,相当于全部使用默认值。

举个栗子,对以下代码:

public class Hello {
@Check(min=0, max=100, value=55)
public int n;

@Check(value=99)
public int p;

@Check(99) // @Check(value=99)
public int x;

@Check
public int y;
}

​@Check​​​就是一个注解。第一个​​@Check(min=0, max=100, value=55)​​​明确定义了三个参数,第二个​​@Check(value=99)​​​只定义了一个​​value​​​参数,它实际上和​​@Check(99)​​​是完全一样的。最后一个​​@Check​​表示所有参数都使用默认值。

JDK中预定义注解

@Override:检测被该注解标注的方法是否是继承自父类(接口)的

@Deprecated:该注解标注的内容,表示已过时

@SuppressWarnings:压制警告,一般传递参数all

@SuppressWarnings("all")all@SuppressWarnings("all")

三、元注解

有一些注解可以修饰其他注解,这些注解就称为元注解(meta annotation)。Java标准库已经定义了一些元注解,我们只需要使用元注解,通常不需要自己去编写元注解。

@Target

最常用的元注解是​​@Target​​​。使用​​@Target​​​可以定义​​Annotation​​能够被应用于源码的哪些位置:

  • 类或接口:​​ElementType.TYPE​​;
  • 字段:​​ElementType.FIELD​​;
  • 方法:​​ElementType.METHOD​​;
  • 构造方法:​​ElementType.CONSTRUCTOR​​;
  • 方法参数:​​ElementType.PARAMETER​​。

例如,定义注解​​@Report​​​可用在方法上,我们必须添加一个​​@Target(ElementType.METHOD)​​:

@Target(ElementType.METHOD)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

定义注解​​@Report​​​可用在方法或字段上,可以把​​@Target​​​注解参数变为数组​​{ ElementType.METHOD, ElementType.FIELD }​​:

@Target({
ElementType.METHOD,
ElementType.FIELD
})
public @interface Report {
...
}

实际上​​@Target​​​定义的​​value​​​是​​ElementType[]​​数组,只有一个元素时,可以省略数组的写法。

@Retention

另一个重要的元注解​​@Retention​​​定义了​​Annotation​​的生命周期:

  • 仅编译期:​​RetentionPolicy.SOURCE​​;
  • 仅class文件:​​RetentionPolicy.CLASS​​;
  • 运行期:​​RetentionPolicy.RUNTIME​​。

如果​​@Retention​​​不存在,则该​​Annotation​​​默认为​​CLASS​​​。因为通常我们自定义的​​Annotation​​​都是​​RUNTIME​​​,所以,务必要加上​​@Retention(RetentionPolicy.RUNTIME)​​这个元注解:

@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

@Repeatable

使用​​@Repeatable​​​这个元注解可以定义​​Annotation​​是否可重复。这个注解应用不是特别广泛。

@Repeatable(Reports.class)
@Target(ElementType.TYPE)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

@Target(ElementType.TYPE)
public @interface Reports {
Report[] value();
}

经过​​@Repeatable​​​修饰后,在某个类型声明处,就可以添加多个​​@Report​​注解:

@Report(type=1, level="debug")
@Report(type=2, level="warning")
public class Hello {
}

@Inherited

使用​​@Inherited​​​定义子类是否可继承父类定义的​​Annotation​​​。​​@Inherited​​​仅针对​​@Target(ElementType.TYPE)​​​类型的​​annotation​​​有效,并且仅针对​​class​​​的继承,对​​interface​​的继承无效:

@Inherited
@Target(ElementType.TYPE)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

在使用的时候,如果一个类用到了​​@Report​​:

@Report(type=1)
public class Person {
}

则它的子类默认也定义了该注解:

public class Student extends Person {
}

四、自定义注解

第一步,用​​@interface​​定义注解:

public @interface Report {
}

第二步,添加参数、默认值:

public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

把最常用的参数定义为​​value()​​,推荐所有参数都尽量设置默认值。

第三步,用元注解配置注解:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}

其中,必须设置​​@Target​​​和​​@Retention​​​,​​@Retention​​​一般设置为​​RUNTIME​​​,因为我们自定义的注解通常要求在运行期读取。一般情况下,不必写​​@Inherited​​​和​​@Repeatable​​。

五、使用注解

在程序使用(解析)注解:获取注解中定义的属性值

//定义注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnno {
public abstract String name();
}

//使用注解
public class Person {
@MyAnno(name="您好")
public void show() {

}
}
//取注解中的值
public class Test {
public static void main(String[] args) throws Exception {
Class<Person> pClass = Person.class;
MyAnno myAnno = pClass.getMethod("show").getAnnotation(MyAnno.class);
System.out.print(myAnno.name());
}
}

举报

相关推荐

0 条评论