Java注解与反射
注解定义
先来看看网上的解释:
注解是标记,也可以理解成是一种应用在类、方法、参数、属性、构造器上的特殊修饰符。注解作用有以下三种:
第一种:生成文档,常用的有@param@return等。
第二种:替代配置文件的作用,尤其是在spring等一些框架中,使用注解可以大量的减少配置文件的数量。
第三种:检查代码的格式,如@Override,标识某一个方法是否覆盖了它的父类的方法。
简单来说,Java 注解(Annotation)又称 Java 标注,是 JDK5.0 引入的一种注释机制。 注解是元数据的一种形式,提供有关于程序但 不属于 程序本身的数据。注解对它们注解的代码的操作没有直接影响。
看一个 JDK 内置注解的定义:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
注意 Annotation 接口中的描述:
The common interface extended by all annotation types
所以上述 Override 本质上可以写成:
public interface Override extends Annotation{}
注解本质上是一种特殊的注释,编译器在解析类、对象或者方法的注释时会检查某个类或者方法有没有被一些注解修饰,检查有没有注解,有的话就会处理注解
注解分为编译器已熟悉的注解类 + 我们自定义的注解类,当遇到我们自定义的注解类的时候,编译器有可能不知道怎么处理,所以会根据该注解的生命周期和对象范围来判断要不要编译进字节码文件
字节码文件:
注解声明
总结:Java 中所有的注解,默认实现 Annotation 接口,注解也就是一个继承了Annotation 接口的接口
package java.lang.annotation;
public interface Annotation{
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
注解声明与普通类 “class” 不同点在注解用 @interface 关键字,例:
public @interface XY{
}
元注解
自定义注解:
定义注解的注解,准确讲就是对 注解类型 进行注解的 注解类,定义为 meta-annotation
自定义元注解有四类:(主要用 @Target \ @Retention )
- @Target:注解的作用目标
- @Retention:注解的生命周期
- @Documented:注解是否应当被包含在 JavaDoc 文档中
- @Inherited:是否允许子类继承该注解
@Traget
@Trage 用于注解标记另一个注解,作用于限制下文注解类中可以注解的 Java 元素类型。
翻译:作用于指定注解谁,告诉编译器,你写的注解类是给方法、字段属性还是类。
定义:
@Documented
@Retention(RETENTIONpOLICY.Runtime)
@Target(ElemenType.ANNOTATION_TYPE)
public @interface Target{
ElementType[] XY();
}
赋值语句:@Target(value = {ElementType.FIELD})
注意 ElementType 是一个枚举类型,值有下列:
- ElementType.TYPE:注解作用在类、接口和枚举上
- ElementType.FIELD:用于字段或属性
- ElementType.METHOD:用于方法
- ElementType.PARAMETER:用于方法的参数
- ElementType.CONSTRUCTOR:用于构造函数
- ElementType.LOCAL_VARIABLE:用于本地局部变量
- ElementType.ANNOTATION_TYPE:用于注解
- ElementType.PACKAGE:用于包声明
@Retention
@Retention的解释是告诉编译器注解的 生命周期 ,也就是该注解可以存在到什么时候,一共有三种:
- RetentionPolicy.SOURCE - 标记的注解仅保留在源级别中,并被编译器忽略,不会写入 .class 文件
- RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留,但 Java 虚拟机( JVM)会忽略,会写入 .class 文件
- RetentionPolicy.RUNTIME - 标记的注解由 JVM 保留,因此运行时环境可以使用它,永久保存,多用于反射
- @Documented 注解修饰的注解 - 是否要保存到 JavaDox 文档中(打包时候)
- @Inherited - 该类的子类将自动继承父类的该注解
@Retention 三个值中 SOURCE < CLASS < RUNTIME,即CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS
定义:
//@Target(ElementType.TYPE) 只能在类上标记该注解
@Target({ElementType.TYPE,ElementType.FIELD}) // 允许在类与类属性上标记该注解TYPE是类,FIELD是字段或属性,
//意思就是注解只用于下面是这两种的身上,可以实一个或者多个
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中,只存在源码中,一编译就会被忽略
public @interface Lance {
}
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.ANNOTATION_TYPE)
public @interface Retention{
RetentionPolicy value();
}
赋值语句:@Retention(RetentionPolicy.SOURCE)
注意:RetentionPolicy 依然是一个枚举类型
内置三大注解:
JDK预定义注解:
- @Override
- @Deprecated
- @SuppressWarnings
@Override
定义:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
没有任何的属性,并不能存储任何其他信息。只能作用于方法之上,编译结束后丢弃
是一种典型的『标记式注解』,仅被编译器可知,编译器在对 java 文件进行编译成字节码的过程中,一旦检测到某个方法上被修饰了该注解,就会去匹对父类中是否具有一个同样方法签名的函数,如果不是,则不能通过编译
@Deprecated
定义:
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value = {CONSTRUCTOR,FIELD,LOCAL_VARIABLE,
METHOD,PACKAGE,PARAMETER,TYPE
})
public @interface Deprecated{
}
定义为标记式注册,生命周期为永久存在,作用于所有类型,用于标记当前类、方法或字段已不被推荐使用,JDK更新后就被删除
只作提醒作用,建议更新当前类型
@SuppressWarnings
@Target({TYPE,FIELD,METHOD,PATAMETER,
CONSTUCTOR,LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOUCE)
public @interface SuppressWarnings{
String[] value();
}
注意:value 要被传值,表示需要被压制的警告类型:
public static void main(String[] args)}{
Data data = new Data(2018,7,11) //过时代码
}
这段代码报错:
Warning:(8, 21) java: java.util.Date 中的 Date(int,int,int) 已过时
若是在编译器检查代码中过时方法时,你不要程序启动可使用 @SuppressWarnings 注解并给它的 value 属性传入一个参数值来压制编译器的检查
@SuppressWarning(value = "deprecated")
public static void main(String[] args) {
Date date = new Date(2018, 7, 11);
}
注解类型元素
在元注解中,允许使用注解时传递参数,也可以让自定义注解的 主体 包含 Annotation TYPE Element(注解类型元素)声明,看起来像普通的方法,可以定义可选的默认值
@Target({ElementType.TYPE,ElementType.FIELD}) @Retention(RetentionPolicy.SOURCE)
public @interface Lance {
String value(); //无默认值
int age() default 1; //有默认值
}
注意:在使用注解时,如果定义的注解中的类型元素无默认值,则必须进行传值
@HYQ("WSQ") //如果只存在value元素需要传值的情况,则可以省略:元素名=
@HYQ(value="WSQ",age = 22)
int i;
注解应用场景
SOURCE
SOURCE用于两点: IDE语法检查 + APT注解处理器
IDE语法检查:
在 Android 开发中,support - annotations 与 androidx.annotation 中均有提供 @IntDef 注解,定义如下:
@Retention(SOURCE) //源码级别注解
@Target({ANNOTATION_TYPE})
public @interface IntDef{
int[] value() default{};
boolean flag() default false;
boolean open() default false;
}
这里的support - annotations 和 androidx.annotation 是包
问题:
Java中Enum(枚举)的实质是特殊单例的静态成员变量,在运行期所有枚举类作为单例,全部加载到内存中。比常量多5到10倍的内存占用。
现在用注解取代枚举,实现像方法入参限制
定义方法 accept ,用于接受参数 why ,需要在 HYQ, WSQ 中选择一个
若是用枚举实现:
public enum{
why{ HYQ, WSQ }
}
public void accept(Teacher teacher){
}
枚举类型一个成员对象占用
12 + 成员个字节,并且同时进行8字节对齐,忒占内存
内存优化做法,不用枚举,方法定义为:
public static final int HYQ = 1;
public static final int WSQ = 2;
public void accept(int why) {
}
然而此时,调用 方法由于采用基本数据类型int,将无法进行类型限定。此时使用@IntDef增加自定义注解:
public static final int HYQ = 1;
public static final int WSQ = 2;
@IntDef(value = {MAN, WOMEN}) //限定为WSQ,HYQ
@Target(ElementType.PARAMETER) //作用于参数的注解
@Retention(RetentionPolicy.SOURCE) //注解留在源码
public @interface accept{
}
public void accept(@why int why) {
}
最后调用 test 方法,如果传递的参数不是 HYQ 或者 WSQ 的化就会显示 Inspection 警告(但编译不会报错):
想不报错修改语法检查级别就好
APT注解处理器:
来看看APT注解处理器的解释:
APT全称为:“Annotation Processor Tools”,意为注解处理器。顾名思义,其用于处理注解。编写好的Java源文件,需要经过 javac 的编译,翻译为虚拟机能够加载解析的字节码Class文件。注解处理器是 javac 自带的一个工具,用来在编译时期扫描处理注解信息。 你可以为自己写的注解注册自己的注解处理器 。 注册的注解处理器由 javac 调起,并将注解信息传递给注解处理器进行处理。
另外加多两点:
注解处理器是对注解应用最为广泛的场景。在Glide、EventBus3、Butterknifer、Tinker、ARouter等等常用
框架中都有注解处理器的身影。但是你可能会发现,这些框架中对注解的定义并不是 是 CLASS 级别,别忘了:CLASS包含了SOURCE,RUNTIME包含SOURCE、CLASS。
CLASS
定义为 CLASS 的注解,会保留在class文件中,但是会被虚拟机忽略(即无法在运行期反射获取注解)。此时完全符合此种注解的应用场景为字节码操作。如:AspectJ、热修复Roubust中应用此场景。
所谓字节码操作即为,直接修改字节码Class文件以达到修改代码执行逻辑的目的。在程序中有多处需要进行是否登录的判断。
如果我们使用普通的编程方式,需要在代码中进行 的判断,也许存在十个判断点,则需要在每个判断点加
入此项判断。此时,我们可以借助 AOP(面向切面) 编程思想,将程序中所有功能点划分为: 需要登录 与 无需登录 两种类型,即两个切面。对于切面的区分即可采用注解。
//Java源码
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.Class)
public @interface Login{
}
@Login
public void jumpA(){
startActivity(new Intent(this, AActivity.class));
}
public void jumpB(){
startActivity(new Intent(this,BActivity.class));
}
在上诉代码中, jumpA 方法需要具备登录身份。而 注解的定义被设置为 CLASS 。因此我们能够在该类所编
译的字节码中获得到方法注解 Login 。在操作字节码时,就能够根据方法是否具备该注解来修改class中该方法的
内容加入 的代码段:
//Class字节码
public void jumpA(){
if(this.isLogin){
this.startActivity(new Intent(this,LoginActivity.class));
}else{
this.startActivity(new Intent(this,AActivity.class));
}
}
public void jumpB(){
startActivity(new Intent(this,BActivity.class));
}
(注意上面是class字节码不是源码)
RUNTIME
注解保留到运行期间,大多数情况用于在运行期间结合 反射技术 获取注解中的所有信息
反射
一般情况下,我们使用某个类时必定知道它是什么类,是用来做什么的,并且能够获得此类的引用。于是我们直接对这个类进行实例化,之后使用这个类对象进行操作
反射则是一开始并 不知道 我要初始化的类对象是什么,自然也无法使用 new 关键字来创建对象了。这时候,我们使用 JDK 提供的反射 API 进行反射调用
反射就是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法
对于任意一个对象,都能够调用它的任意方法和属性
并且能改变它们的属性。是Java被视为动态语言的关键
Java反射机制主要提供了以下功能:
- 在运行时构造任意一个类的对象(构造对象)
- 在运行时获取或者修改任意一个类所具有的成员变量和方法(修改值)
- 在运行时调用任意一个对象的方法 / 属性 (调用方法)
什么是反射和什么是反射Class
反射始于Class,Class是一个类,封装了当前对象 所对应的类的信息。一个类中有属性,方法,构造器等
比如说有一个Person类,一个Order类,一个Book类,这些都是不同的类,现在需要再一个类,用来描述类,这就是Class,它应该也有类名,属性,方法,构造器等。也就是:Class是用来描述类的类!
Class(试着看成是个别名)
引用一下:
Class类是一个对象照镜子的结果,对象可以看到自己有哪些属性,方法,构造器,实现了哪些接口等等。对于每个普通类而言,JRE 都为其保留一个不变的 Class 类型的对象。一个 Class 对象包含了特定某个类的有关信息。 对象只能由系统建立对象,一个类(而不是一个对象)在 JVM 中只会有一个Class实例(这一段我也看不懂)
获取class对象
获取Class对象的三种方式
1. | 通过类名获取 | 类名.class | |
---|---|---|---|
2. | 通过对象获取 | 对象名.getClass() | |
3. | 通过全类名获取 | Class.forName(全类名) | classLoader.loadClass(全类名) |
- 使用 Class 类的 forName 静态方法:
public static Class<?> forName(String className)
- 直接获取某一个对象的 class
Class<?> class = int.class;
Class<?> classInt = Integer.TYPE;
- 调用某个对象的 getClass() 方法
String Builder str = new String Builder("123");
Class<?> class = str.getClass();
判断是否为某个类的实例
一般地,我们用 关键字来判断是否为某个类的实例。同时我们也可以借助反射中 Class 对象的 isInstance() 方法来判断是否为某个类的实例,它是一个 native 方法:
public native boolean isInstance(Object obj);
判断是否为某个类的类型
public boolean isAssignableFrom(Class<?> cls)
创建实例
利用反射技术实现创建对象有两种方法:
- 使用Class对象的newInstance()方法来创建Class对象对应类的实例。
Class<?> c = String.class;
Object str = c.newInstance();
- 先通过Class对象获取指定的Constructor对象,再调用Constructor对象的newInstance()方法来创建实例。这种方法可以用指定的构造器构造类的实例
//获取 String 所对应的 Class 对象
Class<?> c = String.class;
//获取String类带一个String参数的构造器
Constructor constructor = c.getConstructor(String.class);
//根据构造器创建实例
Object obj = constructor.newInstance("123");
System.out.println(obj);
获取构造器信息
得到构造器的方法
Constructor getConstructor(Class[] params) – 获得使用特殊的参数类型的public构造函数(包括父类)
Constructor[] getConstructors() – 获得类的所有公共构造函数
Constructor getDeclaredConstructor(Class[] params) – 获得使用特定参数类型的构造函数(包括私有) Constructor[] getDeclaredConstructors() – 获得类的所有构造函数(与接入级别无关)
获取类构造器的用法与上述获取方法的用法类似。主要是通过Class类的getConstructor方法得到Constructor类的 一个实例,而Constructor类有一个newInstance方法可以创建一个对象实例:
public T newInstance(Object ... initargs)
获取类的成员变量
获得字段信息的方法
Field getField(String name) – 获得命名的公共字段
Field[] getFields() – 获得类的所有公共字段
Field getDeclaredField(String name) – 获得类声明的命名的字段
Field[] getDeclaredFields() – 获得类声明的所有字段
调用方法
获得方法信息的方法
Method getMethod(String name, Class[] params) – 使用特定的参数类型,获得命名的公共方法
Method[] getMethods() – 获得类的所有公共方法
Method getDeclaredMethod(String name, Class[] params) – 使用特写的参数类型,获得类声明的命名的方法
Method[] getDeclaredMethods() – 获得类声明的所有方法
从类中获取了一个方法后,我们就可以用 incoke() 方法来调用这个方法。
invoke() 方法的原型为:
public Object invoke(Object obj, Object... args)
利用反射创建数组
数组在Java里是比较特殊的一种类型,它可以赋值给一个Object Reference 其中的Array类为
java.lang.reflect.Array类。我们通过**Array.newInstance()**创建数组对象,它的原型是:
public static Object newInstance(Class<?> componentType, int length);
反射获取泛型真实类型
当我们对一个泛型类进行反射时,需要得到泛型中的真实数据类型,来完成如 json 反序列化的操作。此时需要通过 Type 体系来完成。
TypeVariable 接口包含了一个实现类 (Class) 和四个实现接口,他们分别是:
-
TypeVariable
泛型类型变量。可以泛型上下限等信息 -
ParameterizedType
具体的泛型类型,可以获得元数据中泛型签名类型(泛型真实类型) -
GenericArrayType
当需要描述的类型是泛型类的数组时,比如List[],Map[],此接口会作为Type的实现 -
WildcardType
通配符泛型,获得上下限信息
TypeVariable
public class TestType <K extends Comparable & Serializable, V>
{ K key;
V value;
public static void main(String[] args) throws Exception {
// 获取字段的类型
Field fk = TestType.class.getDeclaredField("key");
Field fv = TestType.class.getDeclaredField("value");
TypeVariable keyType = (TypeVariable)fk.getGenericType();
TypeVariable valueType = (TypeVariable)fv.getGenericType();
// getName 方 法
System.out.println(keyType.getName()); // K
System.out.println(valueType.getName()); // V
// getGenericDeclaration 方 法
System.out.println(keyType.getGenericDeclaration()); // class com.test.TestType
System.out.println(valueType.getGenericDeclaration()); // class com.test.TestType
// getBounds 方 法
System.out.println("K 的上界:"); // 有两个
for (Type type : keyType.getBounds()) { // interface java.lang.Comparable
System.out.println(type); // interface java.io.Serializable
}
System.out.println("V 的上界:"); // 没明确声明上界的, 默认上界是 Object
for (Type type : valueType.getBounds()) { // class java.lang.Object
System.out.println(type);
}
}
}
ParameterizedType
public class TestType {
Map<String, String> map;
public static void main(String[] args) throws Exception {
Field f =TestType.class.getDeclaredField("map");
System.out.println(f.getGenericType());
//java.util.Map<java.lang.String,java.lang.String>
ParameterizedType pType = (ParameterizedType) f.getGenericType();
System.out.println(pType.getRawType()); // interface java.util.Map
for (Type type : pType.getActualTypeArguments()) {
System.out.println(type); // 打印两遍: class java.lang.String
}
}
}
GenericArrayType
public class TestType<T> {
List<String>[] lists;
public static void main(String[] args) throws Exception {
Field f = TestType.class.getDeclaredField("lists");
GenericArrayType genericType = (GenericArrayType) f.getGenericType();
System.out.println(genericType.getGenericComponentType());
}
}
WildcardType
public class TestType {
private List<? extends Number> a; // 上 限
private List<? super String> b; //下限
public static void main(String[] args) throws Exception {
Field fieldA = TestType.class.getDeclaredField("a");
Field fieldB = TestType.class.getDeclaredField("b");
// 先拿到范型类型
ParameterizedType pTypeA = (ParameterizedType) fieldA.getGenericType();
ParameterizedType pTypeB = (ParameterizedType) fieldB.getGenericType();
// 再从范型里拿到通配符类型
WildcardType wTypeA = (WildcardType) pTypeA.getActualTypeArguments()[0];
WildcardType wTypeB = (WildcardType) pTypeB.getActualTypeArguments()[0];
// 方法测试
System.out.println(wTypeA.getUpperBounds()[0]); // class java.lang.Number
System.out.println(wTypeB.getLowerBounds()[0]); // class java.lang.String
// 看看通配符类型到底是什么, 打印结果为: ? extends java.lang.Number
System.out.println(wTypeA);
}
}
Gson反序列化
static class Response<T> {
T data; int code;
String message;
@Override
public String toString() {
return "Response{" +
"data=" + data + ", code=" + code +
", message='" + message + '\'' + '}';
}
public Response(T data, int code, String message) {
this.data = data; this.code = code; this.message = message;
}
}
static class Data { String result;
public Data(String result) { this.result = result;
}
@Override
public String toString() { return "Data{" +
"result=" + result + '}';
}
}
public static void main(String[] args) {
Response<Data> dataResponse = new Response(new Data("数据"), 1, "成功");
Gson gson = new Gson();
String json = gson.toJson(dataResponse); System.out.println(json);
//为什么TypeToken要定义为抽象类?
Response<Data> resp = gson.fromJson(
json, new TypeToken<Response<Data>>() {}.getType()
);
System.out.println(resp.data.result);
}
在进行GSON反序列化时,存在泛型时,可以借助 TypeToken 获取 Type 以完成泛型的反序列化。
TypeToken 要被定义为抽象类是因为:只有定义为抽象类或者接口,这样在使用时,需要创建对应的实现类,此时确定泛型类型,编译才能够将泛型 signature 信息记录到 Class 元数据中。
---------------郭氏王氏何氏