Java高级语言特性,注解与反射
目录
- 注解
- 注解声明
- 声明一个注解类型
- 元注解
- 注解类型元素
- 注解应用场景
- SOURCE
- IDE语法检测
- APT注解处理器
- CLASS
- RUNTIME
- 反射
- 获得Class对象
- 判断是否为某个类的实例
- 创建实例
- 获取构造器信息
- 获取类的成员变量(字段)信息
- 调用方法
- 利用反射创建数组
- 反射获取泛型真实类型
- TypeVariable
- ParamterizedType
- GenericArrayType
- WildcardType
- Gson反序列化
- 通过自定义注解与反射实现页面跳转的参数注入
注解
Java注解(Annotation)又称为Java标注,是JDK5.0引入的一种注释机制。注解是元数据的一种形式,提供有关于程序但不属于程序本身的数据。注解对他们注解的代码操作没有直接影响。
注解声明
声明一个注解类型
package java.lang.annotation;public interface Annotation {boolean equals(Object obj);int hashCode();String toString();Class<? extends Annotation> annotationType();
}
与声明一个class不同的是,注解的声明使用@interface关键字。一个注解的声明如下:
public @interface test{
}
元注解
在定义注解时,注解类也能够使用其他的注解声明。对注解类型进行注解的注解类。我们称为meta-annotation(元注解)。一般的,我们在定义注解时,需要指定的元注解有两个:
另外还有@Documented和@Inherited元注解,前者用于被javadoc工具提取成文档,后者表示允许子类继承父类中定义的注解。
@Target
注解标记另一个注解,以限制可以应用注解的Java元素类型。目标注解指定以下元素类型之一作为其值:
ElementType.ANNOTATION_TYPE 可以应用于注解类型。
ElementType.CONSTRUCTOR 可以应用于构造函数。
ElementType.FIELD可以应用于字段或属性。
ElementType.LOCAL_VARIABLE 可以应用于局部变量。
ElementType.METHOD可以应用于方法级注解。
ElementType.PACKAGE 可以应用于包声明。
ElementType.PARAMETER可以应用于方法的参数。
ElementType.TYPE 可以应用于类的任何元素。
@Retention
注解指定标记注解的存储方式:
- RetentionPolicy.SOURCE - 标记的注解仅保留在源码级别中,并被编译期忽略。
- RetentionPolicy.CLASS - 标记的注解在编译时由编译器保留,但Java虚拟机(JVM)会忽略。
- RetentionPolicy.RUNTIME - 标记的注解由JVM保留,因此运行时环境可以使用它
@Retention三个值中SOURCE< CLASS <RUNTIME,即CLASS包含了SOURCE,RUNTIME包含了SOURCE、CLASS。
@Target({ElementType.TYPE,ElementType.FIELD}) //允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface Test {
}
注解类型元素
在上文元注解中,允许在使用注解时传递参数。我们也可以让自定义注解的主体包含annotation type element(注解类型元素)声明,他们看起来很像方法,可以自定义可选的默认值。
@Target({ElementType.TYPE,ElementType.FIELD}) //允许在类与类属性上标记该注解
@Retention(RetentionPolicy.SOURCE) //注解保留在源码中
public @interface Test {String value(); //无默认值int age() default 1 ; //有默认值
}
在使用注解时,如果定义的注解中的类型元素无默认值,则必须进行传值。
@Test("test")val i : Int = 0;
@Test("test", age = 100)val i : Int = 0;
注解应用场景
按照@Retention元注解定义的注解存储方式,注解可以被三种场景下使用:
SOURCE
RetentionPolicy.SOURCE,作用于源码级别的注解,可提供给IDE语法检查、APT等场景使用。
在类中使用SOURCE级别的注解,其编译之后的class中会被丢弃。
@Test(value = "11112323123")
public class JavaClass {
}
生成的class没有注解信息
// class version 61.0 (61)
// access flags 0x21
public class com/example/test/nestedscroll/JavaClass {// compiled from: JavaClass.java// access flags 0x1public <init>()VL0LINENUMBER 4 L0ALOAD 0INVOKESPECIAL java/lang/Object.<init> ()VRETURNL1LOCALVARIABLE this Lcom/example/test/nestedscroll/JavaClass; L0 L1 0MAXSTACK = 1MAXLOCALS = 1
}
IDE语法检测
在Android开发中,support-annotations与androidx.annotation中都有提供@IntDef注解,此注解的定义如下:
@Retention(AnnotationRetention.SOURCE)
@Target(AnnotationTarget.ANNOTATION_CLASS)
public annotation class IntDef(/** Defines the allowed constants for this element */vararg val value: Int = [],/** Defines whether the constants can be used as a flag, or just as an enum (the default) */val flag: Boolean = false,/*** Whether any other values are allowed. Normally this is not the case, but this allows you to* specify a set of expected constants, which helps code completion in the IDE and documentation* generation and so on, but without flagging compilation warnings if other values are* specified.*/val open: Boolean = false
)
Java中的Enum(枚举)的实质是特殊的单例和静态成员变量,在运行期间所有枚举类作为单例,全部加载到内存中。比常量多5到10倍的内存占用。
而注解的意义在于能够取代枚举,实现如方法入参限制。
比如我们定义方法test,此方法接受Fruit,需要在Apple和Banana中选择一个。如果使用枚举实现为:
public enum Fruit{
Apple,Banana
}
public void test(Fruit fruit){
}
而现在为了进行内存优化,我们现在不再使用枚举,则方法定义为:
public static final int APPLE = 1;
public static final int BANANA = 2;
public void test(int Fruit){
}
调用test方法由于采用基本数据类型int,将无法进行类型限定。此时使用@IntDef增加自定义注解:
}
@IntDef(value ={MAN,WOMEN))//限定为LANCE,ALVIN
@Target(ElementType.PARAMETER)//作用于参数的注解
@Retention(RetentionPolicy.SOURCE)//源码级别注解
public@interface Fruit{
public void test(@Fruit int fruit){
}
public static final int APPLE= 1;
public static final int BANANA= 2;
这个时候如果再去调用test方法,如果传递的参数不是APPLE或BANANA,则会显示Inspection警告,编译是不会报错。
可以修改语法检查的等级
以上注解为SOURCE级别,本身IDEA/AS就是由java开发的,工具实现了对java语法的检查,借助注解能对注解的特定语法进行额外的检查。
APT注解处理器
APT全称为:“Anotation Processor Tools” 注解处理器。用于处理注解。编写好的java源文件,需要经过javac的编译,翻译为虚拟机能够解析的字节码Class文件。注解处理器是javac自带的一个工具,用来在编译时期扫描处理注解信息。你可以为某些注解注册自己的注解处理器。注解的注解处理器由javac调起,并将注解信息传递给注解处理器进行处理。
例如:
TestProcessor.java
//可以限制处理的注解
@SupportedAnnotationTypes("com.example.test.nestedscroll.Test")
@SupportedSourceVersion(SourceVersion.RELEASE_17)
public class TestProcessor extends AbstractProcessor {@Overridepublic boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {Messager messager = processingEnv.getMessager();messager.printMessage(Diagnostic.Kind.NOTE,"log some");return false;}
}
javax.annotation.processing.Processor用于注册处理器
内容:
com.example.compiler.TestProcessor
这个java SPI机制,告诉编译期“有哪些处理器”
这样在app模块里写一个类引用对应com.example.test.nestedscroll.Test的注解
@Test(value = "11")
public class JavaClass {public static final int APPLE = 1;public static final int BANANA = 2;public static void test(@Fruit int Fruit){System.out.println();}public static void main(String[] args) {test(3);}}
Gradle在执行javac解析要编译的java类,会执行对应的注解处理程序。
APT:Annotation Processor Tools 运行在编译阶段
.java -> javac -> .class
javac采集到所有的注解信息 -> 包装成Element节点 ->由javac调其注解处理程序。
所以注解处理程序不是我们手动调用的,而是javac帮我们调用的
javac在编译之前会调用我们的注解处理程序,执行完我们的注解处理程序,才会去将.java文件编译成.class文件
为什么注解Source级别可以给注解处理程序使用?
因为Source级别注解只保留在源码级别,而javac就是要解析.java源码,然后运行注解处理程序。
所有只需要保留到source级别就可以给APT使用,APT一般用于生成额外的辅助类。
CLASS
定义为CLASS的注解,会保留在class文件中,但是会被虚拟机忽略,无法在运行期反射获取注解。此时符合的应用场景为字节码操作。
字节码操作即,直接修改字节码Class文件以达到修改代码执行逻辑的目的。
比如在程序中有多处需要进行是否登录的判断,会判断是否登录,如果已登录则通过验证走其他逻辑,如果未登录,则进入登录。
如果我们使用普通的编程方式,需要在代码中进行if else的判断,也许存在10多个判断点,则需要每个判断点加入此项判断,此时,可以借助AOP(面向切面)编程思想,将程序中所有功能点划分为:需要登录与无需登录两种类型,即两个切面,对于切面的区分即可采用注解。
@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方法需要具备登录身份。而Login注解的定义被设置为CLASS。因此我们能够在该类所编译的字节码中获得方法注解Login。在操作字节码时,就能够根据方法是否具备该注解来修改class中该方法的内容加入if-else的代码段:
//Class字节码
@Login
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));
}
注解能够设置类型元素(参数),结合参数能实现更为丰富的场景,如:运行期权限判断等。
RUNTIME
注解保留至运行期,意味着我们能够在运行期间结合反射技术获取注解中的所有信息。
反射
一般情况下,我们使用某个类时必定知道它是什么类,是用来做什么的,并且能够获得此类的引用。于是我们直接对这个类进行实例化,之后使用这个类对象进行操作。
反射则是一开始并不知道我要初始化的类对象是什么,自然也无法使用new关键字来创建对象了。这时候,我们使用JDK提供的反射API进行反射调用。反射就是在运行状态中,对于任意一个类,都能知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意方法和属性;并且能改变它的属性。
Java反射机制主要提供了以下功能:
- 在运行时构造任意一个类的对象
- 在运行时获取或修改任意一个类所具有的成员变量和方法
- 在运行时调用任意一个对象的方法(属性)
反射始于Class,Class是一个类,封装了当前对象所对应的类的信息。一个类中有属性,方法,构造器等,比如说有一个Person类,一个Order类,一个Book类,这些都是不同的类,现在需要一个类,用来描述类,这就是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<?> klass = int.class;
Class<?> classInt = Interger.TYPE
- 调用某个对象的getClass()方法
StringBuilder str = new StringBuilder("123");
Class<?> klass = str.getClass();
判断是否为某个类的实例
我们用instanceof关键字来判断是否为某个类的实例。同时我们也可以借助反射中Class对象的isInstance()方法来判断是否为某个类的实例,它是一个native方法:
public native boolean isInstance(Object obj);
判断是否为某个类的类型
public boolean isAssignableForm(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("2223");
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()--获得类声明的所有方法
当我们从类中获取了一个方法后,我们就可以用invoke()方法来调用这个方法。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体系来完成。Type接口包含了一个实现类(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{d
//获取字段的类型
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);
}
ParamterizedType
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()[e];
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反序列化
public class TestClass {static class Response<T> {T data;int code;String message;@NonNull@Overridepublic String toString() {return "";}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;}@Overridepublic String toString() {return "";}}static class TypeRefrence<T> {Type type;public TypeRefrence() {//获得泛型类型Type genericSuperClass = getClass().getGenericSuperclass();ParameterizedType parameterizedType = (ParameterizedType) genericSuperClass;//因为类泛型可以定以多个 A<T,E,F...>所有是个数组Type[] actualTypeArguments= parameterizedType.getActualTypeArguments();type = actualTypeArguments[0];}public Type getType(){return type;}}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元数据中。
这也是为什么源码里构造方法设置为protect,如果在不同的包下面的话会默认让你加花括号{},代表是匿名内部类,创建一个匿名内部类的实例对象,如果没有{}花括号,就是创建一个实例对象。
实现一个简单的TypeRefrence
public class TestClass {static class Response<T> {T data;int code;String message;@NonNull@Overridepublic String toString() {return "";}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;}@Overridepublic String toString() {return "";}}static class TypeRefrence<T> {Type type;public TypeRefrence() {//获得泛型类型Type genericSuperClass = getClass().getGenericSuperclass();ParameterizedType parameterizedType = (ParameterizedType) genericSuperClass;//因为类泛型可以定以多个 A<T,E,F...>所有是个数组Type[] actualTypeArguments= parameterizedType.getActualTypeArguments();type = actualTypeArguments[0];}public Type getType(){return type;}}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);Type type = new TypeRefrence<Response<Data>>().getType();System.out.println(type);Response<Data> response = gson.fromJson(json,type);System.out.println(response.data.getClass());}}
当没有使用花括号的时候,观察生成的class文件可以看到泛型T会被擦除为Object类型
而使用花括号
public class TestClass {static class Response<T> {T data;int code;String message;@NonNull@Overridepublic String toString() {return "";}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;}@Overridepublic String toString() {return "";}}static class TypeRefrence<T> {Type type;public TypeRefrence() {//获得泛型类型Type genericSuperClass = getClass().getGenericSuperclass();ParameterizedType parameterizedType = (ParameterizedType) genericSuperClass;//因为类泛型可以定以多个 A<T,E,F...>所有是个数组Type[] actualTypeArguments= parameterizedType.getActualTypeArguments();type = actualTypeArguments[0];}public Type getType(){return type;}}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);Type type = new TypeRefrence<Response<Data>>(){}.getType();System.out.println(type);Response<Data> response = gson.fromJson(json,type);System.out.println(response.data.getClass());}}
匿名内部类会确认已经有Repose< Data >这种类型,保留签名,把Reponse< Data >类型信息保留下来
通过自定义注解与反射实现页面跳转的参数注入
new Intent().putExtra("name","Lance").putExtra("boy",true); //页面跳转携带参数//跳转的页面实现参数注入
@Autowired
public String name;
@Autowired("boy")
public boolean isBoygetIntent().getStringExtra("name");//使用属性名
getIntent().getBooleanExtra("boy");//读取注解元素
public static void injectAutowired(Activity activity) {Class<? extends Activity> cls = activity.getClass();//获得数据Intent intent = activity.getIntent();Bundle extras = intent.getExtras();if (extras == null) {return;}//获得此类所有的成员Field[] declaredFields = cls.getDeclaredFields();for (Field field : declaredFields) {if (field.isAnnotationPresent(Autowired.class)) {Autowired autowired = field.getAnnotation(Autowired.class);//获得keyString key = TextUtils.isEmpty(autowired.value()) ? field.getName() : autowired.value();if (extras.containsKey(key)) {Object obj = extras.get(key);// todo Parcelable数组类型不能直接设置,其他的都可以.//获得数组单个元素类型Class<?> componentType = field.getType().getComponentType();//当前属性是数组并且是 Parcelable(子类)数组if (field.getType().isArray() &&Parcelable.class.isAssignableFrom(componentType)) {Object[] objs = (Object[]) obj;//创建对应类型的数组并由objs拷贝Object[] objects = Arrays.copyOf(objs, objs.length, (Class<? extends Object[]>) field.getType());obj = objects;}field.setAccessible(true);try {field.set(activity, obj);} catch (IllegalAccessException e) {e.printStackTrace();}}}}}