1、注解的基本介绍
注解就是放在 Java 代码的类、方法、字段、参数前的一种特殊“注释”。注解的格式:@注解名称(属性名=属性值, 属性名=属性值)。
注解可以像修饰符一样使用,可用于修饰包、类、构造器、方法成员变量、参数、局部变量。使用注解可以简化一些配置。注释会被编译器直接忽略,而注解则可以被编译器打包进入 class 文件,因此,注解是一种用作标注的“元数据”。
@Resource("hello")
public class Hello {
@Inject
int n;
@PostConstruct
public void hello(@Param String name) {
System.out.println(name);
}
@Override
public String toString() {
return "Hello";
}
}
如何使用注解由工具决定,注解本身对代码逻辑没有影响。
1.1、注解的分类
Java的注解可以分为三类:
第一类是由编译器使用的注解,这类注解不会被编译进入.class
文件,它们在编译后就被编译器扔掉了。例如:
-
@Override
:让编译器检查该方法是否正确地实现了覆写; -
@SuppressWarnings
:告诉编译器忽略此处代码产生的警告。
第二类是由工具处理.class
文件使用的注解,比如有些工具会在加载class的时候,对class做动态修改,实现一些特殊的功能。这类注解会被编译进入.class
文件,但加载结束后并不会存在于内存中。这类注解一般只被一些底层库使用,我们很少用到。
第三类是在程序运行期能够读取的注解,它们在加载后一直存在于JVM中,这也是最常用的注解。例如,一个配置了@PostConstruct
的方法会在调用构造方法后自动被调用(这是Java代码读取该注解实现的功能,JVM并不会识别该注解)。
2、使用注解
使用注解时,可以添加参数值。参数值必须是确定的,注解的参数值可以有默认值,缺少某个配置参数时将使用默认值。如果不写参数值,相当于全部参数都使用默认值。
此外,大部分注解会有一个名为value
的配置参数,当注解的参数中没有参数名,只有一个参数值并且该注解是有 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
表示所有参数都使用默认值。
3、定义注解(@interface)
通常来说并不需要自定义一个注解,但如果需要,我们可以使用@interface
语法来定义注解(Annotation
)。注解的参数类似无参数方法,可以用default
设定一个默认值(强烈推荐),最常用的参数应当命名为value
。
声明一个注解要用到的东西:
- 修饰符:访问修饰符必须为public,不写默认为pubic;
- 关键字:关键字为@interface;
- 注解名称:注解名称为自定义注解的名称,使用时还会用到;
- 注解类型元素:注解类型元素是注解中内容,可以理解成自定义接口的实现部分;
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
@interface用于定义注解接口,接口中只能定义成员变量,且定义的成员变量必须以()结尾,可以有default关键字来指定默认值,如果没有default,则在使用注解时必须赋值。
3.1、元注解(meta annotation)
有一些注解可以修饰其他注解,这些注解就称为元注解(meta annotation)。Java标准库已经定义了一些元注解,主要有@Target、@Retention、@Document、@Inherited 用来修饰注解,一般我们只需要使用元注解,通常不需要自己去编写元注解。
3.1.1、@Target
最常用的元注解是@Target
。使用@Target
可以定义Annotation
能够用于Java代码中的哪些地方:
例如,定义注解@Report
可用在方法上,我们必须添加一个@Target(ElementType.METHOD)
:
@Target(ElementType.METHOD)
public @interface Report {
int type() default 0;
String level() default "info";
String value() default "";
}
3.1.2、@Retention
另一个重要的元注解@Retention
定义了Annotation
的生命周期:
如果@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 "";
}
3.1.3、@Document
表明该注解标记的元素可以被Javadoc 或类似的工具文档化
3.1.4、@Inherited
表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解