欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识！
您现在的位置是： 首页

Java学习笔记-注解与反射

程序员文章站 2024-02-16 09:39:52
...

一、注解

注解的作用或意义是什么?

注解本身没有任何意义,单独的注解就是一种注释,它需要结合其他如反射、插桩等技术才有意义。

Java注解(Annotation)又称作Java标注，是JDK1.5引入的一种注释机制。是元数据的一种形式，提供有关程序但不属于程序本身的数据。注解对它们注解的代码的操作没有直接影响。

元注解

在定义注解时,注解类也能够使用其他的注解声明.对注解类型进行注解的注解类,称之为meta-annotation(元注解)。声明的注解运行作用于哪些节点使用@Target声明；保留级别由@Retention声明。其中保留级别如下：

  • RetentionRolicy.SOURCE

    标记的注解仅保留在源级别中，并被编译器忽略。

  • RetentionRolicy.CLASS

    标记的注解在编译时由编译器保留，但JVM会忽略它。

  • RetentionRolicy.RUNTIME

    标记的注解由 JVM 保留，因此运行时环境可以使用它。

SOURCE < CLASS < RUNTIME，即CLASS包含了SOURCE，RUNTIME包含SOURCE、CLASS。

根据注解的保留级别不同,对注解的使用自然存在不同场景.由注解的三个不同保留级别可知，注解作用于：源码、字节码与运行时。

级别 技术 说明
源码 APT注解处理器,IDE语法检查 在编译期能获取注解与注解声明的类包括类中所有成员信息,一般用于生成额外的辅助类
字节码 字节码增强 在编译出Class后,通过修改Class数据以实现修改代码逻辑目的.对于是否需要修改的区分或者修改为不同逻辑的判断可以使用注解
运行时 反射 在程序运行期间,通过反射技术动态获取注解与其元素,从而完成不同的逻辑判定.

APT:Annotation Processor Tools->注解处理器

运行在编译阶段:

.java -> javac -> .class

解析要编译的java类,采集到所有的注解信息 -> 把采集到的信息包装成节点信息(Element) -> 由javac 调起指定的注解处理程序.

字节码增强:在字节码中写代码

.class-> 有自己的格式,数据按照特定的方式记录与排列

.class -> IO -> byte[] -> 不能随意改动

二、反射

一般情况下，我们使用某个类时必定知道它是什么类，是用来做什么的，并且能够获得此类的引用。于是我们直接对这个类进行实例化，之后使用这个类对象进行操作。

反射则是一开始并不知道我要初始化的类对象是什么，自然也无法使用new关键字来创建对象了。这时候，我们使用JDK提供的反射API进行反射调用。反射就是在运行状态中,对于任意一个类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意方法和属性;并且能改变它的属性。是Java被视为动态语言的关键。

Java反射机制主要提供了以下功能：

  • 在运行时构造任意一个类的对象
  • 在运行时后去或者修改任意一个类所具有的成员变量和方法
  • 在运行时调用任意一个对象的方法和属性

Class

反射源自Class,**Class时一个类,封装了当前对象所对应类的信息.**一个类中有属性,方法,构造器等,比如说有一个Person类,Order类,Book类.这些都是不同的类,现在需要一个类,用来描述,就是Class类,它应该有类名,属性,方法,构造器等.Class是用来描述类的类.

获得Class对象

获取Class对象的三种方式

  1. 通过类名获取 类名.class
  2. 通过对象获取 对象名.class
  3. 通过全类名获取 Class.forNmae(全类名) clasLoader.loadClass(全类名)

  • 使用Class类的forName静态方法

    public static Class<?> forName(String name)

  • 直接获取某个对象的class

    Class<?> clazz = int.class;
Class<?> classInteger = Integer.TYPE;

  • 调用某个对象的getClass()方法

    StringBuilder str = new StringBuilder("hello");
Class<?> clazz = str.getClass();

###判断是否为某个类的实例

一般使用instanceof关键字来判断是否为某个类的实例.同时我们也可以借助反射中Class对象的isInstance()方法来判断是否为某个类的实例,他是一个native方法:

public native boolean isInstance(Object obj)

判断是否为某个类的类型

public boolean isAssignableFrom(Class<?> cls)

创建实例

通过反射来生成对象主要有两种方式.

  • 使用Class对象的newInstance()

    Class<?> clazz = String.class;
Object string = clazz.newInstance();

  • 先通过Class对象获得指定的Constructor对象,在调用Constructor对象的newInstance()方法来创建实例.这种方法可以用于指定的构造器构造类的实例.

    //获取String所对应的Class对象
Class<?> c = String.class;
//获取String类带一个String参数的构造器
Constructor constructor = c.getConstructor(String.class);
//根据构造器创建实例
Object obj = constructor.newInstance("23333");
System.out.println(obj);

获取构造器信息

得到构造器的方法

Constructor getConstructor(Class[] params) // 获得使用特殊的参数类型的public构造函数(包括父类）
Constructor[] getConstructors() // 获得类的所有公共构造函数
Constructor getDeclaredConstructor(Class[] params) // 获得使用特定参数类型的构造函数(包括私有)
Constructor[] getDeclaredConstructors() // 获得类的所有构造函数(与接入级别无关)

获取类构造器的用法与上述获取方法的用法类似.主要是通过Class类的getConstuctor()方法得到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 {
		// 获取字段的类型
		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.NumberGson反序列化
		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);
    //在进行GSON反序列化时,存在泛型时,可以借助TypeToken获取Type已完成泛型的反序列化.但是为什么TypeToken要
    //被定义为抽象类?
	//因为只有定义为抽象类或接口,这样在使用时,需要创建对应的实现类,此时确定泛型类型,编译才能够将泛型signature
    //信息记录到Class元数据中
	//为什么TypeToken要定义为抽象类？
	Response<Data> resp = gson.fromJson(json, new TypeToken<Response<Data>>() {
	}.getType());
	System.out.println(resp.data.result);
}

    ​ 在进行GSON反序列化时，存在泛型时，可以借助 TypeToken 获取Type以完成泛型的反序列化。但是为什么
    TypeToken 要被定义为抽象类呢？
    ​ 因为只有定义为抽象类或者接口，这样在使用时，需要创建对应的实现类，此时确定泛型类型，编译才能够将泛型
    signature信息记录到Class元数据中。

    class Test {

    public static void main(String[] args) {
        Response<Data> response = new Response<>(new Data("获取数据"), 1, "成功");
        Gson gson = new Gson();

        String json = gson.toJson(response);
        System.out.println(json);

        //在进行GSON反序列化时,存在泛型时,可以借助TypeToken获取Type已完成泛型的反序列化.但是为什么TypeToken要
        //被定义为抽象类?
        //因为只有定义为抽象类或接口,这样在使用时,需要创建对应的实现类,此时确定泛型类型,编译才能够将泛型signature
        //信息记录到Class元数据中
        //为什么TypeToken要定义为抽象类？
        Response<Data> resp = gson.fromJson(json, new TypeToken<Response<Data>>() {
        }.getType());

        System.out.println(resp);

        //使用自己写的TypeToken
        Response<Data> response = gson.fromJson(json, new TypeRefrence<Response<Data>>() {
        }.getType())

    }

    static abstract class TypeRefrence<T> {
        Type type;

        public TypeRefrence() {
            Type genericSuperClass = getClass().getGenericSuperclass();
            ParameterizedType parameterizedType = (ParameterizedType) genericSuperClass;
            Type[] actualTypeArguments = parameterizedType.getActualTypeArguments();
            this.type = actualTypeArguments[0];
        }

        public Type getType() {
            return type;
        }
    }

    static class Response<T> {
        T data;
        int code;
        String message;

        public Response(T data, int code, String message) {
            this.data = data;
            this.code = code;
            this.message = message;
        }

        @Override
        public String toString() {
            return "Response{" + "data=" + data + ", code=" + code +
                    ", message='" + message + '\'' + '}';
        }
    }

    static class Data {
        String result;

        public Data(String result) {
            this.result = result;
        }

        @Override
        public String toString() {
            return "Data{" +
                    "result=" + result +
                    '}';
        }
    }
}

三、Retrofit中的注解、反射与动态代理

静态代理

代理模式是给一个对象提供一个代理对象,并由代理对象控制对原对象的引用.

目的:

  1. 通过引入代理对象的方式来间接访问目标对象,防止直接访问目标对象给系统带来的不必要复杂性
  2. 通过代理对象对方问进行控制

代理对象一般有三个对象:

Java学习笔记-注解与反射

**抽象角色:**指代理角色和真是角色对外提供的公共方法,一般为一个接口.

**真是角色:**需要实现首相角色接口,定义了真实角色所要实现的业务逻辑,以便共代理角色调用.也就是真正的业务逻辑在此.

**代理角色:**需要实现抽象角色接口,是真实角色的代理,通过真实角色的业务逻辑方法来实现抽象方法,并可以附加自己的操作.将统一的流程控制都放到代理角色当中处理.

静态代理在使用时,需要定义接口或者父类,被代理对象与代理对象一起实现相同的接口或者是继承相同父类。一般来说，被代理对象和代理对象是一对一的关系，当然一个代理对象对应多个被代理对象也是可以的。

静态代理，一对一则会出现时静态代理对象量多、代码量大，从而导致代码复杂，可维护性差的问题，一对多则代理对象会出现扩展能力差的问题.

动态代理

在运行是在创建代理类和其实例,显然这样效率更低.要完成这个场景,需要在运行期动态创建一个Class.JDK提供了Proxy来完成这件事.基本使用方法如下:

public interface Api {
    void test(String string);
}

public interface Api2 {
    void newfuture (String s);
}

public class ApiOne implements Api {
    @Override
    public void test(String string) {
        System.out.println("one ===>" + string);
    }
}

public class ApiOne implements Api {
    @Override
    public void test(String string) {
        System.out.println("one ===>" + string);
    }
}

public class test {
    public static void main(String[] args) throws Exception {

        Object o = Proxy.newProxyInstance(
                test.class.getClassLoader(),
                new Class[]{Api.class, Api2.class},
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object o, Method method, Object[] objects) throws Throwable {
                        return method.invoke(new ApiOne(), objects);
                    }
                });
        Object o1 = Proxy.newProxyInstance(
                test.class.getClassLoader(),
                new Class[]{Api.class, Api2.class},
                new InvocationHandler() {
                    @Override
                    public Object invoke(Object o, Method method, Object[] objects) throws Throwable {
                        return method.invoke(new ApiTwo(), objects);
                    }
                });
        Api api = (Api) o;
        api.test("hello world");
        Api2 api2 = (Api2) o1;
        api2.newfuture("api2");

    }
}

实际上， Proxy.newProxyInstance 会创建一个Class，与静态代理不同，这个Class不是由具体的.java源文件编译而来，没有真正的文件，只是在内存中按照Class格式生成了一个Class.

Java学习笔记-注解与反射

在生成文件中查看我们的代理类:

Java学习笔记-注解与反射

在初始化时,获取method备用.而这个代理类中所有实现方法变为:

Java学习笔记-注解与反射

这里的h就是InvocationHandler接口,搜易我们在使用动态代理时,传递的InvocationHandler就是一个监听,在代理对象上执行方法埋葬准则这个监听回调回来.

Java学习笔记-注解与反射

Java学习笔记-注解与反射

使用注解和反射实现一个简易版Retorfit

Java学习笔记-注解与反射

Java学习笔记-注解与反射

MyRetorfit.kt

/**
 *@auther: Chen
 *@createTime: 2020/6/29 18:30
 *@description 通过构建者模式对网络请求接口进行封装
 **/
@Suppress("UNCHECKED_CAST")
class MyRetrofit(val callFactory: Call.Factory, val baseUrl: HttpUrl) {

    //存储请求信息
    private val serviceMethodCache: MutableMap<Method, ServiceMethod> = ConcurrentHashMap()

    fun <T> create(service: Class<T>) = Proxy.newProxyInstance(service.classLoader, arrayOf(service)) { _, method, args ->
        val serviceMethod = loadServiceMethod(method)
        serviceMethod.invoke(args)
    } as T


    private fun loadServiceMethod(method: Method) =
            //先从缓存中查找,没有再向缓存中添加
            serviceMethodCache[method] ?: synchronized(serviceMethodCache) {
                ServiceMethod.Builder(this, method).build().also { serviceMethodCache[method] = it }
            }

    /*
      TODO: 构建者模式:将一个复杂对象的构建和它的表示分离,可以使使用者不必知道内部的组成细节
     */
    class Builder {
        private var baseUrl: HttpUrl? = null
        private var callFactory: Call.Factory? = null
        fun baseUrl(baseUrl: String): Builder {
            this.baseUrl = baseUrl.toHttpUrl()
            return this
        }

        fun build(): MyRetrofit {
            baseUrl ?: throw RuntimeException("baseUrl is null")
            callFactory ?: OkHttpClient().also { callFactory = it }
            return MyRetrofit(callFactory!!, baseUrl!!)
        }
    }
}

ParameterHandler.kt

/**
 *@auther: Chen
 *@createTime: 2020/6/29 20:55
 *@description: 记录参数对应请求中的name
 **/
abstract class ParameterHandler {
    //TODO: serviceMethod可以看作回调
    abstract fun apply(serviceMethod: ServiceMethod, value: String)

    class QueryParameterHandler(private val key: String) : ParameterHandler() {

        override fun apply(serviceMethod: ServiceMethod, value: String) {
            serviceMethod.addQueryParameter(key, value)
        }
    }

    class FieldParameterHandle(private val key: String) : ParameterHandler() {
        override fun apply(serviceMethod: ServiceMethod, value: String) {
            serviceMethod.addFieldParameter(key, value)
        }
    }
}

ServiceMethod.kt

/**
 *@auther: Chen
 *@createTime: 2020/6/29 18:50
 *@description: 记录请求类型，参数，完整地址等
 **/
class ServiceMethod(builder: Builder) {


    private var callFactory: Call.Factory
    private var relativeUrl: String
    private var hasBody: Boolean
    private var parameterHandlers: List<ParameterHandler>
    private var formBuilder: FormBody.Builder? = null
    private val httpMethod: String
    var baseUrl: HttpUrl
    var urlBuilder: HttpUrl.Builder? = null

    init {
        callFactory = builder.myRetrofit.callFactory
        relativeUrl = builder.relativeUrl
        hasBody = builder.hasBody
        parameterHandlers = builder.parameterHandlers
        baseUrl = builder.myRetrofit.baseUrl
        httpMethod = builder.httpMethod
        // TODO: 2020/6/29   如果有请求体,创建一个okhttp的请求体对象
        if (hasBody) formBuilder = FormBody.Builder()

    }

    fun invoke(args: Array<Any>?): Any? {
        // TODO: 1.处理请求地址与参数
        parameterHandlers.forEachIndexed { index, handler ->
            // TODO: 2020/6/29  handler中本来就记录了key,现在加入相应的value
            handler.apply(this, args?.get(index).toString())
        }
        // TODO: 2020/6/29 2.得到最终请求地址
        if (urlBuilder == null) {
            urlBuilder = baseUrl.newBuilder(relativeUrl)
                    ?: throw RuntimeException("$urlBuilder is null ")
        }
        val url = urlBuilder?.build().also { urlBuilder = null }
        var formBody: FormBody? = null
        if (formBuilder != null) formBody = formBuilder?.build().also { formBuilder = FormBody.Builder() }
        val request = Request.Builder().url(url!!).method(httpMethod, formBody).build()
        return callFactory.newCall(request)
    }

    // TODO: 2020/6/29 POST请求,把K-V拼接到url里面
    fun addFieldParameter(key: String, value: String) {
        formBuilder?.add(key, value)
    }

    // TODO: 2020/6/29 GET请求,把K-V放到请求体中
    fun addQueryParameter(key: String, value: String) {
        if (urlBuilder == null) urlBuilder = baseUrl.newBuilder(relativeUrl)
                ?: throw RuntimeException("$urlBuilder is null ")
        urlBuilder?.addQueryParameter(key, value)
    }

    @Suppress("CAST_NEVER_SUCCEEDS")
    class Builder(val myRetrofit: MyRetrofit, method: Method) {
        lateinit var relativeUrl: String
        lateinit var httpMethod: String
        var hasBody by Delegates.notNull<Boolean>()

        //获取方法上的所有的注解
        private val methodAnnotations: Array<Annotation> = method.annotations

        //获得方法参数上的所有的注解 TODO 一个参数可以有多个注解 一个方法可以有多个参数
        private val parameterAnnotations: Array<Array<out Annotation>> = method.parameterAnnotations
        var parameterHandlers = mutableListOf<ParameterHandler>()


        fun build(): ServiceMethod {
            // TODO 1.只解析方法上的注解GET和POST
            methodAnnotations.forEachIndexed { _, annotation ->
                when (annotation) {
                    is POST -> {
                        httpMethod = "POST"
                        relativeUrl = annotation.value
                        hasBody = true
                    }
                    is GET -> {
                        httpMethod = "GET"
                        relativeUrl = annotation.value.also { Log.d("Chen", "build: $it") }
                        hasBody = false
                    }
                }
            }
            // TODO: 2.解析方法菜属的注解
            parameterAnnotations.forEachIndexed { i, annotations ->
                // 处理参数上的每一个注解
                annotations.forEach { annotation ->
                    when (annotation) {
                        is Field -> {
                            if (httpMethod == "GET") throw RuntimeException("$httpMethod can't use annotation ${GET::class.java.name}," +
                                    "please use annotation ${Query::javaClass.name} ")
                            //得到注解上的value:请求参数的key 并储存起来
                            parameterHandlers.add(i, ParameterHandler.FieldParameterHandle(annotation.value))
                        }
                        is Query -> {
                            //得到注解上的value:请求参数的key 并储存起来
                            parameterHandlers.add(i, ParameterHandler.QueryParameterHandler(annotation.value))
//                            parameterHandlers[i] = ParameterHandler.QueryParameterHandler(annotation.value)
                        }
                    }
                }
            }
            return ServiceMethod(this)
        }
    }
}
相关标签： Java学习 java 反射

上一篇： 【netty in action】学习笔记-第三章

下一篇： php验证码-图片

推荐阅读