android retrofit 从无知到入门

2023-12-08 15:18
文章标签 android 入门 retrofit 无知

本文主要是介绍android retrofit 从无知到入门，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

android retrofit 从无知到入门

  • 前言
  • 一、初识retrofit🛴
    • 1.retrofit是什么？
    • 2.一些配置和数据准备
    • 3.快速上手retrofit
      • a.接口
      • b.实现
      • c.execute()和enqueue(Callback<T> callback)
  • 二、更多用法（注解介绍）🚲
    • 1.八种请求注解
    • 2.四种标记注解
    • 3.十二个参数注解
  • 三、进阶使用🚄
    • 1.RetrofitService
    • 2.ConverterFactory
    • 3.OkHttpClient
    • retrofit官网.

前言

本文会从零开始介绍retrofit的一些简单使用和封装，基于retrofit:2.3.0
让我们从滑板车🛴到轻轨🚄，😆😆😆

一、初识retrofit🛴

1.retrofit是什么？

retrofit官方文档的介绍非常的简洁明了，俗话说得好，字越少越牛逼，它是一个适用于Android和Java的类型安全HTTP客户端，它的底层是基于okhttp的，用了各种各样的设计模式封装起来的，在这里我们不多赘述，至于也不了解okhttp的，emmm，懂的都懂

2.一些配置和数据准备

既然是用于通信的，就不要忘记添加网络权限，在项目的Androidmanifest中添加

    <!-- 访问网络的权限 --><uses-permission android:name="android.permission.INTERNET"></uses-permission>

当然也少不了添加依赖，为了不过多赘述这些，我们一次添加齐全，在build.gradle中添加

    //retrofitapi 'com.squareup.retrofit2:retrofit:2.3.0'api 'com.squareup.retrofit2:converter-gson:2.3.0'api 'com.squareup.retrofit2:adapter-rxjava2:2.3.0'api 'com.trello.rxlifecycle2:rxlifecycle-components:2.2.1'api 'com.facebook.stetho:stetho:1.5.0'api 'com.facebook.stetho:stetho-okhttp3:1.5.0'

我们来一个请求的返回体
“为了规范我们写的规范一点”

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.HashMap;
import java.util.Map;@ApiModel(value = "DataResponse",description = "请求返回值"
)
public abstract class DataResponse<T> implements Serializable {private static final long serialVersionUID = -7574544066074667453L;@ApiModelProperty(value = "错误编码,0代表无错误",name = "errorCode")private int errorCode = 0;@ApiModelProperty(value = "结果编码",name = "resultCode")private String resultCode = "";@ApiModelProperty(value = "结果信息",name = "message")private String message;@ApiModelProperty(value = "附加信息",name = "extInfo")private Map<String, Object> extInfo = new HashMap();@ApiModelProperty(value = "请求返回数据",name = "data")private T data;private String requestId;public DataResponse() {}public DataResponse(T data) {this.data = data;}public DataResponse(T data, int errorCode) {this.data = data;this.errorCode = errorCode;}public int getErrorCode() {return this.errorCode;}public void setErrorCode(int errorCode) {this.errorCode = errorCode;}public T getData() {return this.data;}public void setData(T data) {this.data = data;}public String getMessage() {return this.message;}public void setMessage(String message) {this.message = message;}public Map<String, Object> getExtInfo() {return this.extInfo;}public void setExtInfo(Map<String, Object> extInfo) {this.extInfo = extInfo;}public String getResultCode() {return this.resultCode;}public void setResultCode(String resultCode) {this.resultCode = resultCode;}public boolean isError() {return this.errorCode != 0;}public String getRequestId() {return this.requestId;}public void setRequestId(String requestId) {this.requestId = requestId;}public String toString() {StringBuilder builder = new StringBuilder();builder.append("DataResponse [errorCode=");builder.append(this.errorCode);builder.append(", ");if (this.resultCode != null) {builder.append("resultCode=");builder.append(this.resultCode);builder.append(", ");}if (this.message != null) {builder.append("message=");builder.append(this.message);builder.append(", ");}if (this.extInfo != null) {builder.append("extInfo=");builder.append(this.extInfo);builder.append(", ");}if (this.data != null) {builder.append("data=");builder.append(this.data);builder.append(", ");}if (this.requestId != null) {builder.append("requestId=");builder.append(this.requestId);}builder.append("]");return builder.toString();}
}

自然我们也需要个请求头

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
import java.io.Serializable;
import java.util.Date;
import java.util.HashMap;
import java.util.Map;@ApiModel(value = "DataRequest",description = "请求"
)
public abstract class DataRequest<T> implements Serializable {private static final long serialVersionUID = -7574544066074667453L;@ApiModelProperty(value = "请求数据",name = "data")private T data;@ApiModelProperty(value = "附加信息",name = "extInfo")private Map<String, String> extInfo = new HashMap();@ApiModelProperty(value = "附加动作",name = "action")private String action;private String username;private String requestId;private Date requestTime;private String security;public DataRequest() {}public T getData() {return this.data;}public void setData(T data) {this.data = data;}public Map<String, String> getExtInfo() {return this.extInfo;}public void setExtInfo(Map<String, String> extInfo) {this.extInfo = extInfo;}public String getAction() {return this.action;}public void setAction(String action) {this.action = action;}public String toString() {StringBuilder builder = new StringBuilder();builder.append("DataRequest [");if (this.data != null) {builder.append("data=");builder.append(this.data);builder.append(", ");}if (this.extInfo != null) {builder.append("extInfo=");builder.append(this.extInfo);builder.append(", ");}if (this.action != null) {builder.append("action=");builder.append(this.action);}builder.append("]");return builder.toString();}public String getUsername() {return this.username;}public void setUsername(String username) {this.username = username;}public String getSecurity() {return this.security;}public void setSecurity(String security) {this.security = security;}public String getRequestId() {return this.requestId;}public void setRequestId(String requestId) {this.requestId = requestId;}public Date getRequestTime() {return this.requestTime;}public void setRequestTime(Date requestTime) {this.requestTime = requestTime;}
}

3.快速上手retrofit

如果你学习过springboot，那么你对接下来这一套不要太熟悉，我们先来一个最简单的不带参get请求熟悉一下

a.接口

首先我们来一个Retrofit标准的接口

public interface ITestService {@GET("/test")Call<DefaultResponse<Object>> get();
}

其中
“/test”
代表我们与后台约定的路径；
DefaultResponse
代表我们与后台约定的发返回体
@GET
注解代表我们与后台约定这是一个get请求的注解；
Call方法
是我们需要了解的重中之重
retrofit2中的call方法源代码如下
在这里插入图片描述
翻译过来大概意思是该方法向Web服务器发送请求并返回响应，每个调用都会产生自己的HTTP请求和响应对。其他的方法一般用的不多，重点是execute()和enqueue(Callback callback)，稍后我们会有示例

//execute同步执行请求Response<T> execute() throws IOException;
//enqueue异步执行请求void enqueue(Callback<T> callback);
//无论是哪种情况，都可以随时使用cancel取消通话。void cancel();
//使用clone对同一Web服务器进行多个参数相同的调用；这可用于实现轮询或重试失败的呼叫。Call<T> clone();

call接口的实现在源码的OkHttpCall中，这说明retrofit确实是基于OkHttp的，我们以execute()为例

  @Override public Response<T> execute() throws IOException {okhttp3.Call call;synchronized (this) {if (executed) throw new IllegalStateException("Already executed.");executed = true;if (creationFailure != null) {if (creationFailure instanceof IOException) {throw (IOException) creationFailure;} else {throw (RuntimeException) creationFailure;}}call = rawCall;if (call == null) {try {call = rawCall = createRawCall();} catch (IOException | RuntimeException e) {creationFailure = e;throw e;}}}if (canceled) {call.cancel();}return parseResponse(call.execute());}

至于为什么同步方法要抛异常，这是因为同步请求可能忙于写请求或读取响应的呼叫，这时就会抛出异常

b.实现

然后我们实现我们写的ITestService 接口，当然，这也是最简单的方式，并且这和springboot有一些区别

//这是后台的url
String url = "xxxxxxxxx"
Retrofit retrofit = new Retrofit.Builder().baseUrl(url).build();ITestService service = retrofit.create(ITestService .class);

c.execute()和enqueue(Callback callback)

最后我们来调用我们写的第一个接口，前面说了，有两种方式

Call<DefaultResponse<Object>> responseCall = service .get()
//同步
try {
Response<DefaultResponse<Object>> responseResponse = responseCall.execute();
//判断请求是否成功if (responseResponse.isSuccessful()){DefaultResponse<Object> response = responseResponse.body();}
}catch (IOException e) {e.printStackTrace();}//异步
responseCall.enqueue(new Callback<DefaultResponse<Object>>() {@Overridepublic void onResponse(Call<DefaultResponse<Object>> call, Response<DefaultResponse<Object>> response) {//成功的回调}@Overridepublic void onFailure(Call<DefaultResponse<Object>> call, Throwable t) {//失败的回调}});

这样，我们就能拿到后台接口的返回，这只是帮助你理解retrofit的模式，接下来，我们来深入了解一下其他的用法。

二、更多用法（注解介绍）🚲

之前我们展示了最简单的Get请求，并了解到可以使用@GET注解
如果你要使用别的请求，retrofit也提供了相对应的注解,可以满足我们的需求，甚至可以定制化请求，十分方便快捷。

1.八种请求注解

注解作用
@GETget请求
@POSTpost请求
@PUTput请求
@DELETEdelete请求
@OPTIONSOPTIONS请求
@PATCHPATCH请求
@HEADHEAD请求
@HTTP是上面注解的总和，可以实现上面所有请求，并可以拓展
下面是代码一些代码示例：

@GET

//如果你的get请求想要带参数，你可以加上@Query@GET("/test")Call<DefaultResponse<Object>> get(@Query("id") String id);

@POST

	//post请求带请求体,加上@Body@POST("/test")	Call<DefaultResponse<Object>> post(@Body DataRequest request );

@PUT

	@PUT("/test")	Call<DefaultResponse<Object>> put(@Body DataRequest request );

@DELETE

	@DELETE("/test")	Call<DefaultResponse<Object>> delete(@Body DataRequest request );

@HTTP

	  /*** method：网络请求的方法（区分大小写）* path：网络请求地址路径* hasBody：是否有请求体*/@HTTP(method = "GET", path = "blog/{id}", hasBody = false)Call<DefaultResponse<Object>> gethttp(@Path("id") int id);// {id} 表示是一个变量，@Path是他的路径// method 的值 retrofit 不会做处理，所以要自行保证准确

@OPTIONS与 @PATCH由于篇幅原因不多做示例

2.四种标记注解

注解作用
@Headers使用 @Headers 注解设置固定的请求头，所有请求头不会相互覆盖，即使名字相同。
@FormUrlEncoded表示发送form-encoded的数据，每个键值对需要用@Filed来注解键名，随后的对象需要提供值。
@Multipart表示发送form-encoded的数据（适用于 有文件 上传的场景），每个键值对需要用@Part来注解键名，随后的对象需要提供值。
@Streaming表示返回的数据将以流来返回,默认是载入内存的

注解太多了，下面的代码示例为官网示例

@Headers

@Headers("Cache-Control: max-age=640000")
@GET("widget/list")
Call<List<Widget>> widgetList();
@Headers({"Accept: application/vnd.github.v3.full+json","User-Agent: Retrofit-Sample-App"
})

@FormUrlEncoded

@FormUrlEncoded
@POST("user/edit")
Call<User> updateUser(@Field("first_name") String first, @Field("last_name") String last);

@Multipart

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

@Streaming由于篇幅原因不多做示例

3.十二个参数注解

@Url
@Path
@Query @QueryName @QueryMap
@Header @HeaderMap
@Field @FieldMap
@Part @PartMap
@Body
这十二个参数注解是搭配上面的八种请求注解使用的，上面的示例代码也有部分使用到，有各种用途，这里以@Path为例。

注解作用
@Path接收一个字符串表示接口 path ，与 baseUrl 组成完整的 Url

@Path

@GET("users/{username}")
Call<User> getUser(@Path("username") String username);

三、进阶使用🚄

在初识retrofit中，我们了解了retrofit的基本构造方法和使用，但如果要实际运用到项目当中，那么简单的使用方法还不够，因为在实际项目中不可能每一个请求都像我们开始那样写一遍，所以我们要自己封装更好的

1.RetrofitService

这是我们一开始的使用方法，url一般是不会变的

//这是后台的url
String url = "xxxxxxxxx"
Retrofit retrofit = new Retrofit.Builder().baseUrl(url).build();

正如前言，这太low了，你拿这个跟别人说你会retrofit,大佬们看到了都会笑的,就像这样
在这里插入图片描述
所以我们需要RetrofitService
让我们基于之前的代码加上一点点的改动

public class RetrofitService {
private static RetrofitService i;
private Retrofit retrofit;
private  String url = "xxxxxxxxx"public static RetrofitService i() {if (i == null) {i = new RetrofitService();}return i;}private RetrofitService() {try {retrofit = new Retrofit.Builder().baseUrl(url).build();}catch (Exception e){Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());}}public <T> T create(Class<T> clazz) {return retrofit.create(clazz);}}//当我们需要使用的时候，后面的使用方式是相同的哦
ITestService api = RetrofitService.i().create(ITestService .class);

2.ConverterFactory

只有一个单例模式的RetrofitService还远远不够，我们再在基础的构造方法中加一个全局的date类型转换，我们以Jackson为例，改动RetrofitService()方法

     private RetrofitService() {try {ObjectMapper objectMapper = new ObjectMapper();objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);JacksonConverterFactory jacksonConverterFactory = JacksonConverterFactory.create(objectMapper);retrofit = new Retrofit.Builder().baseUrl(url)//设置全局date类型转换.addConverterFactory(jacksonConverterFactory).build();}catch (Exception e){Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());}}

3.OkHttpClient

有了类型转换，又怎么能没有超时时间和intercept呢？，这里使用了OkHttpClient，我们在RetrofitService中加入了如下改动


private static final OkHttpClient client = new OkHttpClient.Builder()//设置超时时间.connectTimeout(30, TimeUnit.SECONDS).readTimeout(30, TimeUnit.SECONDS)//设置https证书.sslSocketFactory(HttpsUtils.getSslSocketFactory(null,null,null)).hostnameVerifier(new HostnameVerifier() {@Overridepublic boolean verify(String hostname, SSLSession session) {return true;}}).writeTimeout(30, TimeUnit.SECONDS).addInterceptor(new Interceptor() {@Overridepublic Response intercept(Chain chain) throws IOException {Request.Builder builder = chain.request().newBuilder();//添加头builder.addHeader("token", 111222333);Request request = builder.build();return chain.proceed(request);}}).build();private RetrofitService() {try {ObjectMapper objectMapper = new ObjectMapper();objectMapper.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);JacksonConverterFactory jacksonConverterFactory = JacksonConverterFactory.create(objectMapper);retrofit = new Retrofit.Builder().baseUrl(url)//设置超时时间,intercept.client(client)//设置全局date类型转换.addConverterFactory(jacksonConverterFactory).build();}catch (Exception e){Log.e("RetrofitService", "RetrofitService: "+url+" ExceptionMessage: "+e.getMessage());}}

至此，一个Retrofit工具类完成，如果你需要更多功能可以阅读Retrofit.java的源码
如果你想了解更多retrofit的基础用法，这里有官方的文档和供你参考

retrofit官网.

这篇关于android retrofit 从无知到入门的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


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

相关文章

MySQL DQL从入门到精通

MySQL DQL从入门到精通

《MySQLDQL从入门到精通》通过DQL,我们可以从数据库中检索出所需的数据,进行各种复杂的数据分析和处理,本文将深入探讨MySQLDQL的各个方面,帮助你全面掌握这一重要技能,感兴趣的朋友跟随小... 目录一、DQL 基础：SELECT 语句入门二、数据过滤：WHERE 子句的使用三、结果排序：ORDE
阅读更多...
Android学习总结之Java和kotlin区别超详细分析

Android学习总结之Java和kotlin区别超详细分析

《Android学习总结之Java和kotlin区别超详细分析》Java和Kotlin都是用于Android开发的编程语言,它们各自具有独特的特点和优势,：本文主要介绍Android学习总结之Ja... 目录一、空安全机制真题 1：Kotlin 如何解决 Java 的 NullPointerExceptio
阅读更多...
Python中OpenCV与Matplotlib的图像操作入门指南

Python中OpenCV与Matplotlib的图像操作入门指南

《Python中OpenCV与Matplotlib的图像操作入门指南》：本文主要介绍Python中OpenCV与Matplotlib的图像操作指南,本文通过实例代码给大家介绍的非常详细,对大家的学... 目录一、环境准备二、图像的基本操作1. 图像读取、显示与保存 使用OpenCV操作2. 像素级操作3.
阅读更多...
Android NDK版本迭代与FFmpeg交叉编译完全指南

Android NDK版本迭代与FFmpeg交叉编译完全指南

《AndroidNDK版本迭代与FFmpeg交叉编译完全指南》在Android开发中,使用NDK进行原生代码开发是一项常见需求,特别是当我们需要集成FFmpeg这样的多媒体处理库时,本文将深入分析A... 目录一、android NDK版本迭代分界线二、FFmpeg交叉编译关键注意事项三、完整编译脚本示例四
阅读更多...
Android与iOS设备MAC地址生成原理及Java实现详解

Android与iOS设备MAC地址生成原理及Java实现详解

《Android与iOS设备MAC地址生成原理及Java实现详解》在无线网络通信中,MAC（MediaAccessControl）地址是设备的唯一网络标识符,本文主要介绍了Android与iOS设备M... 目录引言1. MAC地址基础1.1 MAC地址的组成1.2 MAC地址的分类2. android与I
阅读更多...
POI从入门到实战轻松完成EasyExcel使用及Excel导入导出功能

POI从入门到实战轻松完成EasyExcel使用及Excel导入导出功能

《POI从入门到实战轻松完成EasyExcel使用及Excel导入导出功能》ApachePOI是一个流行的Java库,用于处理MicrosoftOffice格式文件,提供丰富API来创建、读取和修改O... 目录前言:Apache POIEasyPoiEasyExcel一、EasyExcel1.1、核心特性
阅读更多...
Android 实现一个隐私弹窗功能

Android 实现一个隐私弹窗功能

《Android实现一个隐私弹窗功能》：本文主要介绍Android实现一个隐私弹窗功能,本文通过实例代码给大家介绍的非常详细,感兴趣的朋友一起看看吧... 效果图如下：1. 设置同意、退出、点击用户协议、点击隐私协议的函数参数2. 《用户协议》、《隐私政策》设置成可点击的，且颜色要区分出来res/l
阅读更多...
Android实现一键录屏功能(附源码)

Android实现一键录屏功能(附源码)

《Android实现一键录屏功能(附源码)》在Android5.0及以上版本,系统提供了MediaProjectionAPI,允许应用在用户授权下录制屏幕内容并输出到视频文件,所以本文将基于此实现一个... 目录一、项目介绍二、相关技术与原理三、系统权限与用户授权四、项目架构与流程五、环境配置与依赖六、完整
阅读更多...
Android 12解决push framework.jar无法开机的方法小结

Android 12解决push framework.jar无法开机的方法小结

《Android12解决pushframework.jar无法开机的方法小结》：本文主要介绍在Android12中解决pushframework.jar无法开机的方法,包括编译指令、框架层和s... 目录1. android 编译指令1.1 framework层的编译指令1.2 替换framework.ja
阅读更多...
Android开发环境配置避坑指南

Android开发环境配置避坑指南

《Android开发环境配置避坑指南》本文主要介绍了Android开发环境配置过程中遇到的问题及解决方案,包括VPN注意事项、工具版本统一、Gerrit邮箱配置、Git拉取和提交代码、MergevsR... 目录网络环境：VPN 注意事项工具版本统一：android Studio & JDKGerrit的邮
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2