壹 介绍
Annotation
(注解)又称Java
标注,是从JDK5.0
开始引入的新特性,它提供了一种安全的类似注释的机制,用来将任何的信息或元数据(metadata
)与程序元素(类、方法、成员变量等)进行关联,附加在代码中的一些元信息,用于一些工具在编译、运行时进行解析和使用,起到说明、配置的功能。说白了就是对Java
代码在编写或者编译中给程序进行了一些说明或者解释。例如:用SpringBoot
写的代码中Controller
类代码前面会有一个@Controller
注解,这注解就给程序解释,这个Controller
类就是SpringBoot
的标记控制器类,是SpringBoot
的小弟。
Annotation
的作用:
- 注解不是程序本身,注解是对程序作出的解释,这一点和注释(
comment
)没什么区别 - 可以被其他程序,比如:编译器等读取。
Annotation
的格式:
- 注解是以
@注释名
在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value="unchecked")
Annotation
应用:
- 生成文档这是最常见的,也是
java
最早提供的注解 - 在编译时进行格式检查,如
@Override
放在方法前,如果你这个方法并不是覆盖了超类方法,则编译时就能检查出 - 跟踪代码依赖性,实现替代配置文件功能,比较常见的是spring 2.5 开始的基于注解配置,作用就是减少配置;
- 可以附加在
package
(b包)、class
(类)、method
(方法)、field
(属性) 等上面,相当于给他们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问
贰 Java注解分类
2.1 标准内置注解
以下是Java
内置的几个标准注解:
注解名字 | 功能描述 |
---|---|
@Override |
定义在java.lang.Override 中,此注解只适用于修饰method ,表示检查该方法是否是重写方法,如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误 |
@Deprecated |
定义在java.lang.Deprecated 中,此注解只适用于修饰method 、class 、field ,表示该方法为过时的方法,通常是因为它很危险或者有更好的选择,如果使用会报编译警告 |
@SuppressWarnings |
定义在java.lang.SuppressWarnings 中,用来指示编译器去忽略注解中声明的警告,在使用方面与@Override 、@Deprecated 不同,需要添加一个参数才能正常使用(这些参数是定义好的),例如:@SuppressWarnings(value="unchecked") |
package com.demo.annotation;
import java.util.*;
public class Test01 extends Object {
// 内置注解
// Override 重写的注解
@Override
public String toString(){
return super.toString();
}
// Deprecated 不推荐程序员使用,但是可以使用,通常是因为它很危险或者有更好的选择,如果使用会报编译警告
@Deprecated
public static void test1(){
System.out.println("Deprecated1");
}
// SuppressWarnings 用来指示编译器去忽略注解中声明的警告,需要添加一个参数才能正常使用
// all表示忽略所有警告
@SuppressWarnings("all")
public static void test2(){
// 当我们不使用list遍历时,通常会警告没有使用该变量,如果注解中加了@SuppressWarnings("all")就不会有警告
List list = new ArrayList();
}
public static void main(String[] args) {
// test1会有一个划线
test1();
}
}
@Override
、@Deprecated
、@SuppressWarnings
等,使用这些注解后编译器就会进行检查。
2.2 元注解
元注解是java API
提供的,是用于修饰其他注解的注解,通常用在注解的定义上。Java
定义了几个标准的meta-annotation
类型,用来对其他annotation
类型进行注解,定义在java.lang.annotation
中。
注解名字 | 功能描述 |
---|---|
@Target |
用于描述注解的使用范围,即:被描述的注解可以用在什么地方 |
@Retention |
表示需要在什么级别保存该注释信息,用于描述注解的生命周期,级别为:source(源代码) < class(类文件) < runtime(运行时) |
@Documented |
说明该注解将被包含在javadoc 中 |
@Inherited |
说明子类可以继承父类中的该注解 |
package com.demo.annotation;
import java.lang.annotation.*;
// 测试元注解
// 在这里使用MyAnnotation1是错误的,因为只能在方法中使用
// @MyAnnotation1
public class Test02 {
@MyAnnotation1
public void test(){
}
}
// 定义一个注解
// 元注解Target,下面是定义MyAnnotation注解只能在方法中使用
@Target(value = {ElementType.METHOD})
// 元注解Retention,下面是定义MyAnnotation注解只能在运行中有效
@Retention(value = RetentionPolicy.RUNTIME)
// 元注解Documented,下面是定义MyAnnotation注解会生成到javadoc中
@Documented
// 元注解Documented,下面是定义MyAnnotation注解可以继承父类的注解
@Inherited
@interface MyAnnotation1{
}
2.3 自定义注解
仅仅内置注解和元注解,显然并不能发挥注解的作用,更多的是我们去进行自定义注解,我们可以通过@interface
去创建一个自定义注解,并且该注解自动继承了java.lang.annotation.Annotation
接口。自定义注解格式:
// 元注解
// 这里的public可能由于类文件中已经有了public方法不能定义,所以需要根据实际情况
public @interface 注解名称{
// 属性列表
// 注解的参数,格式:参数类型 参数名() [default 默认值];
}
package com.demo.annotation;
import java.lang.annotation.*;
// 自定义注解
public class Test03 {
// 如果注解有参数,必须写参数,但是有默认值,可以不需要
@MyAnnotation2(age = 18,like = {"安全","编程"})
public void test(){}
// 不需要通过name=value的显示进行参数添加,而是直接value
@MyAnnotation3("demo")
public void test2(){}
}
// 定义一个注解2
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
// 注解的参数,格式:参数类型 参数名() [default 默认值];
String name() default "";
int age();
int id() default -1; // 如果默认值为-1,表示不存在
String[] like();
}
// 定义一个注解3
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
// 如果注解中仅仅只有value这个属性,我们可以不需要通过name=value的显示进行参数添加,而是直接value
String value();
}