Retrofit详细介绍

2024-06-24 08:08
文章标签 retrofit 详细 介绍

本文主要是介绍Retrofit详细介绍，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

转载请标明出处：http://blog.csdn.net/xx326664162/article/details/51910837 文章出自：薛瑄的博客

你也可以查看我的其他同类文章，也会让你有一定的收货！

一、Retrofit 是什么？

Retrofit is a type-safe HTTP client for Android and java.

Retrofit 是与 Web 服务器提供的 API 接口（URL）进行通信的一个库

二、Retrofit、volley、OkHttp等的关系

网上有很多用于网络通信的库，但是彼此之间还是有一定的差异。 
更多内容：okhttp,retrofit,android-async-http,volley应该选择哪一个？

  • volley, retrofit, android-async-http 帮你封装了具体的请求，线程切换以及数据转换。

  • OkHttp 是基于http协议封装的一套请求客户端，虽然它也可以开线程，但根本上它更偏向真正的请求，跟HttpClient, HttpUrlConnection的职责是一样的。

三、Retrofit的示例

来自： 
retrofit官网 
[Android] Retrofit 初步使用

先通过一个简单的demo，整体认识一下Retrofit是怎么工作的，

1、Retrofit turns your HTTP API into a Java interface.

根据URL来构造一个java 接口，接口名称可自定义。

public interface GitHubService {@GET("users/{user}")Call<TestModel> repo(@Path("user") String user);
}
  • 在此处 GET 的意思是 发送一个 GET请求，请求的地址为：baseUrl + “/users/{user}”。 baseUrl 在下面第三步指定具体的值。

{user} 类似于占位符的作用，具体类型由 repo(@Path(“user”) String user) 指定，这里表示 {user} 将是一段字符串。

2、定义返回数据类型

这里定义的类型就是上面 Call< TestModel> 中的TestModel。

请求会将 Json 数据转化为 Java 实体类，所以我们需要自定义一个 javabean：

public class TestModel {private String login;public String getLogin() {return login;}public void setLogin(String login) {this.login = login;}
}

3、The Retrofit class generates an implementation of the GitHubService interface.

GitHubService 接口是在第一步中定义的，这一步来实现这个接口

Retrofit retrofit= new Retrofit.Builder()
.baseUrl("https://api.github.com")
.addConverterFactory(GsonConverterFactory.create())
.build();GitHubService service = retrofit.create(GitHubService.class);
  • 在构造 Retrofit 对象时添加baseUrl为https://api.github.com

4、Each Call from the created GitHubService can make a synchronous or asynchronous HTTP request to the remote webserver.

使用GitHubService接口创建一个请求对象。

Call<TestModel> repos = service.repo("jantxue");

注意这里的 .repo(“jantxue”) 替换第一步中的 {user}。到这里，我们要访问的地址就成了：

https://api.github.com/users/jantxue

可以使用不同参数访问同一个 Web 域名，比如可以改成 .repo(“ligoudan”)，就是访问下面这个地址

https://api.github.com/users/ligoudan

5、最后，就可以发送请求了！

通过调用Retrofit的execute（同步）或者enqueue（异步）方法，发送请求到网络服务器，并返回一个响应（Response）。

repos.enqueue(new Callback<TestModel>() {@Overridepublic void onResponse(Call<TestModel> call, Response<TestModel> response) {// Log.e("Test", response.body().getLogin());System.out.print(response.body().getLogin());}@Overridepublic void onFailure(Call<TestModel> call, Throwable t) {System.out.print(t.getMessage());}});

下面部分是对第三点每个步骤的深入探讨，所以在继续看下面之前，把第三点理解透彻

四、Call对象，代表被封装的一个请求/响应，只能被使用一次

参考：Retrofit2 使用及新特性

1、 Retrofit 2 里也多了一个 call 对象。语法和 OkHttp 基本一模一样，唯一不同是这个函数知道如何做数据的反序列化。它知道如何将 HTTP 响应转换成对象。

2、 每一个 call 对象实例只能被用一次，所以说 request 和 response 是一一对应的。可以通过 Clone 方法来创建一个一模一样的实例，这个开销是很小的。比如：可以在每次决定发请求前 clone 一个之前的实例。

3、 retrofit.create()得到接口的实例. 
调用接口中的函数，获得一个Call 实例。 
之后调用Call 的 execute ()来访问对应网址.

interface GitHubService {@GET("/repos/{owner}/{repo}/contributors")Call<List<Contributor>> repoContributors(@Path("owner") String owner,@Path("repo") String repo);
}GitHubService gitHubService= retrofit.create(GitHubService.class);Call<List<Contributor>> call =gitHubService.repoContributors("square", "retrofit");response = call.execute();// This will throw IllegalStateException:
response = call.execute();Call<List<Contributor>> call2 = call.clone();
// This will not throw:
response = call2.execute();

4、 另一个大的进步是 2.0 支持了在一个类型中的同步和异步。

5、一个请求也可以被真正地终止。终止操作会对底层的 http client 执行 cancel 操作。即便是正在执行的请求，也能立即切断。当你将一些异步请求压入队列后，甚至你在执行同步请求的时候，你可以随时调用 cancel 方法来取消请求：

Call<List<Contributor>> call =gitHubService.repoContributors("square", "retrofit");//执行异步请求
call.enqueue(         );
// 或者执行同步请求
call.execute();// later...
call.cancel();

五、参数

参考： 
好用的网络请求库Retrofit2（入门及讲解） 
retrofit官网 
Retrofit网络请求库教程

1、固定参数

每个方法必须有一个HTTP注解，这个注解提供请求方法和相对URL。共有五种注解：GET, POST, PUT, DELETE, HEAD。URL中的路径被指定在注解中。

1.1

@GET("users/list")
// 请求内容
// GET users/list HTTP/1.1
  • 1.2、也可以指定一个查询参数在URL中
@GET("users/list?sort=desc")// 请求内容
//GET users/list?sort=desc HTTP/1.1

2、动态参数

URL可以使用替换块和动态更新参数。字符{ 和 }之间的内容是可被替换的。相应的参数必须和@Path注解使用相同的字符串

2.1、

@GET("group/{id}/users")
Call<List<User>> someEndpoint(@Path("id") int groupId);// 方法调用
someService.someEndpoint("a");//请求内容
//GET group/a/users HTTP/1.1

2.2、查询参数也可以被添加

@GET("group/{id}/users")
Call<List<User>> someEndpoint(@Path("id") int groupId, @Query("sort") String sort);// 方法调用
someService.someEndpoint(1,"desc");// 请求头
// GET group/1/users?sort=desc   HTTP/1.1

2.3、由Map组成的复合查询参数

@GET("group/{id}/users")
Call<List<User>> someEndpoint(@Path("id") int groupId, @QueryMap Map<String, String> options);// 方法调用
someService.someEndpoint(1,
Collections.singletonMap("dynamic", "query"));// 请求头
// GET group/1/users?dynamic=query HTTP/1.1

2.4、固定+动态参数

interface SomeService {@GET("/some/endpoint?fixed=query")Call<SomeResponse> someEndpoint(@Query("dynamic") String dynamic);
}// 方法调用
someService.someEndpoint("query");// 请求头
// GET /some/endpoint?fixed=query&dynamic=query HTTP/1.1

3、Post请求主体

一个对象可以被指定为一个HTTP请求主体通过使用@Body 注解

3.1、Post请求有Body

interface SomeService {@POST("/some/endpoint")Call<SomeResponse> someEndpoint(@Body SomeRequest body);
}someService.someEndpoint();// POST /some/endpoint HTTP/1.1
// Content-Length: 3
// Content-Type: greeting
//
// Hi!

3.2、Post请求，无Body

interface SomeService {@POST("/some/endpoint")Call<SomeResponse> someEndpoint();
}someService.someEndpoint();// POST /some/endpoint?fixed=query HTTP/1.1
// Content-Length: 0

这个对象将被转变使用Retrofit实例中指定的转变方法。如果没有转变方法，则只有RequestBody可以使用

4、Form表单提交和多部分参数

当@FormUrlEncoded出现在方法中，Form表单数据会被发送。每个键值对被注解，通过使用@Field 包括名字和值（由对象提供）

4.1、 表单编码字段

interface SomeService {@FormUrlEncoded@POST("/some/endpoint")Call<SomeResponse> someEndpoint(@Field("name1") String name1,@Field("name2") String name2);
}someService.someEndpoint("value1", "value2");// POST /some/endpoint HTTP/1.1
// Content-Length: 25
// Content-Type: application/x-www-form-urlencoded
//
// name1=value1&name2=value2

4.2、表单编码字段（Map）

interface SomeService {@FormUrlEncoded@POST("/some/endpoint")Call<SomeResponse> someEndpoint(@FieldMap Map<String, String> names);
}someService.someEndpoint(// ImmutableMap是OKHttp中的工具类ImmutableMap.of("name1", "value1", "name2", "value2"));// POST /some/endpoint HTTP/1.1
// Content-Length: 25
// Content-Type: application/x-www-form-urlencoded
//
// name1=value1&name2=value2

4.3、一般用于上传文件等，@Part可以是文件 
Multipart requests are used when @Multipart is present on the method. Parts are declared using the @Part annotation.

多个部分参数被请求当方法中出现@Multipart，使用@Part注解来声明Parts

@Multipart
@PUT("user/photo")
Call<User> updateUser(@Part("photo") RequestBody photo, @Part("description") RequestBody description);

Multipart parts use one of Retrofit’s converters or they can implement RequestBody to handle their own serialization.

5、关于HEADER 的操作

5.1、固定头

interface SomeService {@GET("/some/endpoint")@Headers("Accept-Encoding: application/json")Call<SomeResponse> someEndpoint();
}someService.someEndpoint();// GET /some/endpoint HTTP/1.1
// Accept-Encoding: application/json

5.2、动态头

interface SomeService {@GET("/some/endpoint")Call<SomeResponse> someEndpoint(@Header("Location") String location);
}someService.someEndpoint("Droidcon NYC 2015");// GET /some/endpoint HTTP/1.1
// Location: Droidcon NYC 2015

5.3、固定+动态头

interface SomeService {@GET("/some/endpoint")@Headers("Accept-Encoding: application/json")Call<SomeResponse> someEndpoint(@Header("Location") String location);
}someService.someEndpoint("Droidcon NYC 2015");// GET /some/endpoint HTTP/1.1
// Accept-Encoding: application/json
// Location: Droidcon NYC 2015

六、Converters

默认情况下，Retrofit 仅反序列化HTTP的主体内容为OkHttp的ResponseBody类型 。它只能接受类型为RequestBody 的@Body

Converters can be added to support other types. Six sibling modules adapt popular serialization libraries for your convenience.

Gson: com.squareup.retrofit2:converter-gson
Jackson: com.squareup.retrofit2:converter-jackson
Moshi: com.squareup.retrofit2:converter-moshi
Protobuf: com.squareup.retrofit2:converter-protobuf
Wire: com.squareup.retrofit2:converter-wire
Simple XML: com.squareup.retrofit2:converter-simplexml
Scalars (primitives, boxed, and String): com.squareup.retrofit2:converter-scalars

Retrofit2 使用FastJson作为Converter 
Retrofit2+RxJava+LoganSquare最佳实践

这里有一个例子使用GsonConverterFactory类生成GitHubService接口的一个实现使用Gson反序列化。

Retrofit retrofit = new Retrofit.Builder().baseUrl("https://api.github.com").addConverterFactory(GsonConverterFactory.create()).build();GitHubService service = retrofit.create(GitHubService.class);

七、OkHttp 提供支持

下面的部分来自：用 Retrofit 2 简化 HTTP 请求

OkHttp 提供支持 
Retrofit 2 现在开始依赖了 OkHttp 了，而且这部分不再支持替换。这是一件比较有争议的事情。但是希望我能证明为什么这是一个对的决定。

OkHttp 现在很小而且很聚焦，有很多好用的 API 接口。我们在 Retrofit 2 里都有对 OkHttp 的接口映射，也基本具备了我们需要的所有的特性，包括提到的所有的抽象类们。这些都超赞！这是压缩 Retrofit 库大小的一个法宝。我们最终减小了Retrofit 60% 的体积，同时又具有了更多的特性。

OkHttp 提供支持 (以及 Okio!)

另一个用 OkHttp 的好处就是我们能够在 Retrofit 2 把 OkHttp 以公开接口的方式直接导出。你可能在 error body 方法或者响应里见到过 response body 的内容。显然，我们在 Retrofit 的 Reponse 对象里直接返回了 OkHttp 的 Response body。我们正在导出这些类型，OkHttp 的类型基本上已经以更好更简洁的 API 替代 Retrofit 1.0 的一些接口。

OkHttp 的背后是一个叫做 Okio 的库，提供的 IO 支持。我之前在 Droidcon Montreal 做过关于这个库的演讲。讨论过为什么它是众多 IO 库中更好的选择，还讨论了它为何极度高效，以及为什么你应该使用它们。演讲中我还提到 Retrofit 2 ，当时它还是脑海里的一个概念。现在 Retrofit 2 已经实现了。

八、Retrofit执行模式

这里写图片描述

这里写图片描述 
这里写图片描述

这里写图片描述

这里写图片描述

拓展：Retrofit分析-漂亮的解耦套路 
http://square.github.io/retrofit/2.x/retrofit/ 
http://blog.csdn.net/qq_21430549/article/details/50113387


这篇关于Retrofit详细介绍的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/1089588。

相关文章

揭秘未来艺术：AI绘画工具全面介绍

揭秘未来艺术：AI绘画工具全面介绍

📑前言 随着科技的飞速发展，人工智能（AI）已经逐渐渗透到我们生活的方方面面。在艺术创作领域，AI技术同样展现出了其独特的魅力。今天，我们就来一起探索这个神秘而引人入胜的领域，深入了解AI绘画工具的奥秘及其为艺术创作带来的革命性变革。 一、AI绘画工具的崛起 1.1 颠覆传统绘画模式 在过去，绘画是艺术家们通过手中的画笔，蘸取颜料，在画布上自由挥洒的创造性过程。然而，随着AI绘画工
阅读更多...
VMware9.0详细安装

VMware9.0详细安装

双击VMware-workstation-full-9.0.0-812388.exe文件： 直接点Next; 这里，我选择了Typical（标准安装）。 因为服务器上只要C盘，所以我选择安装在C盘下的vmware文件夹下面，然后点击Next; 这里我把√取消了，每次启动不检查更新。然后Next； 点击Next； 创建快捷方式等，点击Next； 继续Cont
阅读更多...
20.Spring5注解介绍

20.Spring5注解介绍

1.配置组件 Configure Components 注解名称说明@Configuration把一个类作为一个loC容 器 ，它的某个方法头上如果注册7@Bean , 就会作为这个Spring容器中的Bean@ComponentScan在配置类上添加@ComponentScan注解。该注解默认会扫描该类所在的包下所有的配置类，相当于之前的 <context:component-scan>@Sc
阅读更多...
（超详细）YOLOV7改进-Soft-NMS(支持多种IoU变种选择)

（超详细）YOLOV7改进-Soft-NMS(支持多种IoU变种选择)

1.在until/general.py文件最后加上下面代码 2.在general.py里面找到这代码，修改这两个地方 3.之后直接运行即可
阅读更多...
Java注解详细总结

Java注解详细总结

什么是注解？         Java注解是代码中的特殊标记，比如@Override、@Test等，作用是：让其他程序根据注解信息决定怎么执行该程序。         注解不光可以用在方法上，还可以用在类上、变量上、构造器上等位置。 自定义注解  现在我们自定义一个MyTest注解 public @interface MyTest{String aaa();boolean bbb()
阅读更多...
气象站的种类和应用范围可以根据不同的分类标准进行详细的划分和描述

气象站的种类和应用范围可以根据不同的分类标准进行详细的划分和描述

气象站的种类和应用范围可以根据不同的分类标准进行详细的划分和描述。以下是从不同角度对气象站的种类和应用范围的介绍： 一、气象站的种类 根据用途和安装环境分类： 农业气象站：专为农业生产服务，监测土壤温度、湿度等参数，为农业生产提供科学依据。交通气象站：用于公路、铁路、机场等交通场所的气象监测，提供实时气象数据以支持交通运营和调度。林业气象站：监测林区风速、湿度、温度等气象要素，为林区保护和
阅读更多...
基于Java医院药品交易系统详细设计和实现(源码+LW+调试文档+讲解等)

基于Java医院药品交易系统详细设计和实现(源码+LW+调试文档+讲解等)

💗博主介绍：✌全网粉丝10W+,CSDN作者、博客专家、全栈领域优质创作者，博客之星、平台优质作者、专注于Java、小程序技术领域和毕业项目实战✌💗 🌟文末获取源码+数据库🌟 感兴趣的可以先收藏起来，还有大家在毕设选题，项目以及论文编写等相关问题都可以给我留言咨询，希望帮助更多的人  Java精品实战案例《600套》 2023-2025年最值得选择的Java毕业设计选题大全：1000个热
阅读更多...
C++标准模板库STL介绍

C++标准模板库STL介绍

STL的六大组成部分 STL（Standard Template Library）是 C++ 标准库中的一个重要组成部分，提供了丰富的通用数据结构和算法，使得 C++ 编程变得更加高效和方便。STL 包括了 6 大类组件，分别是算法（Algorithm）、容器（Container）、空间分配器（Allocator）、迭代器（Iterator）、函数对象（Functor）、适配器（Adapter）
阅读更多...
一二三应用开发平台应用开发示例（4）——视图类型介绍以及新增、修改、查看视图配置

一二三应用开发平台应用开发示例（4）——视图类型介绍以及新增、修改、查看视图配置

调整上级属性类型 前面为了快速展示平台的低代码配置功能，将实体文件夹的数据模型上级属性的数据类型暂时配置为文本类型，现在我们调整下，将其数据类型调整为实体，如下图所示： 数据类型需要选择实体，并在实体选择框中选择自身“文件夹” 这时候，再点击生成代码，平台会报错，提示“实体【文件夹】未设置主参照视图”。这是因为文件夹选择的功能页面，同样是基于配置产生的，因为视图我们还没有配置，所以会报错。
阅读更多...
Java反射详细总结

Java反射详细总结

什么是反射？         反射，指的是加载类的字节码到内存，并以编程的方法解刨出类中的各个成分（成员变量、方法、构造器等）。         反射获取的是类的信息，那么反射的第一步首先获取到类才行。由于Java的设计原则是万物皆对象，获取到的类其实也是以对象的形式体现的，叫字节码对象，用Class类来表示。获取到字节码对象之后，再通过字节码对象就可以获取到类的组成成分了，这些组成成分其实也
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2