作者：Zyao89；轉載請保留此行，謝謝；
上一篇文章寫的是 Retrofit2.2說明-簡單使用，文中主要介紹的是Retrofit的簡單使用方法，具體涉及到的網絡請求方面的內容，在這里一并介紹。
Retrofit與okhttp共同出自于Square公司，retrofit就是對okhttp做了一層封裝。網絡請求依賴Okhttp，我們現在通過一些栗子，對OkHttp進行一定的了解。
首先說下OkHttp3是Java和Android都能用，Android還有一個著名網絡庫叫Volley，那個只有Android能用。
引入
compile 'com.squareup.okhttp3:okhttp:3.6.0'
初始化
mOkHttpClient = new OkHttpClient.Builder()
.connectTimeout(60, TimeUnit.SECONDS)
.authenticator(new Authenticator()
{
@Override
public Request authenticate(Route route, Response response) throws IOException
{//401，認證
String credential = Credentials.basic("zyao89", "password1");
return response.request().newBuilder().header("Authorization", credential).build();
}
})
.cookieJar(new CookieJar()
{//這里可以做cookie傳遞，保存等操作
@Override
public void saveFromResponse(HttpUrl url, List<Cookie> cookies)
{//可以做保存cookies操作
System.out.println("cookies url: " + url.toString());
for (Cookie cookie : cookies)
{
System.out.println("cookies: " + cookie.toString());
}
}
@Override
public List<Cookie> loadForRequest(HttpUrl url)
{//加載新的cookies
ArrayList<Cookie> cookies = new ArrayList<>();
Cookie cookie = new Cookie.Builder()
.hostOnlyDomain(url.host())
.name("SESSION").value("zyao89")
.build();
cookies.add(cookie);
return cookies;
}
})
.build();
-
authenticator()此方法可進行請求認證操作。 -
cookieJar ()次方法可進行cookies保留，和自定義cookies。（可用于存儲sessionID等信息，保存鏈接身份）
Get請求
- 異步
public void get()
{
Request request = new Request.Builder()
.url("http://200.200.200.182:9999/login")
.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(getCallback());
}
/**
* 請求回調
* @return
*/
private Callback getCallback()
{
return new Callback()
{//子線程回調
@Override
public void onResponse(Call call, Response response)
{
printLogCat("Code: " + response.code());
printLogCat("Message: " + response.message());
if (response.isSuccessful())
{
try
{
printLogCat("Body: " + response.body().string());
}
catch (IOException e)
{
e.printStackTrace();
printLogCat("ERROR: " + "response'body is error");
}
}
else
{
printLogCat("ERROR: " + "okHttp is request error");
}
printLogCat("");
}
@Override
public void onFailure(Call call, IOException e)
{
printLogCat("ERROR: " + e.getMessage());
printLogCat("");
}
};
}
- 同步
public void getSyc()
{
new Thread(new Runnable() {
@Override
public void run()
{
Request request = new Request.Builder()
.url("http://200.200.200.182:9999/login")
.build();
Call call = mOkHttpClient.newCall(request);
try
{
Response response = call.execute();
sycCallback(response);
}
catch (IOException e)
{
e.printStackTrace();
}
}
}).start();
}
private void sycCallback(Response response)
{
printLogCat("Code: " + response.code());
printLogCat("Message: " + response.message());
if (response.isSuccessful())
{
try
{
printLogCat("Body: " + response.body().string());
}
catch (IOException e)
{
e.printStackTrace();
printLogCat("ERROR: " + "response'body is error");
}
}
else
{
printLogCat("ERROR: " + "okHttp is request error");
}
printLogCat("");
}
response的body有很多種輸出方法，string()只是其中之一，注意是string()不是toString()。如果是下載文件就是response.body().bytes()。
另外可以根據response.code()獲取返回的狀態碼。
Post請求
同步異步都與get方法一致，后面提供異步栗子：
public void post()
{
String data = "{\"username\" : \"admin\", \"password\" : \"12345\"}";
RequestBody requestBody = RequestBody.create(JSON, data);
Request request = new Request.Builder()
.url("http://200.200.200.182:9999/login")
.post(requestBody)
.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(getCallback());
}
RequestBody的數據格式都要指定Content-Type，常見的有：
- application/x-www-form-urlencoded 數據是個普通表單
- multipart/form-data 數據里有文件
- application/json 數據是個Json
- text/x-markdown 文本MarkDown
除了RequestBody，也可用FormBody（繼承于RequestBody），如：
RequestBody formBody = new FormBody.Builder()
.add("username", "admin2")
.add("password", "12222333")
.add("message", "zyao89")
.build();
從源碼中可看到，FormBody中已指定Content-Type格式為application/x-www-form-urlencoded
private static final MediaType CONTENT_TYPE =
MediaType.parse("application/x-www-form-urlencoded");
假如是個Json數據，則：
private static final MediaType JSON =
MediaType.parse("application/json; charset=utf-8");
圖片文件數據，則：
public void postFile(File file)
{
MultipartBody multipartBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("file", file.getName(), RequestBody.create(MediaType.parse("image/png"), file))
.build();
Request request = new Request.Builder()
.url("http://200.200.200.182:9999/file")
.post(multipartBody)
.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(getCallback());
}
MultipartBody也是繼承了RequestBody，從源碼可知它適用于這五種Content-Type:
public static final MediaType MIXED = MediaType.parse("multipart/mixed");
public static final MediaType ALTERNATIVE = MediaType.parse("multipart/alternative");
public static final MediaType DIGEST = MediaType.parse("multipart/digest");
public static final MediaType PARALLEL = MediaType.parse("multipart/parallel");
public static final MediaType FORM = MediaType.parse("multipart/form-data");
MediaType類型可參考W3Scholl MIME 參考手冊
PUT \ DELETE 等其它請求
這里只對PUT舉個栗子，其它類型差不多。
public void put()
{
FormBody formBody = new FormBody.Builder()
.add("username", "admin2")
.add("password", "12222333")
.add("message", "zyao89")
.build();
Request request = new Request.Builder()
.url("http://200.200.200.182:9999/put")
.header("Accept", "application/json; q=0.5")//添加請求頭，方式一
.addHeader("Accept", "*")//添加請求頭，方式二
.put(formBody)
.build();
Call call = mOkHttpClient.newCall(request);
call.enqueue(getCallback());
}
上面栗子中，Request在創建時，可自行增加header請求頭:
.header("Accept", "application/json; q=0.5")//添加請求頭，方式一
.addHeader("Accept", "*")//添加請求頭，方式二
客戶端Cookie 與 服務器Session 自動管理
業務中經常出現客戶端登錄請求結束后，服務端會返回一個帶有唯一登錄認證信息Session的Response，其中Session就藏在Cookie中，那么如何讓下一次Request請求創建時，可以將這個認證信息放入其中呢？
OkHttp為我們提供了簡便的管理方法，可自動攜帶，保存和更新Cookie信息；方法如下：
//cookie存儲
private ConcurrentHashMap<String, List<Cookie>> cookieStore = new ConcurrentHashMap<>();
mOkHttpClient = new OkHttpClient.Builder()
.cookieJar(new CookieJar()
{//這里可以做cookie傳遞，保存等操作
@Override
public void saveFromResponse(HttpUrl url, List<Cookie> cookies)
{//可以做保存cookies操作
cookieStore.put(url.host(), cookies);
}
@Override
public List<Cookie> loadForRequest(HttpUrl url)
{//加載新的cookies
List<Cookie> cookies = cookieStore.get(url.host());
return cookies != null ? cookies : new ArrayList<Cookie>();
}
})
.build();
如此設置后，在同一個域名地址情況下，發送Request都不用管理Cookie了，并且可以通過cookieStore獲取已存儲的Cookie，如此可達到自動管理。
Demo演示圖
測試Demo演示圖
Github項目地址：zyao89/DemoOkHttp
個人博客：http://zyao89.me
