注解
注解(Annotation),又称元数据,一种代码级别的的说明。
即:用来解释代码。
注释:用来解释类的作用,方法使用说明等
注解的作用:
- 编写文档:根据 Annotation 生成帮助文档,即生成JavaDoc文档
- 编译检查:Annotation 具有"让编译器进行编译检查的作用"。@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用
- 代码分析:在反射中使用 Annotation 获取被注解标注的类,属性,方法等。
注解的格式
元注解:用来解释注解的注解
MyAnnotation:注解名称
@interface:它的用来修饰MyAnnotation,意味着MyAnnotation实现了 java.lang.annotation.Annotation 接口;即 MyAnnotation就是一个注解。
元注解
public @interface MyAnnotation{
}
注解的本质
使用javac将自定义的注解编程成.class文件;再使用javap将.class文件反编译成java文件。
会发现
注解的本质就是一个接口
。
public interface 注解名称 extends package java.lang.annotation.Annotation{
}
内置的注解
作用在代码的注解
-
@Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
-
@Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
-
@SuppressWarnings - 指示编译器去忽略注解中声明的警告。
-
@SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
-
@FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
-
@Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
Annotation 组成部分
Annotation
ElementType
RetentionPolicy
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
package java.lang.annotation;
public enum ElementType {
TYPE, /* 类、接口(包括注释类型)或枚举声明 */
FIELD, /* 字段声明(包括枚举常量) */
METHOD, /* 方法声明 */
PARAMETER, /* 参数声明 */
CONSTRUCTOR, /* 构造方法声明 */
LOCAL_VARIABLE, /* 局部变量声明 */
ANNOTATION_TYPE, /* 注释类型声明 */
PACKAGE /* 包声明 */
}
package java.lang.annotation;
public enum RetentionPolicy {
SOURCE, /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了 */
CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */
RUNTIME /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */
}
元注解
作用在其他注解的注解
- @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- @Documented - 标记这些注解是否包含在用户文档中。
- @Target - 标记这个注解应该是哪种 Java 成员。
- @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
自定义注解
接口定义抽象方法返回结果必须是如下类型:
- 基本数据类型
- String类型
- 枚举类型
- 注解
- 以上类型的数组类型
public enum Family {
FATHER,
MOTHER;
}
/**
* 自定义注解 多个参数
* @author lingyiwin
*/
@Retention(value = RetentionPolicy.RUNTIME)
//@Target(value = ElementType.TYPE) 多个值使用{}
@Target({ElementType.TYPE, ElementType.FIELD})
public @interface MyAnnotationMorArgument {
int id() default -1;
int age() default 18;
String stuName() default "";
String[] school() default {"清华","北大"};
// returnOverride方法返回一个注解
Override returnOverride();
//EnumType 返回一个Family类里面的枚举值。
Family enumType();
}
public class TestAnnotation {
@MyAnnotationMorArgument(id=19,age = 20,stuName = "张三",school = {"河大","河科大"},returnOverride = @Override,enumType = Family.FATHER)
private String testAn;
}
文章写得不尽详细,但对本人够用,详细内容可参考:https://www.cnblogs.com/skywang12345/p/3344137.html