網絡通訊框架之okHttpUtils

okHttpUtils封裝庫志支持：

• 通常的get請求
• 通常的post請求
• 基於Http的文件上傳
• 文件下載
• 上傳下載的進度回調
• 加載圖片
• 支持請求回調，直接返回對象、對象集合
• 支持session的保持
• 支持自簽名網站https的訪問，提供方法設置下證書就行
• 支持取消某個請求

---

基本方法的使用 :

第一步:

注入依賴:compile 'com.zhy:okhttputils:2.0.0'

第二步:添加網絡權限

基本的用法格式爲:

OkHttpUtils .get() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(callback); OkHttpUtils .get() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(callback);

經過鏈式去根據本身的須要添加各類參數，最後調用execute(callback)進行執行，傳入callback則表明是異步。若是隻是execute()則表明同步的方法調用。

---

GET請求

String url = ""; OkHttpUtils .get() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(new StringCallback() { @Override public void onError(Request request, Exception e) { } @Override public void onResponse(String response) { } }); String url = ""; OkHttpUtils .get() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(new StringCallback() { @Override public void onError(Request request, Exception e) { } @Override public void onResponse(String response) { } });

---

POST請求

OkHttpUtils .post() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(callback); OkHttpUtils .post() .url(url) .addParams("username", "hyman") .addParams("password", "123") .build() .execute(callback);

---

Post String

OkHttpUtils .postString() .url(url) .content(new Gson().toJson(new User("zhy", "123"))) .build() .execute(new MyStringCallback()); OkHttpUtils .postString() .url(url) .content(new Gson().toJson(new User("zhy", "123"))) .build() .execute(new MyStringCallback());

將string做爲請求體傳入到服務端，例如json字符串

 

---

Post File

 

OkHttpUtils .postFile() .url(url) .file(file) .build() .execute(new MyStringCallback()); OkHttpUtils .postFile() .url(url) .file(file) .build() .execute(new MyStringCallback());

將file做爲請求體傳入到服務端.

---

基於POST的文件上傳（相似web上的表單）

OkHttpUtils.post()// .addFile("mFile", "messenger_01.png", file)// .addFile("mFile", "test1.txt", file2)// .url(url) .params(params)// .headers(headers)// .build()// .execute(new MyStringCallback());OkHttpUtils.post()// .addFile("mFile", "messenger_01.png", file)// .addFile("mFile", "test1.txt", file2)// .url(url) .params(params)// .headers(headers)// .build()// .execute(new MyStringCallback());

 

---

下載文件

OkHttpUtils// .get()// .url(url)// .build()// .execute(new FileCallBack(Environment.getExternalStorageDirectory().getAbsolutePath(), "gson-2.2.1.jar")// { @Override public void inProgress(float progress) { mProgressBar.setProgress((int) (100 * progress)); } @Override public void onError(Request request, Exception e) { Log.e(TAG, "onError :" + e.getMessage()); } @Override public void onResponse(File file) { Log.e(TAG, "onResponse :" + file.getAbsolutePath()); } }); OkHttpUtils// .get()// .url(url)// .build()// .execute(new FileCallBack(Environment.getExternalStorageDirectory().getAbsolutePath(), "gson-2.2.1.jar")// { @Override public void inProgress(float progress) { mProgressBar.setProgress((int) (100 * progress)); } @Override public void onError(Request request, Exception e) { Log.e(TAG, "onError :" + e.getMessage()); } @Override public void onResponse(File file) { Log.e(TAG, "onResponse :" + file.getAbsolutePath()); } });

---

顯示圖片

OkHttpUtils .get()// .url(url)// .build()// .execute(new BitmapCallback() { @Override public void onError(Request request, Exception e) { mTv.setText("onError:" + e.getMessage()); } @Override public void onResponse(Bitmap bitmap) { mImageView.setImageBitmap(bitmap); } }); OkHttpUtils .get()// .url(url)// .build()// .execute(new BitmapCallback() { @Override public void onError(Request request, Exception e) { mTv.setText("onError:" + e.getMessage()); } @Override public void onResponse(Bitmap bitmap) { mImageView.setImageBitmap(bitmap); } });

---

對於上傳下載的回調

new Callback<?>() { //... @Override public void inProgress(float progress) { //use progress: 0 ~ 1 } } new Callback<?>() { //... @Override public void inProgress(float progress) { //use progress: 0 ~ 1 } }

對於傳入的callback有個inProgress方法，須要拿到進度直接複寫該方法便可。

---

對於自動解析爲實體類

目前去除了Gson的依賴，提供了自定義Callback的方式，讓用戶本身去解析返回的數據，

目前提供了，, 分別用於返回string，文件下載，加載圖片。StringCallbackFileCallbackBitmapCallback

固然若是你但願解析爲對象，你能夠：

 public abstract class UserCallback extends Callback<User> { //非UI線程，支持任何耗時操做 @Override public User parseNetworkResponse(Response response) throws IOException { String string = response.body().string(); User user = new Gson().fromJson(string, User.class); return user; } public abstract class UserCallback extends Callback<User> { //非UI線程，支持任何耗時操做 @Override public User parseNetworkResponse(Response response) throws IOException { String string = response.body().string(); User user = new Gson().fromJson(string, User.class); return user; }

 本身使用本身喜歡的Json解析庫完成便可。

 解析成List<User>，則以下： public abstract class ListUserCallback extends Callback<List<User>> { @Override public List<User> parseNetworkResponse(Response response) throws IOException { String string = response.body().string(); List<User> user = new Gson().fromJson(string, List.class); return user; } } 解析成List<User>，則以下： public abstract class ListUserCallback extends Callback<List<User>> { @Override public List<User> parseNetworkResponse(Response response) throws IOException { String string = response.body().string(); List<User> user = new Gson().fromJson(string, List.class); return user; } }

---

 對於https單向認證

 很是簡單，拿到xxx.cert的證書。而後調用

OkHttpUtils.getInstance().setCertificates(inputstream); OkHttpUtils.getInstance().setCertificates(inputstream);

 建議使用方式，例如個人證書放在assets目錄：

 public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); try { OkHttpUtils .getInstance() .setCertificates(getAssets().open("aaa.cer"), getAssets().open("server.cer")); } catch (IOException e) { e.printStackTrace(); } } } public class MyApplication extends Application { @Override public void onCreate() { super.onCreate(); try { OkHttpUtils .getInstance() .setCertificates(getAssets().open("aaa.cer"), getAssets().open("server.cer")); } catch (IOException e) { e.printStackTrace(); } } }

 便可。別忘了註冊Application。

注意：若是https網站爲權威機構頒發的證書，不須要以上設置。自簽名的證書才須要。

---

配置

（1）全局配置

能夠在Application中，經過：

OkHttpClient client = OkHttpUtils.getInstance().getOkHttpClient(); OkHttpClient client = OkHttpUtils.getInstance().getOkHttpClient();

而後調用client的各類set方法。如:

client.setConnectTimeout(100000, TimeUnit.MILLISECONDS); client.setConnectTimeout(100000, TimeUnit.MILLISECONDS);

（2）爲單個請求設置超時

好比涉及到文件的須要設置讀寫等待時間多一點。

 OkHttpUtils .get()// .url(url)// .tag(this)// .build()// .connTimeOut(20000) .readTimeOut(20000) .writeTimeOut(20000) .execute() OkHttpUtils .get()// .url(url)// .tag(this)// .build()// .connTimeOut(20000) .readTimeOut(20000) .writeTimeOut(20000) .execute()

調用build()以後，能夠隨即設置各類timeOut.

（3）取消單個請求

RequestCall call = OkHttpUtils.get().url(url).build(); call.cancel(); RequestCall call = OkHttpUtils.get().url(url).build(); call.cancel();

（4）根據tag取消請求

目前對於支持的方法都添加了最後一個參數Object tag，取消則經過OkHttpUtils.cancelTag(tag)執行。

 例如：在Activity中，當Activity銷燬取消請求：

OkHttpUtils .get()// .url(url)// .tag(this)// .build()// @Override protected void onDestroy() { super.onDestroy(); //能夠取消同一個tag的 OkHttpUtils.cancelTag(this);//取消以Activity.this做爲tag的請求 } OkHttpUtils .get()// .url(url)// .tag(this)// .build()// @Override protected void onDestroy() { super.onDestroy(); //能夠取消同一個tag的 OkHttpUtils.cancelTag(this);//取消以Activity.this做爲tag的請求 }

 好比，當前Activity頁面全部的請求以Activity對象做爲tag，能夠在onDestory裏面統一取消。