二次封装OKHttp网络框架(1)
1. 框架功能简介:暂时只有get、post两个请求
2. 请求的主要流程和区别:
2.1 get请求:
(1)创建请求客户的 OkHttpClient对象
(2)创建请求构建器 Request.Bulder builder = new Request.Builder().url(...). build();
(3)创建请求对象:Request request = builder.build();
(3)创建请求任务 Call call
(4)发起异步请求:call.enqueue(new CallBack(){...});
2.2 post请求
(1)创建请求客户的 OkHttpClient对象
(2)创建请求构建器 Request.Builder builder = new Request.Builder().url(...). build();
(3)创建表单实体构建器:FormBody.Builder mFormBuilder
(4)创建表单实体对象:FormBody body
(5)创建请求对象:Request request = builder.post(body);
(6)创建请求任务:Call call
(7)发起异步任务:call.enqueue(new CallBack(){...});
2.3 两者区别
请求构建器 builder 与请求对象request之间,post需要创建请求实体,并在请求实体中添加参数——封装的框架需要考虑两者区别,处理好复用代码和分别处理
3. 代码
/**
*OkHttp的二次封装
*get请求、post请求
* 客户端异步发起请求,(url(), targetClass(), 调用接口等)——OkUtils通过Handler返回结果
*/
public class OkUtils<T>{
private static final String UTF_8 = "utf-8";
private static final int RESULT_SUCCESS = 0;
private static final int RESULT_ERROR =1;
private StringBuilder mUrl;
private OkHttpClient mOkHttpClient; // 单例模式
private Handler mHandler;
private OnCompleteListener<T> mListener;
// 地址栏请求
private StringBuilder mUrl;
// 泛型,目标解析类
private Class mClaz;
// post表单body构造器
private FromBody.Builder mFormBuilder;
// 对外提供接口:客户端向服务端发送请求、处理返回结果的接口
public interface OnCompleteListener<T>{
void onSuccess(T t);
void onError(String error);
}
// 构造方法,单例模式初始化mOkHttpClient
pubic OkUtils(Context context){// 注意参数要有
if(mOkHttpClient == null){
synchronized(OkUtils.class){
if(mOkHttpClient == null){
mOkHttpClient = new OkHttpClient();
}
}
}
initHandler(context);
}
private void initHandler(Context context){
mHandler = new Handler(context.getMainLooper){
@override
public void handleMessage(Message msg){
super.handleMessage(msg);
switch(msg.what){
case RESULT_SUCCESS:
if(mListener != null && msg.obj != null){
T t = (T) mst.obj;
mListener.onSuccess(t);
}
break;
case RESULT_ERROR:
if(mListener != null && msg.obj != null){
mListener.onError(msg.obj.toString());
}
break;
}
}
};
}
// 地址栏请求
public OkUtils<T> url(StringBuilder url){
mUrl = new StringBuilder(url);
return this;
}
// 创建post表单body构建器
public OkUtils<T> post(){
mFormBuilder = new FormBody.Builder();
return this;
}
// 目标解析类
public OkUtils<T> targetClass(Class claz){
mClaz = claz;
}
// 添加参数
public OkUtils<T> addParam(String key, String value){
if(mFormBuilder != null){ // post请求的参数添加方式
mFormBuilder.add( key, URLEncoder.encode(value, UTF_8));
}else{// get请求的参数添加方式
if(mUrl.indexOf("?") == -1){
mUrl.apend("?");
}else{
mUrl.apend("&");
}
mUrl.append(key).append("=").append(URLEncoder.encode(value, UTF_8)); // 注意此处需要抛异常,已省略。编辑代码时会遇到。
}
return this;
}
public void execute(OnCompleteListener listener){
mListener = listener;
// 校验 mUrl,参数,mClaz是否符合发送请求的要求
if( mUrl == null){
Message msg = Message.obtain();
msg.what = RESULT_ERROR;
msg.obj = "url不能为空";
mHandler.sendEmptyMessage(msg);
return;
}
if( mUrl.indexOf("?" == -1){
Message msg = Message.obtain();
msg.what = RESULT_ERROR;
msg.obj = "请设置请求参数";
mHandler.sendEmptyMessage(msg);
}
if( mClaz == null){
Message msg = Message.obtain();
msg.what = RESULT_ERROR;
msg.obj = "解析目标类claz不能为空";
mHandler.sendEmptyMessage(msg);
return;
}
// 创建请求构建器
Request.Builder builder = new Request.Builder().url(mUrl.toString);
if(mFormBuilder != null){ // post请求,创建表单实体
FormBody body = mFormBuilder.build();
builder.post(body);
}
Request request = builder.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(new CallBack(){
@override
public void onFailure(Call call, IOException e){
Message msg = Message.obtain();
msg.what = RESULT_ERROR;
msg.obj = e.toString();
mHandler.sendMessage(msg);
}
@override
public void onResponse(Call call, Response response) throws IOExcepton{
String json = response.body().string();
T t = (T)ResultUtils.getResultFromJson(json, mClaz); // ResultUtils 是一个工具类,解析json数据,如果需要请留言
Message msg = Message.obtain();
msg.what = RESULT_OK;
msg.obj = t;
mHandler.sendMessage(msg);
}
});
}
public static void release(){
if( mOkHttpClient != null) {
mOkHttpClient.dispatcher().cancel();
mOkHttpClient == null;
}
}
}
到此,一个基本的OkHttp就封装好了,其他的诸如上传文件、下载文件等功能,下次整理。