本文主要是介绍Java高级特性(二)注解处理 之 3分钟写半个Retrofit框架,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!
上篇文章《Java高级特性(一)注解的分类及使用》讲了注解相关的基础知识,但是基本的注解声明和使用,并不能发挥注解的真正效果。如果要让注解产生实际的作用,就需要搭配注解处理器来使用。至于为什么说写半个Retrofit
框架,因为本文只涉及到Retrofit
框架中关于注解处理的内容(大佬轻喷)。
我们先回顾一下Retrofit
是怎么用的?(代码摘自Retrofit
官网)
第一步:定义一个接口,接口里面定义方法,使用@GET、@POST
等注解标注我们定义的方法;
public interface GitHubService {@GET("users/{user}/repos")Call<List<Repo>> listRepos(@Path("user") String user);
}
第二步:创建retrofit
实例,然后调用retrofit.create()
方法,将我们定义的接口.class
传入create
方法。通过create
方法生成实现了我们定义的接口的代理对象;
Retrofit retrofit = new Retrofit.Builder().baseUrl("https://api.github.com/").build();GitHubService service = retrofit.create(GitHubService.class);
第三步:调用实现了接口的代理对象的具体方法,完成网络请求。
Call<List<Repo>> repos = service.listRepos("octocat");
那Retrofit
是如何将@GET
注解里的接口地址解析出来并使用的呢?这里就用到了注解处理,使用反射的方式获取了方法的注解传入的参数值。下面我们就自己用代码来实现一下。
- 定义一个
@GET
注解和@POST
注解:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface GET {String value() default "";
}
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface POST {String value() default "";
}
- 定义
Api
抽象类,类比Retrofit
的第一步:
public abstract class Api {@GET("https://api.github.com")abstract void getGithub();@POST("https://api.github.com/droidYu")abstract void updateUserInfo();
}
因为Retrofit
涉及到动态代理到知识,这里不进行深入讲解,所以我们使用了抽象类来代替Retrofit
的接口。
- 在
main
方法中调用getAnnotation()
方法,并传入Api.class
,这一步可以类比Retrofit
框架中第二步retrofit.create(GitHubService.class)
方法的调用:
public static void main(String[] args) {getAnnotation(Api.class);}
在getAnnotation
方法中通过反射到方式获取@GET
和@POST
注解里的请求地址并打印:
public static void getAnnotation(Class clazz) {//获取传入的.class中的所有方法Method[] methods = clazz.getDeclaredMethods();for (Method method : methods) {//遍历获取到到方法数组,获取每个方法中的所有注解Annotation[] annotations = method.getAnnotations();for (Annotation annotation : annotations) {//遍历获取到的所有注解,判断注解类型,分别打印注解内容if (annotation instanceof GET) {print("GET",method,((GET) annotation).value());} else if (annotation instanceof POST) {print("POST",method,((POST) annotation).value());}}}}
其中print
方法定义如下:
public static void print(String methodType,Method method, String annotationValue) {System.out.println("从 "+methodType+" 方法:"+method.getName()+" 获取到注解的值:" + annotationValue);}
运行程序:
从打印的内容中,我们可以看到,我们已经成功的从我们自己定义的注解中获取到了请求地址。这其实就是Retrofit
框架用注解获取请求地址的的核心设计思路,只不过Retrofit
框架的这部分代码更加完善,使得框架非常的简单易用。至此,我们花3分钟的时间,就写了半个Retrofit
框架,即Retrofit
注解处理的核心代码。
示例代码已上传Github
学习更多知识,请关注我的个人博客:droidYu
这篇关于Java高级特性(二)注解处理 之 3分钟写半个Retrofit框架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!