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。

相关文章

从入门到精通详解Python虚拟环境完全指南

从入门到精通详解Python虚拟环境完全指南

《从入门到精通详解Python虚拟环境完全指南》Python虚拟环境是一个独立的Python运行环境,它允许你为不同的项目创建隔离的Python环境,下面小编就来和大家详细介绍一下吧... 目录什么是python虚拟环境一、使用venv创建和管理虚拟环境1.1 创建虚拟环境1.2 激活虚拟环境1.3 验证虚
阅读更多...
Android协程高级用法大全

Android协程高级用法大全

《Android协程高级用法大全》这篇文章给大家介绍Android协程高级用法大全,本文结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友跟随小编一起学习吧... 目录1️⃣ 协程作用域（CoroutineScope）与生命周期绑定Activity/Fragment 中手
阅读更多...
Java List 使用举例(从入门到精通)

Java List 使用举例(从入门到精通)

《JavaList使用举例(从入门到精通)》本文系统讲解JavaList,涵盖基础概念、核心特性、常用实现（如ArrayList、LinkedList）及性能对比,介绍创建、操作、遍历方法,结合实... 目录一、List 基础概念1.1 什么是 List？1.2 List 的核心特性1.3 List 家族成
阅读更多...
c++日志库log4cplus快速入门小结

c++日志库log4cplus快速入门小结

《c++日志库log4cplus快速入门小结》文章浏览阅读1.1w次，点赞9次，收藏44次。本文介绍Log4cplus，一种适用于C++的线程安全日志记录API，提供灵活的日志管理和配置控制。文章涵盖... 目录简介日志等级配置文件使用关于初始化使用示例总结参考资料简介log4j 用于Java，log4c
阅读更多...
史上最全MybatisPlus从入门到精通

史上最全MybatisPlus从入门到精通

《史上最全MybatisPlus从入门到精通》MyBatis-Plus是MyBatis增强工具,简化开发并提升效率,支持自动映射表名/字段与实体类,提供条件构造器、多种查询方式（等值/范围/模糊/分页... 目录1.简介2.基础篇2.1.通用mapper接口操作2.2.通用service接口操作3.进阶篇3
阅读更多...
Android 缓存日志Logcat导出与分析最佳实践

Android 缓存日志Logcat导出与分析最佳实践

《Android缓存日志Logcat导出与分析最佳实践》本文全面介绍AndroidLogcat缓存日志的导出与分析方法,涵盖按进程、缓冲区类型及日志级别过滤,自动化工具使用,常见问题解决方案和最佳实... 目录android 缓存日志（Logcat）导出与分析全攻略为什么要导出缓存日志？按需过滤导出1. 按
阅读更多...
Python自定义异常的全面指南(入门到实践)

Python自定义异常的全面指南(入门到实践)

《Python自定义异常的全面指南(入门到实践)》想象你正在开发一个银行系统,用户转账时余额不足,如果直接抛出ValueError,调用方很难区分是金额格式错误还是余额不足,这正是Python自定义异... 目录引言：为什么需要自定义异常一、异常基础：先搞懂python的异常体系1.1 异常是什么？1.2
阅读更多...
Python实现Word转PDF全攻略(从入门到实战)

Python实现Word转PDF全攻略(从入门到实战)

《Python实现Word转PDF全攻略(从入门到实战)》在数字化办公场景中,Word文档的跨平台兼容性始终是个难题,而PDF格式凭借所见即所得的特性,已成为文档分发和归档的标准格式,下面小编就来和大... 目录一、为什么需要python处理Word转PDF？二、主流转换方案对比三、五套实战方案详解方案1：
阅读更多...
Spring WebClient从入门到精通

Spring WebClient从入门到精通

《SpringWebClient从入门到精通》本文详解SpringWebClient非阻塞响应式特性及优势,涵盖核心API、实战应用与性能优化,对比RestTemplate,为微服务通信提供高效解决... 目录一、WebClient 概述1.1 为什么选择 WebClient？1.2 WebClient 与
阅读更多...
Android Paging 分页加载库使用实践

Android Paging 分页加载库使用实践

《AndroidPaging分页加载库使用实践》AndroidPaging库是Jetpack组件的一部分,它提供了一套完整的解决方案来处理大型数据集的分页加载,本文将深入探讨Paging库... 目录前言一、Paging 库概述二、Paging 3 核心组件1. PagingSource2. Pager3.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2