前言
之前做的项目都是用okhttp框架来进行网络请求的,然后自己自行封装,虽然以前也有使用过Retrofit,但是Retrofit本质上还是对okhttp的封装,而且面试的时候也会经常的Retrofit框架的使用和原理以及它内部使用的设计模式之类的,这篇文章主要讲述如何使用Retrofit请求框架,以及一些使用的细节,毕竟是一个很灵活的使用框架,后续在写一篇关于Retrofit的源码解析和使用了哪些设计模式。
Retrofit的导入
我们主要以是2.0版本来进行讲解,第一个是Retrofit,第二个是Retrofit的Json解析,至于有什么用后面就知道了,当然换成别的Json解析也是可以的
implementation 'com.squareup.retrofit2:retrofit:2.5.0'
implementation 'com.squareup.retrofit2:converter-gson:2.5.0'
还有网络权限也要记得添加:
<uses-permission android:name="android.permission.INTERNET" />
Call接口
首先它需要一个请求的Call接口来进行请求,Retrofit使用注解的方式来区分是Get请求还是Post请求等等之类的,比如:
public interface ApiService {
@GET(".")
Call<ResponseBody> get();
}
这就是一个很简单的get请求的接口,泛型是你要返回的Model数据的类型,当然如果你的请求地址是动态的话,可以这么写:
@GET("api/{path}")
Call<ResponseBody> get(@Path("path")int path);
Post请求的话可以这么写:
@FormUrlEncoded
@POST(".")
Call<ResponseBody> post(@Field("ip") String first);
@FormUrlEncoded
表示这是一个表单的请求,传输数据类型为键值对,使用@Field注解来标示所对应的String类型数据的键,从而组成一组键值对进行传递。
当然还有其它的注解:
字段注解代码如图,侵删
这里需要注意的是在
@GET
或者@POST
的括号里面如果没有要请求的URL的话,是不能空着的,空的话默认写 . 或者 / 都是可以的,如果是空的话则会报错:Call接口报错如图
创建Retrfit客户端对象
//创建Retrfit
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://wanandroid.com/wxarticle/chapters/json/")
.addConverterFactory(GsonConverterFactory.create())
.build();
通过Retrofit的Builder()
构建者模式可以快速构建客户端以及所需要的配置,addConverterFactory()
这个方法就是配置你要用哪个Gson对返回的数据进行解析。没错,这也是为什么要在Call设置泛型的原因,Retrofit是会自动进行Json解析的,然后最后返回的结果就是解析后的Response实体,这样就不用另外写解析Json的业务逻辑,大大节省了代码的行数。
这里有一个非常需要注意的点!这里填入的baseUrl()
是公共的Url,后面就是跟着你自己定义接口路径的Url,这里的baseUrl()
填的Url结尾一定要跟一个 / ,否则它也是会报错的(PS:这里用的请求接口是“玩Android 开放API”的公共API)。
Retrofit的异步请求
//用Retrofit创建接口实例对象
ApiService apiService = retrofit.create(ApiService.class);
//获取Call对象
Call<DataModel> call = apiService.get();
//开始异步操作
call.enqueue(new Callback<DataModel>() {
@Override
public void onResponse(Call<DataModel> call, Response<DataModel> response) {
Toast.makeText(MainActivity.this, response.body().getData().get(0).getName(), Toast.LENGTH_SHORT).show();
b1.setText("请求完毕更新UI");
}
@Override
public void onFailure(Call<DataModel> call, Throwable t) {
}
});
接下来就跟okhttp的请求差不多,通过Retrofit客户端创建一个接口的实例对象,然后通过Call进行获取,最后使用enqueue()
来进行异步请求返回一个Callback的回调接口,回调接口的泛型就是Retrofit客户端Json解析后的Model。
这里我们发现了,我们是可以在回调回来的接口里面进行直接更新UI的操作的,这也就代表回调回来的接口是在主线程上面的,不像okhttp那样回调回来的接口还是在子线程上,我们还需要通过Handler来进行更新UI的操作。
返回原始Json字段
刚刚也说了,Retrofit返回过来的是已经经过Json解析过的Response对象,但是有时候Json字段是不断更新的话,你的Model也要进行相应的更新,这就需要返回原始的字段了,Retrofit本身没提供这个方法,但是毕竟是封装okhttp,它是可以返回原始的Json字段的。
@GET(".")
Call<ResponseBody> get();
//创建Retrfit
Retrofit retrofit = new Retrofit.Builder()
.baseUrl("https://wanandroid.com/wxarticle/chapters/json/")
.addConverterFactory(GsonConverterFactory.create())
.build();
//用Retrofit创建接口实例对象
ApiService apiService = retrofit.create(ApiService.class);
//获取Call对象
Call<ResponseBody> call = apiService.get();
//开始异步操作
call.enqueue(new Callback<ResponseBody>() {
@Override
public void onResponse(Call<ResponseBody> call, Response<ResponseBody> response) {
String json = null;
try {
json = response.body().string();
}catch (Exception e){
e.printStackTrace();
}
Toast.makeText(MainActivity.this, json, Toast.LENGTH_SHORT).show();
b1.setText("请求完毕更新UI");
}
@Override
public void onFailure(Call<ResponseBody> call, Throwable t) {
}
});
其实只要把Call要传入的泛型接口改成ResponseBody就好了,对应的回调接口也要改成ResponseBody,ResponseBody是okhttp的Response的返回体,所以就可以通过string()
方法返回就好了。
网友评论