Android中對OkHttp的封裝使用
阿新 • • 發佈：2018-12-09
一、OkHttp導包：
compile 'com.squareup.okhttp3:okhttp:3.4.1'
compile 'com.squareup.okio:okio:1.9.0'
compile 'com.google.code.gson:gson:2.3.1'二、OkHttpUtils封裝成工具類：
package com.showly.okhttpdemo.http;
import android.content.Context;
import android.os.Handler;
import com.google.gson.Gson;
import 涉及的介面及類：
1、 回撥父類介面
package com.showly.okhttpdemo.http.response;
/**
* 回撥介面父類
*/
public interface IResponseHandler {
void onFailure(int statusCode, String error_msg);
void onProgress(long currentBytes, long totalBytes);
}
- 字串結果回撥介面
package com.showly.okhttpdemo.http.response;
/**
* raw 字串結果回撥
*/
public abstract class RawResponseHandler implements IResponseHandler {
public abstract void onSuccess(int statusCode, String response);
@Override
public void onProgress(long currentBytes, long totalBytes) {
}
}
3.json型別的回撥介面
package com.showly.okhttpdemo.http.response;
import org.json.JSONObject;
/**
* json型別的回撥介面
*/
public abstract class JsonResponseHandler implements IResponseHandler {
public abstract void onSuccess(int statusCode, JSONObject response);
@Override
public void onProgress(long currentBytes, long totalBytes) {
}
}
4.Gson型別的回撥介面
package com.showly.okhttpdemo.http.response;
import com.google.gson.internal.$Gson$Types;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
/**
* Gson型別的回撥介面
*/
public abstract class GsonResponseHandler<T> implements IResponseHandler {
Type mType;
public GsonResponseHandler() {
Type myclass = getClass().getGenericSuperclass(); //反射獲取帶泛型的class
if (myclass instanceof Class) {
throw new RuntimeException("Missing type parameter.");
}
ParameterizedType parameter = (ParameterizedType) myclass; //獲取所有泛型
mType = $Gson$Types.canonicalize(parameter.getActualTypeArguments()[0]); //將泛型轉為type
}
public final Type getType() {
return mType;
}
public abstract void onSuccess(int statusCode, T response);
@Override
public void onProgress(long currentBytes, long totalBytes) {
}
}
5、下載回撥介面
package com.showly.okhttpdemo.http.response;
import java.io.File;
/**
* 下載回撥
*/
public abstract class DownloadResponseHandler {
public abstract void onFinish(File download_file);
public abstract void onProgress(long currentBytes, long totalBytes);
public abstract void onFailure(String error_msg);
}
6、重寫request body 設定上傳進度監聽類
package com.showly.okhttpdemo.http.body;
import com.showly.okhttpdemo.http.response.IResponseHandler;
import java.io.IOException;
import okhttp3.MediaType;
import okhttp3.RequestBody;
import okio.Buffer;
import okio.BufferedSink;
import okio.ForwardingSink;
import okio.Okio;
import okio.Sink;
/**
* 重寫request body 設定上傳進度監聽
*/
public class ProgressRequestBody extends RequestBody {
private IResponseHandler mResponseHandler; //回撥監聽
private RequestBody mRequestBody;
private BufferedSink mBufferedSink;
public ProgressRequestBody(RequestBody requestBody, IResponseHandler responseHandler) {
this.mResponseHandler = responseHandler;
this.mRequestBody = requestBody;
}
@Override
public MediaType contentType() {
return mRequestBody.contentType();
}
@Override
public long contentLength() throws IOException {
return mRequestBody.contentLength();
}
@Override
public void writeTo(BufferedSink sink) throws IOException {
if(mBufferedSink == null) {
mBufferedSink = Okio.buffer(sink(sink));
}
//寫入
mRequestBody.writeTo(mBufferedSink);
//必須呼叫flush，否則最後一部分資料可能不會被寫入
mBufferedSink.flush();
}
/**
* 寫入，回撥進度介面
* @param sink Sink
* @return Sink
*/
private Sink sink(Sink sink) {
return new ForwardingSink(sink) {
//當前寫入位元組數
long bytesWritten = 0L;
//總位元組長度，避免多次呼叫contentLength()方法
long contentLength = 0L;
@Override
public void write(Buffer source, long byteCount) throws IOException {
super.write(source, byteCount);
if (contentLength == 0) {
//獲得contentLength的值，後續不再呼叫
contentLength = contentLength();
}
//增加當前寫入的位元組數
bytesWritten += byteCount;
//回撥
mResponseHandler.onProgress(bytesWritten, contentLength);
}
};
}
}
7、重寫responsebody 設定下載進度監聽類
package com.showly.okhttpdemo.http.body;
import com.showly.okhttpdemo.http.response.DownloadResponseHandler;
import java.io.IOException;
import okhttp3.MediaType;
import okhttp3.ResponseBody;
import okio.Buffer;
import okio.BufferedSource;
import okio.ForwardingSource;
import okio.Okio;
import okio.Source;
/**
* 重寫responsebody 設定下載進度監聽
*/
public class ResponseProgressBody extends ResponseBody {
private ResponseBody mResponseBody;
private DownloadResponseHandler mDownloadResponseHandler;
private BufferedSource bufferedSource;
public ResponseProgressBody(ResponseBody responseBody, DownloadResponseHandler downloadResponseHandler) {
this.mResponseBody = responseBody;
this.mDownloadResponseHandler = downloadResponseHandler;
}
@Override
public MediaType contentType() {
return mResponseBody.contentType();
}
@Override
public long contentLength() {
return mResponseBody.contentLength();
}
@Override
public BufferedSource source() {
if (bufferedSource == null) {
bufferedSource = Okio.buffer(source(mResponseBody.source()));
}
return bufferedSource;
}
private Source source(Source source) {
return new ForwardingSource(source) {
long totalBytesRead;
@Override
public long read(Buffer sink, long byteCount) throws IOException {
long bytesRead = super.read(sink, byteCount);
totalBytesRead += ((bytesRead != -1) ? bytesRead : 0);
if (mDownloadResponseHandler != null) {
mDownloadResponseHandler.onProgress(totalBytesRead, mResponseBody.contentLength());
}
return bytesRead;
}
};
}
}
三、OkHttp工具類的使用 這裡演示POST、GET請求方式，以Gson解析資料型別
注：使用不同的解析方式的時候，根據需求選用不同的回撥介面：GsonResponseHandler(Gson解析，返回物件資料)，RawResponseHandler(返回字串資料)、JsonResponseHandler(返回JSONObject資料)、DownloadResponseHandler(返回File資料型別)
1.Post請求(使用Gson解析資料)
Map<String, String> params = new HashMap<>();
params.put("phone", "13512345678");
OkHttpUtils.get().post(MainActivity.this, http://192.168.1.102:8066/loginapi/shortmsg/getShortMsg.do, params, new GsonResponseHandler<MobileCaptcha>() {
@Override
public void onSuccess(int statusCode, MobileCaptcha response) {
Log.i("MainActivity=22=", statusCode + "----" + response.getStatus() + "---" + response.getMsg());
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.i("MainActivity=22=", statusCode + "---" + error_msg);
}
});2.Get請求(使用Gson解析資料)
Map<String, String> map = new HashMap<>();
map.put("phone", "13512345678");
OkHttpUtils.get().get(MainActivity.this, http://192.168.1.102:8066/loginapi/shortmsg/getShortMsg.do, map, new GsonResponseHandler<MobileCaptcha>() {
@Override
public void onSuccess(int statusCode, MobileCaptcha response) {
Log.i("MainActivity=11=", statusCode + "----" + response.getStatus() + "---" + response.getMsg());
}
@Override
public void onFailure(int statusCode, String error_msg) {
Log.i("MainActivity=11=", statusCode + "---" + error_msg);
}
});四、這裡沒有說太多關於OKhttp的理論的東西，相信理論性的東西都看的很多了，直接上程式碼直觀明瞭。
以下是個人公眾號(longxuanzhigu)，之後釋出的文章會同步到該公眾號，方便交流學習Android知識及分享個人愛好文章：
