Java高级特性(二)注解处理 之 3分钟写半个Retrofit框架

2024-05-14 22:18

本文主要是介绍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注解里的接口地址解析出来并使用的呢?这里就用到了注解处理,使用反射的方式获取了方法的注解传入的参数值。下面我们就自己用代码来实现一下。

  1. 定义一个@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 "";
}
  1. 定义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的接口。

  1. 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框架的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/990004

相关文章

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》:本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景:在controller编写的接口,在前后端交互过程中一般都会涉及

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder?为什么需要 StringBuilder?如何使用 St

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》:本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理(不推荐)2、使用版本管理(推

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok?2. @SneakyThrows

在 Spring Boot 中实现异常处理最佳实践

《在SpringBoot中实现异常处理最佳实践》本文介绍如何在SpringBoot中实现异常处理,涵盖核心概念、实现方法、与先前查询的集成、性能分析、常见问题和最佳实践,感兴趣的朋友一起看看吧... 目录一、Spring Boot 异常处理的背景与核心概念1.1 为什么需要异常处理?1.2 Spring B

SpringBoot3.4配置校验新特性的用法详解

《SpringBoot3.4配置校验新特性的用法详解》SpringBoot3.4对配置校验支持进行了全面升级,这篇文章为大家详细介绍了一下它们的具体使用,文中的示例代码讲解详细,感兴趣的小伙伴可以参考... 目录基本用法示例定义配置类配置 application.yml注入使用嵌套对象与集合元素深度校验开发

python处理带有时区的日期和时间数据

《python处理带有时区的日期和时间数据》这篇文章主要为大家详细介绍了如何在Python中使用pytz库处理时区信息,包括获取当前UTC时间,转换为特定时区等,有需要的小伙伴可以参考一下... 目录时区基本信息python datetime使用timezonepandas处理时区数据知识延展时区基本信息