注解
java注解(Annotation)又称java标注,jdk1.5引入的一种注释机制。
Java 语言中的类、方法、变量、参数和包等都可以被标注。和 Javadoc 不同,Java 标注可以通过反射获取标注内容。在编译器生成类文件时,标注可以被嵌入到字节码中。Java 虚拟机可以保留标注内容,在运行时可以获取到标注内容 。 当然它也支持自定义 Java 标注。
内置的注解
java定义了一套注解,共有7个,3个在java.lang中,剩下4个在java.lang.annotation中。
作用在代码的注释是:
- @Override - 检查该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。
- @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。
- @SuppressWarnings - 指示编译器去忽略注解中声明的警告。
作用在其他注解的注解(或者说 元注解)是:
- @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。
- @Documented - 标记这些注解是否包含在用户文档中。
- @Target - 标记这个注解应该是哪种 Java 成员。
- @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)
从 Java 7 开始,额外添加了 3 个注解:
- @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。
- @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。
- @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。
1. Annotation架构
从中,我们可以看出:
(1). 1个Annotation 和 1个RetentionPolicy关联。
可以理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性。
(02) 1个Annotation 和 1~n个ElementType关联。
可以理解为:对于每1个Annotation对象,可以有若干个ElementType属性。
(03) Annotation 有许多实现类,包括:Deprecated, Documented, Inherited, Override等等。
Annotation 的每一个实现类,都“和1个RetentionPolicy关联”并且“和1~n个ElementType关联”。
下面,我先介绍框架图的左半边(如下图),即Annotation, RetentionPolicy, ElementType;然后在就Annotation的实现类进行举例说明。
第2部分 Annotation组成部分
1 annotation组成成分
java annotation 的组成中,有3个非常重要的主干类。它们分别是:
(01) Annotation.java
package java.lang.annotation; public interface Annotation { boolean equals(Object obj); int hashCode(); String toString(); Class<? extends Annotation> annotationType(); }
(02) ElementType.java
package java.lang.annotation; public enum ElementType { TYPE, /* 类、接口(包括注释类型)或枚举声明 */ FIELD, /* 字段声明(包括枚举常量) */ METHOD, /* 方法声明 */ PARAMETER, /* 参数声明 */ CONSTRUCTOR, /* 构造方法声明 */ LOCAL_VARIABLE, /* 局部变量声明 */ ANNOTATION_TYPE, /* 注释类型声明 */ PACKAGE /* 包声明 */ }
(03) RetentionPolicy.java
package java.lang.annotation; public enum RetentionPolicy { SOURCE, /* Annotation信息仅存在于编译器处理期间,编译器处理完之后就没有该Annotation信息了 */ CLASS, /* 编译器将Annotation存储于类对应的.class文件中。默认行为 */ RUNTIME /* 编译器将Annotation存储于class文件中,并且可由JVM读入 */ }
说明:
(01) Annotation 就是个接口。
“每1个Annotation” 都与 “1个RetentionPolicy”关联,并且与 “1~n个ElementType”关联。可以通俗的理解为:每1个Annotation对象,都会有唯一的RetentionPolicy属性;至于ElementType属性,则有1~n个。
(02) ElementType 是Enum枚举类型,它用来指定Annotation的类型。
“每1个Annotation” 都与 “1~n个ElementType”关联。当Annotation与某个ElementType关联时,就意味着:Annotation有了某种用途。
例如,若一个Annotation对象是METHOD类型,则该Annotation只能用来修饰方法。
(03) RetentionPolicy 是Enum枚举类型,它用来指定Annotation的策略。
通俗点说,就是不同RetentionPolicy类型的Annotation的作用域不同。
“每1个Annotation” 都与 “1个RetentionPolicy”关联。
a) 若Annotation的类型为 SOURCE,则意味着:Annotation仅存在于编译器处理期间,编译器处理完之后,该Annotation就没用了。
例如,“ @Override ”标志就是一个Annotation。当它修饰一个方法的时候,就意味着该方法覆盖父类的方法;并且在编译期间会进行语法检查!编译器处理完后,“@Override”就没有任何作用了。
b) 若Annotation的类型为 CLASS,则意味着:编译器将Annotation存储于类对应的.class文件中,它是Annotation的默认行为。
c) 若Annotation的类型为 RUNTIME,则意味着:编译器将Annotation存储于class文件中,并且可由JVM读入。
这时,只需要记住“每1个Annotation” 都与 “1个RetentionPolicy”关联,并且与 “1~n个ElementType”关联。学完后面的内容之后,再回头看这些内容,会更容易理解。
第3部分 java自带的Annotation
理解了上面的3个类的作用之后,我们接下来可以讲解Annotation实现类的语法定义了。
1 Annotation通用定义
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation1 {
}
说明:
上面的作用是定义一个Annotation,它的名字是MyAnnotation1。定义了MyAnnotation1之后,我们可以在代码中通过“@MyAnnotation1”来使用它。
其它的,@Documented, @Target, @Retention, @interface都是来修饰MyAnnotation1的。下面分别说说它们的含义:
(01) @interface
使用@interface定义注解时,意味着它实现了java.lang.annotation.Annotation接口,即该注解就是一个Annotation。
定义Annotation时,@interface是必须的。
注意:它和我们通常的implemented实现接口的方法不同。Annotation接口的实现细节都由编译器完成。通过@interface定义注解后,该注解不能继承其他的注解或接口。
(02) @Documented
类和方法的Annotation在缺省情况下是不出现在javadoc中的。如果使用@Documented修饰该Annotation,则表示它可以出现在javadoc中。
定义Annotation时,@Documented可有可无;若没有定义,则Annotation不会出现在javadoc中。
(03) @Target(ElementType.TYPE)
前面我们说过,ElementType 是Annotation的类型属性。而@Target的作用,就是来指定Annotation的类型属性。
@Target(ElementType.TYPE) 的意思就是指定该Annotation的类型是ElementType.TYPE。这就意味着,MyAnnotation1是来修饰“类、接口(包括注释类型)或枚举声明”的注解。
定义Annotation时,@Target可有可无。若有@Target,则该Annotation只能用于它所指定的地方;若没有@Target,则该Annotation可以用于任何地方。
(04) @Retention(RetentionPolicy.RUNTIME)
前面我们说过,RetentionPolicy 是Annotation的策略属性,而@Retention的作用,就是指定Annotation的策略属性。
@Retention(RetentionPolicy.RUNTIME) 的意思就是指定该Annotation的策略是RetentionPolicy.RUNTIME。这就意味着,编译器会将该Annotation信息保留在.class文件中,并且能被虚拟机读取。
定义Annotation时,@Retention可有可无。若没有@Retention,则默认是RetentionPolicy.CLASS。
2 java自带的Annotation
通过上面的示例,我们能理解:@interface用来声明Annotation,@Documented用来表示该Annotation是否会出现在javadoc中, @Target用来指定Annotation的类型,@Retention用来指定Annotation的策略。
理解这一点之后,我们就很容易理解java中自带的Annotation的实现类,即Annotation架构图的右半边。如下图:
java 常用的Annotation:
@Deprecated -- @Deprecated 所标注内容,不再被建议使用。
@Override -- @Override 只能标注方法,表示该方法覆盖父类中的方法。
@Documented -- @Documented 所标注内容,可以出现在javadoc中。
@Inherited -- @Inherited只能被用来标注“Annotation类型”,它所标注的Annotation具有继承性。
@Retention -- @Retention只能被用来标注“Annotation类型”,而且它被用来指定Annotation的RetentionPolicy属性。
@Target -- @Target只能被用来标注“Annotation类型”,而且它被用来指定Annotation的ElementType属性。
@SuppressWarnings -- @SuppressWarnings 所标注内容产生的警告,编译器会对这些警告保持静默。
@FunctionalInterface -- 函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。
函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。
3. 元注解
简述:元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其他的注解上面。
种类:@Retention、@Documented、@Target、@Inherited、@Repeatable 5种。
种类叙述:
1. @Retention:
Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。
它的取值如下:
- RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
- RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。
- RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。
2. @Documented
顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
3. @Target
Target 是目标的意思,@Target 指定了注解运用的地方。
@Target 有下面的取值:
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
4. @Inherited
Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。子类继承父类的注解。
5. @Repeatable
容器注解:就是用来存放其它注解的地方。它本身也是一个注解。
按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。
可以理解为一个人有多种身份。
4、Annotation 的作用
Annotation 是一个辅助类,它在 Junit、Struts、Spring 等工具框架中被广泛使用。
我们在编程中经常会使用到的 Annotation 作用有:
1) 编译检查
Annotation 具有"让编译器进行编译检查的作用"。
例如,@SuppressWarnings, @Deprecated 和 @Override 都具有编译检查作用。
@Deprecated
这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
@Override
这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法则意味着该方法会覆盖父类中的同名方法。如果有方法被 @Override 标示,但父类中却没有"被 @Override 标注"的同名方法,则编译器会报错。
@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。
2) 在反射中使用Annotation
在反射的 Class, Method, Field 等函数中,有许多于 Annotation 相关的接口。
3) 根据Annotation生成帮助文档
通过给Annotation注解加上@Documented标签,能使该Annotation标签出现在javadoc中。
4) 能够帮忙查看查看代码
通过@Override, @Deprecated等,我们能很方便的了解程序的大致结构。
原文:https://www.cnblogs.com/skywang12345/p/3344137.html
反射
要想解剖一个类,必须先要获取到该类的字节码文件对象。而解剖使用的就是Class类中的方法。所以先要获取到每一个字节码文件对应的Class类型的对象.。
反射就是把Java类中的各种成分映射成一个个的Java对象。
例如:
一个类有:成员变量、方法、构造方法、包等等信息,利用反射技术可以对一个类进行解剖,把各个组成部分映射成一个个对象。
(其实:一个类中这些成员方法、构造方法,在加入类中都有一个类来描述)
如图是类的正常加载过程:反射的原理在于class对象。
熟悉一下加载的时候:Class对象的由来是将class文件读入内存,并为之创建一个Class对象。
反射机制提供的功能
- 在运行时判断任意一个对象所属的类。
- 在运行时构造任意一个类的对象。
- 在运行时判断任意一个类所具有的成员变量和方法。
- 在运行时调用任意一个对象的成员变量和方法。
- 生成动态代理。
反射相关的主要API
- java.lang.Class: 代表一个类
- java.lang.reflect.Method:代表类的方法。
- java.lang.reflect.Field:代表类的成员变量。
- java.lang.reflect.Constructor: 代表类的构造方法。
- ......
反射的使用
创建对象
两种方式:
一、通过Class对象的newInstance()方法创建对应的对象,要求对应类有默认构造器。
二、先使用Class对象的Constructor对象,再调用Constructor对象的newInstance()方法来创建该Class对象对应的类的实例。可以选择构造器进行创建实例。
>获取该类的Class对象
>利用Class对象的getConstructor()方法获取指定构造器
>调用Constructor的newInstance()方法来创建java对象。
例:
第一种:Class c=Person.class;
Person p=c.newInstance();
第二种:Class c=Class.forName("com.text.Person");
Constructor con=c.getConstructor();
Person p=con.newInstance();
调用方法
获取方法的方式:
Class c=Person.class;//得到Class对象
Method m1=c.getMethod();//通过Class对象的getMethod方法获取对应方法
// Method[] ms=c.getMethods();//这是返回所有方法的数组。
每一个Method对象都对应一个invoke()方法。
Object invoke(Object obj,Object...args): 该方法中的obj是执行该方法的主调,后面的args是执行该方法时传入该方法的实参。
访问成员变量的值
获取属性的方式:Class c=Person.class
Field f=c.getField(); //获取指定成员变量,public修饰的成员变量。
Field[] fs=c.getFields();//获取全部成员变量,public修饰的成员变量。
注意:getDeclaredField()可以获取所有属性值
>getXxx(Object obj): 获取obj对象的该成员变量的值。
>setXxx(Object obj,Xxx val): 将obj的成员变量的值设置成val值。此处的Xxx对应8种基本类型,如果该变量是引用类型,则取消set后面的Xxx.
关于Class对象的信息操作
获得Class对象
1.Class.forName(String className);
Class c=Class.forName("com.text.Person");
2.类名.Class
Class c=Person.Class;
3.对象.getClass()
Person p=new Person();
Class c=p.getClass();
获取Class类对应所包含的构造器
- Connstructor<T> getConnstructor(Class<?>...parameterTypes): 返回此Class对象对应类的、带指定形参列表的public构造器。
- Connstructor<?>[] getConnstructors(): 返回此Class对象对应类的所有public构造器。
- Connstructor<T> getDeclaredConnstructor(Class<?>...parameterTypes): 返回此Class对象对应类的、带指定形参列表的构造器,与构造器访问权限无关。
- Connstructor<?>[] getDeclaredConnstructors(): 返回此Class对象对应类的所有构造器,与构造器访问权限无关。
获取Class类对应所包含的方法
- Method getMethod(String name,Class<?>...parameterTypes):返回此Class对象对应类的、带指定参数的public方法。
- Method[] getMethods():返回此Class对象对应类所有的public方法。
- Method getDeclaredMethods(String name,Class<?>...parameterTypes):返回此Class对象对应类的、带指定参数的方法,与访问权限无关。
- Method[] getDeclaredMethods():返回此Class对象对应类所有方法,与访问权限无关。
访问Class类对应所包含的成员变量
- Field getField(String name): 返回Class对象对应类的、指定名称的public成员变量。
- Field[] getFields(): 返回Class对象对应类所有的public成员变量。
- Field getDeclaredField(String name): 返回Class对象对应类的、指定名称的成员变量,与访问权限无关。
- Field[] getDeclaredFields(): 返回Class对象对应类的所有成员变量,与访问权限无关。
返回修饰符、所在包、类名等信息
- Field[] getDeclaredFields(): 返回Class对象对应类的所有成员变量,与访问权限无关。
- int getModifiers():返回类或接口的所有修饰符。
- Package getPackage(): 获取此类包。
- String getName(): 返回Class对象所表示的类名称。
- String getSimpleName(): 返回Class对象所表示的类的简称
判断是否为接口、枚举、注解类
- boolean isAnnotation():返回是否是注解类型
- boolean isAnnotationPresent(Class<? extends Annotation> annotationClass):判断Class对象是否用了Annotation修饰。
- boolean isAnnoymousClass(): 是否为匿名类。
- boolean isArray(): 是否为数组类
- boolean isEnum() : Class对象是否表示一个枚举
- boolean isInterface(): Class对象是否是一个接口。
- boolean isInstance(Object obj): 判断obj是否此Class对象的实例,该方法可以完全代替instanceof操作符。