上篇文章《Java高级特性（一）注解的分类及使用》讲了注解相关的基础知识，但是基本的注解声明和使用，并不能发挥注解的真正效果。如果要让注解产生实际的作用，就需要搭配注解处理器来使用。至于为什么说写半个Retrofit框架，因为本文只涉及到Retrofit框架中关于注解处理的内容（大佬轻喷）。

我们先回顾一下Retrofit是怎么用的？（代码摘自Retrofit官网）

第一步：定义一个接口，接口里面定义方法，使用@GET、@POST等注解标注我们定义的方法；

1
2
3
4
public interface GitHubService {
  @GET("users/{user}/repos")
  Call<List<Repo>> listRepos(@Path("user") String user);
}

第二步：创建retrofit实例，然后调用retrofit.create()方法，将我们定义的接口.class传入create方法。通过create方法生成实现了我们定义的接口的代理对象；

1
2
3
4
5
Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .build();

GitHubService service = retrofit.create(GitHubService.class);

第三步：调用实现了接口的代理对象的具体方法，完成网络请求。

1
Call<List<Repo>> repos = service.listRepos("octocat");

那Retrofit是如何将@GET注解里的接口地址解析出来并使用的呢？这里就用到了注解处理，使用反射的方式获取了方法的注解传入的参数值。下面我们就自己用代码来实现一下。

  1. 定义一个@GET注解和@POST注解：
1
2
3
4
5
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface GET {
    String value() default "";
}
1
2
3
4
5
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface POST {
    String value() default "";
}
  1. 定义Api抽象类，类比Retrofit的第一步：
1
2
3
4
5
6
7
public abstract class Api {
    @GET("https://api.github.com")
    abstract void getGithub();

    @POST("https://api.github.com/droidYu")
    abstract void updateUserInfo();
}

因为Retrofit涉及到动态代理到知识，这里不进行深入讲解，所以我们使用了抽象类来代替Retrofit的接口。

  1. 在main方法中调用getAnnotation()方法，并传入Api.class，这一步可以类比Retrofit框架中第二步retrofit.create(GitHubService.class)方法的调用：
1
2
3
public static void main(String[] args) {
        getAnnotation(Api.class);
    }

在getAnnotation方法中通过反射到方式获取@GET和@POST注解里的请求地址并打印：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
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方法定义如下：

1
2
3
public static void print(String methodType,Method method, String annotationValue) {
    System.out.println("从 "+methodType+" 方法："+method.getName()+" 获取到注解的值：" + annotationValue);
}

运行程序：

从打印的内容中，我们可以看到，我们已经成功的从我们自己定义的注解中获取到了请求地址。这其实就是Retrofit框架用注解获取请求地址的的核心设计思路，只不过Retrofit框架的这部分代码更加完善，使得框架非常的简单易用。至此，我们花3分钟的时间，就写了半个Retrofit框架，即Retrofit注解处理的核心代码。

示例代码已上传Github

关注我