这篇文章旨在分享学习 Retrofit 的一些心得,由于我接触安卓开发不到一个月,这篇文章的分享对象是那些初学安卓开发,又没有学习过网络请求的新手。就更不敢妄谈“教程”、“经验”这些字眼,只能说把我的学习路程分享给大家,以供参考。
如果有哪些地方不正确,也请大家多多指教。
主要参考:这是一份很详细的 Retrofit 2.0 使用教程(含实例讲解)
我希望它能帮助你更快的上手 Retrofit ,但由于个人能力有限,所涉及内容都十分之基础,甚至有些粗浅。不过我会随着我的学习不定期更新这篇文章。
希望它能对你有帮助。
一、什么是Retrofit
Retrofit 是一个 RESTful 的 HTTP 网络请求框架的封装(基于OkHttp)。
如果你和我一样是一个新手,那你应该和我一样看到这行文字是一脸懵逼的。
什么是 RESTful ??什么是 HTTP ??(这玩意儿除了输网址的时候能看到过几次,平时对它一点了解都没有)什么是 OkHttp ??
这个时候,我们先试着把这句话精简一下:
Retrofit 是一个网络请求框架的封装。
这样看是不是好理解一些?说到底,Retrofit 的作用就是进行网络请求。
那什么是网络请求?
按照我的理解,网络请求就是向服务器 发送/接收 数据 的一个过程。这个技术在生活中无处不在,比如,你登录一下微信,App 就要把你输入的 账号、密码 发送到服务器,然后再从服务器中接收你的 好友列表、账号头像……等等数据。这就是网络请求。
学习 Retrofit 主要就是为了实现 网络请求 这一功能。
二、如何实现 Retrofit ?
1.添加库的依赖
Retrofit 是一个网络请求框架的封装。
既然是封装,我们实现 Retrofit 的第一步当然是添加 Retrofit库 的依赖。
在 app/build.grandle 中,添加这么几行:
applyplugin:'com.android.application'
......
dependencies {
......
implementation'com.squareup.retrofit2:retrofit:2.4.0'
implementation'com.squareup.okhttp3:okhttp:3.4.1'
}
又因为是网络请求,肯定还要有网络权限,是吧?
在 AndroidManifest 中添加如下代码:
<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.klouse.retrofittest">
<uses-permission android:name="android.permission.INTERNET" />
......
</manifest>
2.创建 接收服务器返回数据 的类
我们在实现网络请求这个功能,就绕不过数据。
以一段 JSON格式 的数据为例,我们来看一看。
{"status":true,"message":"成功","data":[{"username":"测试1","password":"8887","birthday":"8886"},{"username":"测试2","password":"1887","birthday":"1886"}]}
这个是服务器上的数据,我们要要接收这些数据,那么就肯定要创建一个类来接收这些数据。
对上列数据也可以进行一个简单的总结归纳,就可以创建出这么一个类:
public class AceptData {
private String status;
private String message;
private RetrofitData[] data;
private static class RetrofitData {
private String username;
private String password;
private String birthday;
}
}
接收收数据的类是有了,那怎么接收数据?
3.创建 用于描述网络请求 的接口
public interface GetRequest_Interface {
@GET("phpapi/test_api.php")
Call<AceptData> getCall();
}
你看,利用泛型,接收数据这个操作简单的不行。
至于 @GET 则是一种网络请求方法,看英文就知道这个方法目的是接收数据(没有其他操作了)。而括号中的内容则在下一步说明。
当然还有 @POST 、@PUT 等共 8种 请求,已经有贴子把这方面介绍的十分详尽了,这里就不介绍了。
4.创建 Retrofit 实例
数据处理完了,我们应该去在程序中实现它了。
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("http://119.29.134.162/") // 设置 网络请求 Url
.addConverterFactory(GsonConverterFactory.create()) //设置使用Gson解析(记得加入依赖)
.build();
上面这一段代码 baseUrl() 中的内容和之前 @GET() 中的内容结合在一起就正好是一个网址!
这两个请求放在一起就很好理解了,就是在对这个 网址 进行 网络请求 。
至于为什么这么写,我觉得这么做相较于放整个目录来说,可以对多目录进行编辑,让写程序更方便。
而 addConverterFactory(GsonConverterFactory.create()) 就是将网络数据格式装换为我们想要的数据格式,我这里转化的是 JSON格式,所以还要在 app/build.grandle 中,刚才的依赖下添加上这一句:
applyplugin:'com.android.application'
......
dependencies {
......
implementation'com.squareup.retrofit2:converter-gson:2.4.0'
}
5.创建 网络请求接口实例
GetRequest_Interface request = retrofit.create(GetRequest_Interface.class); // 创建实例
Call<AceptData> call = request.getCall(); // 对 发送请求 进行封装
这段就不用多说了吧?就向我们建立一个按钮就要写 "Button button = ....." 一样,Retrofit 也需要创建一个这样的实例。
6.发送网络请求(异步 / 同步)并处理接收数据
我们看到标题中有两个不熟悉的词汇,同步 与 异步。关于这个,我在网上找到这段话:
通信的同步:指客户端在发送请求后,必须要在服务端有回应后客户端才继续发送其他请求,所以这时所有请求将会在服务端得到同步,直到服务端返回请求。
通信的异步:指客户端在发送请求后,不必等待服务端的回应就可以发送下一个请求,对所有的请求动作来说将会在服务端得到异步,这条请求的链路就像是一个请求队列,所有的请求动作在这里不会得到同步。
总结一下上面的话,对于 同步 与 异步,他们最大的区别是:客户端发送请求后,进行下一请求之前等不等服务器回应。如果等,那么客户端与服务端同步,不等就是不同步。
精简以后:
同步:下一个线程需要上一个线程的数据,没有上一个线程下一个线程无法运行。
异步:两个线程可能有数据交换,但是各自独自运行,相互之间没有影响。
更详细的:Android 同步异步区别
所以选择同步还是异步具体还是要视情况而定。现在再看代码:
//发送网络请求(异步)
call.enqueue(new Callback<AceptData>() {
//请求成功时回调
@Override
public void onResponse(Call<AceptData> call, Response<AceptData> response) {
//请求处理,输出结果
response.body().show();
}
//请求失败时候的回调
@Override
public void onFailure(Call<AceptData> call, Throwable throwable) {
System.out.println("连接失败");
}
});
// 发送网络请求(同步)
Response<Reception> response = call.execute();
// 对返回数据进行处理
response.body().show();
在请求成功中,我们可以加入相关方法对接收的数据进行处理。这里是通过 response类 的 body()对返回的数据进行处理。
而方法 show() 则在接收数据的类中创建,代码如下:
public class AceptData {
......
public void show(){ // 向日志输出得到的数据
Log.i("MainActivity","Status is "+status);
Log.i("MainActivity","Message is "+message);
Log.i("MainActivity","Username is "+data[0].username);
Log.i("MainActivity","Password is "+data[0].password);
Log.i("MainActivity","Birthday is "+data[0].birthday);
Log.i("MainActivity","Username is "+data[1].username);
Log.i("MainActivity","Password is "+data[1].password);
Log.i("MainActivity","Birthday is "+data[1].birthday);
}
}
经过这些步骤,一个最基本的 Retrofit 就实现了,我们运行一下程序看看结果。
当然网络请求方式不止 Retrofit 一种,但 Retrofit 应该是近年来最好用的了,而之前广泛使用的 OkHttp 上还要管理线程,自然是不如 Retrofit 的。
源码稍后补充……