OkHttp使用介紹

版權聲明：

歡迎轉載，但請保留文章原始出處

作者：GavinCT

出處：http://www.cnblogs.com/ct2011/p/4001708.html

為什么需要一個HTTP庫

Android系統提供了兩種HTTP通信類，HttpURLConnection和HttpClient。
關於HttpURLConnection和HttpClient的選擇>>官方博客
盡管Google在大部分安卓版本中推薦使用HttpURLConnection，但是這個類相比HttpClient實在是太難用，太弱爆了。
OkHttp是一個相對成熟的解決方案，據說Android4.4的源碼中可以看到HttpURLConnection已經替換成OkHttp實現了。所以我們更有理由相信OkHttp的強大。

入門

官方資料

官方介紹
github源碼

使用范圍

OkHttp支持Android 2.3及其以上版本。
對於Java, JDK1.7以上。

jar包准備

官方介紹頁面有鏈接位置。這里把下載鏈接也寫在下面。
OkHttp
Okio

基本使用

HTTP GET

OkHttpClient client = new OkHttpClient();

String run(String url) throws IOException {
    Request request = new Request.Builder().url(url).build();
    Response response = client.newCall(request).execute();
    if (response.isSuccessful()) {
        return response.body().string();
    } else {
        throw new IOException("Unexpected code " + response);
    }
}

Request是OkHttp中訪問的請求，Builder是輔助類。Response即OkHttp中的響應。

Response類：

public boolean isSuccessful()
Returns true if the code is in [200..300), which means the request was successfully received, understood, and accepted.

response.body()返回ResponseBody類

可以方便的獲取string

public final String string() throws IOException
Returns the response as a string decoded with the charset of the Content-Type header. If that header is either absent or lacks a charset, this will attempt to decode the response body as UTF-8.
Throws:
IOException

當然也能獲取到流的形式：

public final InputStream byteStream()

HTTP POST

POST提交Json數據

public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
OkHttpClient client = new OkHttpClient();
String post(String url, String json) throws IOException {
 	RequestBody body = RequestBody.create(JSON, json);
  	Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();
  	Response response = client.newCall(request).execute();
	f (response.isSuccessful()) {
	    return response.body().string();
	} else {
	    throw new IOException("Unexpected code " + response);
	}
}

使用Request的post方法來提交請求體RequestBody

POST提交鍵值對

很多時候我們會需要通過POST方式把鍵值對數據傳送到服務器。 OkHttp提供了很方便的方式來做這件事情。

OkHttpClient client = new OkHttpClient();
String post(String url, String json) throws IOException {

 	RequestBody formBody = new FormEncodingBuilder()
	.add("platform", "android")
	.add("name", "bug")
	.add("subject", "XXXXXXXXXXXXXXX")
	.build();

  	Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();

  	Response response = client.newCall(request).execute();
	if (response.isSuccessful()) {
	    return response.body().string();
	} else {
	    throw new IOException("Unexpected code " + response);
	}
}

總結

通過上面的例子我們可以發現，OkHttp在很多時候使用都是很方便的，而且很多代碼也有重復，因此特地整理了下面的工具類。
注意：

• OkHttp官方文檔並不建議我們創建多個OkHttpClient，因此全局使用一個。 如果有需要，可以使用clone方法，再進行自定義。這點在后面的高級教程里會提到。
• enqueue為OkHttp提供的異步方法，入門教程中並沒有提到，后面的高級教程里會有解釋。

import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import org.apache.http.client.utils.URLEncodedUtils;
import org.apache.http.message.BasicNameValuePair;
import cn.wiz.sdk.constant.WizConstant;
import com.squareup.okhttp.Callback;
import com.squareup.okhttp.OkHttpClient;
import com.squareup.okhttp.Request;
import com.squareup.okhttp.Response; 
 
public class OkHttpUtil {
    private static final OkHttpClient mOkHttpClient = new OkHttpClient();
    static{
        mOkHttpClient.setConnectTimeout(30, TimeUnit.SECONDS);
    }
    /**
     * 該不會開啟異步線程。
     * @param request
     * @return
     * @throws IOException
     */
    public static Response execute(Request request) throws IOException{
        return mOkHttpClient.newCall(request).execute();
    }
    /**
     * 開啟異步線程訪問網絡
     * @param request
     * @param responseCallback
     */
    public static void enqueue(Request request, Callback responseCallback){
        mOkHttpClient.newCall(request).enqueue(responseCallback);
    }
    /**
     * 開啟異步線程訪問網絡, 且不在意返回結果（實現空callback）
     * @param request
     */
    public static void enqueue(Request request){
        mOkHttpClient.newCall(request).enqueue(new Callback() {
            
            @Override
            public void onResponse(Response arg0) throws IOException {
                
            }
            
            @Override
            public void onFailure(Request arg0, IOException arg1) {
                
            }
        });
    }
    public static String getStringFromServer(String url) throws IOException{
        Request request = new Request.Builder().url(url).build();
        Response response = execute(request);
        if (response.isSuccessful()) {
            String responseUrl = response.body().string();
            return responseUrl;
        } else {
            throw new IOException("Unexpected code " + response);
        }
    }
	private static final String CHARSET_NAME = "UTF-8";
	/**
	 * 這里使用了HttpClinet的API。只是為了方便
	 * @param params
	 * @return
	 */
	public static String formatParams(List<BasicNameValuePair> params){
		return URLEncodedUtils.format(params, CHARSET_NAME);
	}
	/**
	 * 為HttpGet 的 url 方便的添加多個name value 參數。
	 * @param url
	 * @param params
	 * @return
	 */
	public static String attachHttpGetParams(String url, List<BasicNameValuePair> params){
		return url + "?" + formatParams(params);
	}
	/**
	 * 為HttpGet 的 url 方便的添加1個name value 參數。
	 * @param url
	 * @param name
	 * @param value
	 * @return
	 */
	public static String attachHttpGetParam(String url, String name, String value){
		return url + "?" + name + "=" + value;
	}
}

高級

高級屬性其實用的不多，這里主要是對OkHttp github官方教程進行了翻譯。
請看我的另一篇博客：OkHttp使用進階 譯自OkHttp Github官方教程