Android中okhttp网络请求的封装
目前okhttp已经更新到了3.6版本,从3.0版本开始okhttp自带了一个线程,所以我们在使用时不需要开子线程。
在studios里使用okhttp之前,要添加依赖和权限。
依赖:
compile 'com.squareup.okhttp3:okhttp:3.6.0'
权限:
<uses-permission android:name="android.permission.INTERNET"/>
一、okhttp最简单的写法
//请求服务器的地址
String url = "http://www.mtime.com/";
//创建okhttp端口
OkHttpClient okHttpClient = new OkHttpClient();
//创建要发送的求情(这里创建的是没有参数的GET请求)
Request request = new Request.Builder().url(url).build();
Call call = okHttpClient.newCall(request);
//CallBack是请求回调
call.enqueue(new Callback() {
@Override
//请求失败执行的方法
public void onFailure(Call call, IOException e) {
//这里的失败指的是没有网络请求发送不出去,或者请求地址有误找不到服务器这类情况
//如果服务器返回的是404错误也说明请求到服务器了,属于请求成功的情况,要在下面的方法中处理
}
@Override
//请求成功执行的方法
public void onResponse(Call call, Response response) throws IOException {
//请求成功以后的操作在这个方法里执行,并且这是个子线程,不能做更新界面的操作
runOnUiThread(new Runnable() {
@Override
public void run() {
//如果有更新UI的操作,需要自己写runOnUiThread这一类的方法去执行
}
});
}
});
我们在项目中有很多页面都需要请求网络,并且每次请求网络的时候访问的地址也有所不同,为了方便使用和后期维护,这时候就需要将网络请求的代码进行单独的封装。
二、okhttp的三层封装
1、创建OkHttpClient对象并初始化的封装。
在整个项目中我们只需要一个OkHttpClient对象,不同的网络请求只需要创建不同的Requset对象和Call对象。所以我们将OkHttpClient对象的创建写成单例模式。
我们自己写一个网络请求的类NetClient。
public class NetClient {
private static NetClient netClient;
private NetClient(){
client = initOkHttpClient();
}
public final OkHttpClient client;
private OkHttpClient initOkHttpClient(){
//初始化的时候可以自定义一些参数
OkHttpClient okHttpClient = new OkHttpClient.Builder()
.readTimeout(10000, TimeUnit.MILLISECONDS)//设置读取超时为10秒
.connectTimeout(10000, TimeUnit.MILLISECONDS)//设置链接超时为10秒
.build();
return okHttpClient;
}
public static NetClient getNetClient(){
if(netClient == null){
netClient = new NetClient();
}
return netClient;
}
}
当第一次使用NetClient类时,NetClient的对象被创建,并且始终只有一个实例,okHttpClient作为NetClient对象的成员变量,也只有一个实例。
2、发送网络请求的封装
每次发送网络请求执行的方法都一样,只是参数不同,所以我们就可以将这些方法也封装进NetClient类中,方法参数由外部传入即可。在NetClient类中定义一个方法callNet(),发送请求的操作在这里执行,访问服务器需要的地址和请求回调作为方法参数传进去。
public void callNet(String url, Callback callback){
Request request = new Request.Builder().url(url).build();
Call call = getNetClient().initOkHttpClient().newCall(request);
call.enqueue(callback);
}
这时候我们只需要一行代码就能在任意位置发起网络请求:
NetClient.getNetClient().callNet(url, callBack);
如果需要POST请求或者带参数的GET请求,只需要在NetClient类中修改callNet()方法就行。
3、网络请求回调解耦的封装。
我们可以自己定义一个接口MyCallBack,来代理OkHttp的CallBack接口,这样在代码中就不会出现OkHttp的任何东西,方便以后的维护和修改。
public interface MyCallBack {
//链接成功执行的方法
void onFailure(int code);//方法参数用int数据类型,相当于是一个标识
//链接失败执行的方法
void onResponse(String json);//方法参数根据个人需求写,可以是字符串,也可以是输入流
}
这时候再把callNet()方法修改一下
public void callNet(String url, final MyCallBack mCallback){
Request request = new Request.Builder().url(url).build();
Call call = getNetClient().initOkHttpClient().newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
//请求网络失败,调用自己的接口,通过传回的-1可以知道错误类型
mCallback.onFailure(-1);
}
@Override
public void onResponse(Call call, Response response) throws IOException {
//请求网络成功说明服务器有响应,但返回的是什么我们无法确定,可以根据响应码判断
if (response.code() == 200) {
//如果是200说明正常,调用MyCallBack的成功方法,传入数据
mCallback.onResponse(response.body().toString());
}else{
//如果不是200说明异常,调用MyCallBack的失败方法将响应码传入
mCallback.onFailure(response.code());
}
}
});
}
最终我们的网络请求的代码就是这个样子:
String url = "http://www.mtime.com/";
NetClient.getNetClient().callNet(url, new MyCallBack() {
@Override
public void onFailure(int code) {
//依据响应码判断下一步操作
}
@Override
public void onResponse(String json) {
//使用传过来的json数据进行下一步操作
}
});
这种封装思路不仅适用于okhttp,也适用于大多数网络请求。