OkHttp3使用

OkHttp:是一款優秀的HTTP框架,

  1. 支持get請求和post請求,
  2. 支持基于Http的文件上傳和下載,
  3. 支持加載圖片,
  4. 支持下載文件透明的GZIP壓縮,
  5. 支持響應緩存避免重復的網絡請求,
  6. 支持使用連接池來降低響應延遲問題
下載和添加網絡訪問權限
下載OkHttp.png
添加網絡權限.png
基本要求
Request:每一個HTTP請求中都應該包含一個URL,一個GET或POST方法以及Header或其他參數,當然還可以含特定內容類型的數據流。
Response:響應則包含一個回復代碼(200代表成功,404代表未找到),Header和定制可選的body。
基本使用

在日常開發中最常使用的網絡請求就是GET和POST兩種方式
Http Get請求

//創建okHttpClient對象
OkHttpClient mOkHttpClient = new OkHttpClient();
//創建一個Request
final Request request = new Request.Builder()
                .url("https://github.com/hongyangAndroid")
                .build();
//new call
Call call = mOkHttpClient.newCall(request); 
//請求加入調度
call.enqueue(new Callback()
        {
            @Override
            public void onFailure(Request request, IOException e)
            {
            }

            @Override
            public void onResponse(final Response response) throws IOException
            {
                    //String htmlStr =  response.body().string();
            }
        });         
  1. 以上就是發送一個get請求的步驟,首先構造一個Request對象,參數最少有一個url,當然還可以通過Request.Builder設置更多的參數比如:header、method等
  2. 然后通過request的對象去構造得到一個Call對象,類似于將你的請求封裝成了任務,既然是任務,那就會有execute()和cancel()方法
  3. 最后,通過異步的方式去執行請求,所以我們調用的是call.enqueue,將call加入調度隊列,然后等待任務執行完成,最后在Callback中即可得到結果。
    整體的寫法就是這樣,但是實際運用過程中還需要進行封裝。
    注意
  4. onResponse回調的參數是response,一般情況下,比如我們希望獲得返回的字符串,可以通過response.body().string()獲得;如果希望獲得返回的二進制字節數組,則調用response.body().bytes();如果你想拿到返回的inputStream,則調用response.body().byteStream()

此時onResponse執行的線程并不是UI線程,所以當你希望操作控件的時候,還需要使用handle等,例如:

@Override
public void onResponse(final Response response) throws IOException
{
      final String res = response.body().string();
      runOnUiThread(new Runnable()
      {
          @Override
          public void run()
          {
            mTv.setText(res);
          }

      });
}

Http Post攜帶參數
post基本用法和get基本相同,比如post攜帶參數,也僅僅是Request的構造不同。

Request request = buildMultipartFormRequest(
        url, new File[]{file}, new String[]{fileKey}, null);
FormEncodingBuilder builder = new FormEncodingBuilder();   
builder.add("username","###");

Request request = new Request.Builder()
                  .url(url)
                  .post(builder.build())
                  .build();
 mOkHttpClient.newCall(request).enqueue(new Callback(){});

post的時候,參數是包含在請求體中的,所以我們通過FormEncodingBuilder。添加多個string鍵值對,然后去構造RequestBody,最后完成Request的構造。

封裝

上面的代碼包含太多重復的代碼,所以我們應該使用封裝之后的代碼:

  1. 一般的get請求
OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>()
        {
            @Override
            public void onError(Request request, Exception e)
            {
                e.printStackTrace();
            }

            @Override
            public void onResponse(String u)
            {
                mTv.setText(u);//注意這里是UI線程
            }
        });

對于一般的請求,我們給出一個url,然后再CallBack中直接進行操作.

  1. 展示圖片
    當展示圖片的時候,我們只需要提供一個url和imageView,如果下載成功,直接設置就行了
OkHttpClientManager.displayImage(mImageView, 
     "http://images.csdn.net/20150817/1.jpg");

整合Gson

當服務端返回json字符串時,希望客戶端回調可以直接拿到對象,于是整合了Gson.

  1. 直接回調對象
    現在有一個User實體類:
package com.zhy.utils.http.okhttp;

public class User {

    public String username ; 
    public String password  ;

    public User() {
        // TODO Auto-generated constructor stub
    }

    public User(String username, String password) {
        this.username = username;
        this.password = password;
    }

    @Override
    public String toString()
    {
        return "User{" +
                "username='" + username + '\'' +
                ", password='" + password + '\'' +
                '}';
    }
}

服務端返回:

{"username":"zhy","password":"123"}

客戶端按以下方式調用:

 OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser",
new OkHttpClientManager.ResultCallback<User>()
{
    @Override
    public void onError(Request request, Exception e)
    {
        e.printStackTrace();
    }

    @Override
    public void onResponse(User user)
    {
        mTv.setText(u.toString());//UI線程
    }
});

我們傳入泛型User,在onResponse里面直接回調User對象。
注意:如果在json字符串轉變為實例對象過程中出現錯誤,程序不會崩潰,onError方法會被回調。
注意:接口命名從StringCallback修改為ResultCallback.接口中的onFailure方法修改為onError.

  1. 回調對象集合
    服務端返回:
[{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]

客戶端可以如下調用:

OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers",
new OkHttpClientManager.ResultCallback<List<User>>()
{
    @Override
    public void onError(Request request, Exception e)
    {
        e.printStackTrace();
    }
    @Override
    public void onResponse(List<User> us)
    {
        Log.e("TAG", us.size() + "");
        mTv.setText(us.get(1).toString());
    }
});

唯一的區別,就是泛型變為List<User>.

參考:http://blog.csdn.net/mynameishuangshuai/article/details/51303446
http://blog.csdn.net/lmj623565791/article/details/47911083

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容