注解的定义
注解本身没有任何意义,单独的注解就是一种注释,它需要结合其它如反射、插桩等技术才有意义
Java注解又称Java标注,是jdk1.5引入的一种注释机制。是元数据的一种形式,提供有关于程序但不属于程序本身的数据。注解对它们注释的代码的操作没有直接影响
- 元注解
自定义注解上的注解,下面代码里的@Target和@Retention就是元注解
@Target({ElementType.TYPE, ElementType.CONSTRUCTOR})
@Retention(RetentionPolicy.SOURCE)
public @interface TestA {
String value() default "默认值";
String id() default "默认值";
}
//使用注解,注解里面value有值时,括号里可以不填值,没有默认值的话,
//就一定要填值
@TestA("test")
// @TestA(id = "test")
// @TestA(value = "test", id = "idTest")
public class MainActivity extends AppCompatActivity {
}
- @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。下文会介绍他们不同的应用场景。
- AndroidX自带的@IntDef
@IntDef是由IDE插件实现的
public class T {
private static final int APPLE = 0;
private static final int BANANA = 1;
@Sport
private static int mFruit;
@IntDef({APPLE, BANANA}) //入参限定
@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.SOURCE)
public @interface Sport {
}
public static void main(String[] args) {
setFruit(0); // setFruit参数加了注解,这样直接传入int数字会报错
setFruit(APPLE); // 正确入参
}
private static void setFruit(@Sport int fruit) {
mFruit = fruit;
}
}
级别 | 技术 | 说明 |
---|---|---|
源码 | APT | 在编译期能够获取注解与注解声明的类包括类中所有成员信息,一般用于生成额外的辅助类 |
字节码 | 字节码增强 | 在编译出Class后,通过修改Class数据以实现修改代码逻辑目的。对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解 |
运行时 | 反射 | 在程序运行期间,通过反射技术动态获取注解与其元素,从而完成不同的逻辑判断 |
反射
一般情况下,我们使用某个类时必定知道它是什么类,是用来做什么的,并且能够获得此类的引用。于是我们直接对这个类进行实例化,之后使用这个类对象进行操作。
反射是一开始并不知道我要初始化的累对象是什么,自然也无法使用new关键字来创建对象了。这时候,我们使用JDK提供的反射API进行反射调用。反射就是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能调用它的任意方法和属性;并且能改变它的属性。是Java被视为动态语言的关键。
- Java反射机制主要提供了以下功能:
- 在运行时构造任意一个类的对象
- 在运行时获取或者修改任意一个类所具有的成员变量和方法
- 在运行时调用任意一个对象的方法(属性)
- 获得 Class 对象 获取Class对象的三种方式
- 通过类名获取 类名.class
- 通过对象获取 对象名.getClass()
- 通过全类名获取 Class.forName(全类名) classLoader.loadClass(全类名)
使用Class类的forName静态方法
public static Class<?> forName(String className)
直接获取某一个对象的class
Class<?> class = int.class;
Class<?> classInt = Integer.TYPE;
调用某个对象的getClass()方法
StringBuilder str = new StringBuilder("123");
Class<?> klass = str.getClass();
- 判断是否为某个类的实例
一般地,我们用 instanceof 关键字来判断是否为某个类的实例。同时我们也可以借助反射中 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指定Class对象,再class对象通过getConstructor()方法获取Constructor对象,通过Constructor对象newInstance()就可以创建实例对象了
Class<?> c = String.class;
Constructor constructor = c.getConstructor(String.class);
Object obj = constructor.newInstance("123");
- 获取构造器信息
- 得到构造器的方法
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 :泛型类型变量。可以泛型上下限等信息;
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()); System.out.println(valueType.getName());
// getGenericDeclaration 方法 System.out.println(keyType.getGenericDeclaration()); System.out.println(valueType.getGenericDeclaration()); // getBounds 方法
System.out.println("K 的上界:");
for (Type type : keyType.getBounds()) {
System.out.println(type);
}
System.out.println("V 的上界:");
for (Type type : valueType.getBounds()) {
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 :当需要描述的类型是泛型类的数组时,比如List[],Map[],此接口会作为Type的实现。
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元数据中。
- 反射和注解实践
通过注解和反射在initView类中进行findViewById
public class initView {
public static void init(Activity activity) {
Class<? extends Activity> cls = activity.getClass();
Field[] declaredFields = cls.getDeclaredFields();
for (Field field : declaredFields) {
// 判断是否有注解声明
if (field.isAnnotationPresent(initialization.class)) {
initialization init = field.getAnnotation(initialization.class);
// 获得注解中设置的id
int id = init.id();
View view = activity.findViewById(id);
// 设置访问权限,允许操作private的属性
field.setAccessible(true);
try {
// 反射设置 属性的值
field.set(activity, view);
} catch (IllegalAccessException e) {
e.printStackTrace();
}
}
}
}
}
注解类
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface initialization {
int id();
}
在Activity中使用
public class MainActivity extends AppCompatActivity {
@initialization(id = R.id.text1)
private TextView tv;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
initView.init(MainActivity.this);
tv.setText("hello");
}