java注解
什么是注解
注解(Annotation)是从JDK5.0开始引入的新技术。
- 注解的格式:
@注解名
,例如最常见的@Override
,还可以添加一些参数值,例如@SuppressWarnings(value="unchecked")
- 注解的作用:其不是程序本身,可以对程序作出解释,可以被其他程序(如编译器等)读取。
- 注解的使用场景:可以附加在package,class,method,field等上面,相对于给他们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问。
常见的内置注解
Override
定义在java.lang.Override中,此注释只适用于修辞方法,表示一个方法声明打算重写父类中的另一个方法声明。例如
@Override
public String toString() {
return super.toString();
}
Deprecated
定义在java.lang.Deprecated中,此注释可以用于修辞方法,属性,类,表示不推荐程序员使用这个的元素,通常是因为它很危险或者存在更好的选择。
SuppressWarnings
定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息。与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的,我们选择使用即可,例如
@SuppressWarnings("all")
表示忽略所有警告,详细的参数列表可以看https://blog.csdn.net/u012994320/article/details/83083392
元注解
元注解的作用就是负责注解其他注解, Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明
-
Target:指明了修饰的这个注解的使用范围,即被描述的注解可以用在哪里。
其有一个ElementType数组参数,常用取值如下
- TYPE:类,接口或者枚举
- FIELD:域,包含枚举常量
- METHOD:方法
- PARAMETER:参数
- CONSTRUCTOR:构造方法
- LOCAL_VARIABLE:局部变量
- ANNOTATION_TYPE:注解类型
- PACKAGE:包
例如
@Target({ElementType.FIELD, ElementType.METHOD})
-
Retention:
功能:指明修饰的注解的生存周期,即会保留到哪个阶段。
RetentionPolicy的取值包含以下三种:
- SOURCE:源码级别保留,编译后即丢弃。
- CLASS:编译级别保留,编译后的class文件中存在,在jvm运行时丢弃,这是默认值。
- RUNTIME: 运行级别保留,编译后的class文件中存在,在jvm运行时保留,可以被反射调用。
阶段范围大小:RUNTIME>CLASS>SOURCE,一般我们都用RUNTIME
-
Documented:
功能:指明修饰的注解,可以被例如javadoc此类的工具文档化,只负责标记,没有成员取值。
-
Inherited:
功能:允许子类继承父类中的注解。
其中Target和Retention是必须的
自定义注解
使用@interface
关键字声明注解,例如
public @interface MyAnnotation {}
其主要注意事项如下:
-
其中每一个方法实际上是声明了一个配置参数,方法名就是参数名,返回类型就是参数类型,参数类型只能是基本类型,Class,String,enum
例如
public @interface MyAnnotation { String value(); }
-
可以使用
defaule
来声明参数的默认值,当有默认值时,使用注解时,可以不用给该参数赋值例如
public @interface MyAnnotation { String value() default ""; }
-
如果只有一个参数,一般参数名为
value
,此时使用注解时,其参数名可以省略例如自定义注解中只有一个参数
String value();
,在使用时可以这么写@MyAnnotation("abc")
如果将不用value作为参数名,如
String name();
,则在使用时必须参数名@MyAnnotation(name = "abc")