---

前言

本文会从零开始介绍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.八种请求注解

注解	作用
@GET	get请求
@POST	post请求
@PUT	put请求
@DELETE	delete请求
@OPTIONS	OPTIONS请求
@PATCH	PATCH请求
@HEAD	HEAD请求
@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 从无知到入门相关推荐

1. Android Retrofit+RxJava 优雅的处理服务器返回异常、错误

   Android Retrofit+RxJava 优雅的处理服务器返回异常.错误 参考文章: (1)Android Retrofit+RxJava 优雅的处理服务器返回异常.错误 (2)https:// ...

2. Android Retrofit @Streaming 注解失效

   Android Retrofit @Streaming 注解失效 问题特征: 即使加了@Streaming方法也不能达到逐步加载大文件数据的效果,产生的效果为下载会有长时间的卡顿,卡顿后,会在极端的时 ...

3. Android Studio2.0 教程从入门到精通Windows版

   系列教程 Android Studio2.0 教程从入门到精通Windows版 - 安装篇 Android Studio2.0 教程从入门到精通Windows版 - 入门篇 Android Studi ...

4. [置顶]树莓派Android Things物联网开发：入门及资料汇总

   [转载请注明出处: http://blog.csdn.net/leytton/article/details/77848430] <树莓派Android Things物联网开发>系列文章专 ...

5. Android高性能ORM数据库DBFlow入门

   DBFlow,综合了 ActiveAndroid, Schematic, Ollie,Sprinkles 等库的优点.同时不是基于反射,所以性能也是非常高,效率紧跟greenDAO其后.基于注解,使用 ...

6. Android Retrofit 2.0文件上传

   Android Retrofit 实现(图文上传)文字(参数)和多张图片一起上传 使用Retrofit进行文件上传,肯定离不开Part & PartMap. public interface ...

7. Android Retrofit下载文件进度

   In this tutorial, we'll create an android application which downloads a file from the URL using Retr ...

8. Android Studio2.0 教程从入门到精通MAC版 - 安装篇

   来自:http://www.open-open.com/lib/view/open1466430392743.html 前言 这个教程你将学会如何使用Android Studio2.0开发Androi ...

9. Android Retrofit 2.0（三）从源码分析原理

   Retrofit·特点 性能最好,处理最快 使用REST API时非常方便: 传输层默认就使用OkHttp: 支持NIO: 拥有出色的API文档和社区支持 速度上比volley更快: 如果你的应用程序 ...

最新文章

1. mysql存储登录密码_当密码存储在选项文件中时,MySQL拒绝登录尝试
2. 《GTA 5》走进现实！AI逼真还原游戏街景，还能“脑补”细节 | 英特尔出品
3. python修改电脑名称_修改计算机名称
4. 手机站点开发及手机中图片加速显示img的Canvas方法
5. Tomcat8.0 JDK1.8 的详细配置 Win10
6. [leetcode] 72. 编辑距离(二维动态规划)
7. 【天池赛事】零基础入门语义分割-地表建筑物识别
8. 依赖注入利器 - Dagger ‡
9. cannot find or load main class org.apache.flink.api.scala.FlinkShell
10. 计算机控制系统第1次作业,计算机控制系统第1次作业86分.doc
11. ApacheCN 安卓译文集 20211225 更新
12. OpenCV学习笔记：创建/分配图像、图像读写保存、图像像素点访问修改
13. Facebook Messenger 被曝漏洞，可导致恶意软件获得持续访问权限（详细分析）
14. python美多商城项目百度网盘_美多商城项目(十)
15. 程序员常识--OJ系统及ACM测试题库大全
16. Java 输入输出流 解决中文乱码问题【不一定详细但一定实用篇】【全文4800字】
17. IT民工金鱼哥从业8年的历程与感悟
18. 云计算三种架构(IaaS, PaaS, SaaS)及部署模型
19. Windows 10 下如何显示文件的后缀名
20. qconshanghai2015

热门文章

1. 《Java黑皮书基础篇第10版》 第10章【习题】
2. 东方木2020浅谈win10系统还原怎么操作
3. 第二届SDN大赛--必答题2
4. Android梅花布局
5. Chu序列的特性及仿真说明(2020_11_3更新)
6. 梦想照进现实｜CSDN 实体奖牌，从“设想”到“现实” 第一期
7. jira在哪创建子任务？
8. 【Unity学习笔记】为什么欧拉角(Euler)会符合万向节(Gimbal)规则？
9. golang延时_Go 定时器/延时触发器
10. 使用计算机生成遐想景物图像,分解反应 (1)概念：由一种反应物生成 或 以上其他物质的反应。 (2)表达式：AB-→A+B (3)特点：一变多——青夏教育精英家教网——...