UDP通信模型

4. Demo

首先添加權(quán)限：

<!--允許應(yīng)用程序改變網(wǎng)絡(luò)狀態(tài)--> <uses-permission android:name="android.permission.CHANGE_NETWORK_STATE"/> <!--允許應(yīng)用程序改變WIFI連接狀態(tài)--> <uses-permission android:name="android.permission.CHANGE_WIFI_STATE"/> <!--允許應(yīng)用程序訪問(wèn)有關(guān)的網(wǎng)絡(luò)信息--> <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/><!--允許應(yīng)用程序訪問(wèn)WIFI網(wǎng)卡的網(wǎng)絡(luò)信息--> <uses-permission android:name="android.permission.ACCESS_WIFI_STATE"/> <!--允許應(yīng)用程序完全使用網(wǎng)絡(luò)--> <uses-permission android:name="android.permission.INTERNET"/> 

(1) 使用TCP協(xié)議通信

客戶端實(shí)現(xiàn)：

protected void connectServerWithTCPSocket() { Socket socket; try {// 創(chuàng)建一個(gè)Socket對(duì)象，并指定服務(wù)端的IP及端口號(hào) socket = new Socket("192.168.1.32", 1989); // 創(chuàng)建一個(gè)InputStream用戶讀取要發(fā)送的文件。 InputStream inputStream = new FileInputStream("e://a.txt"); // 獲取Socket的OutputStream對(duì)象用于發(fā)送數(shù)據(jù)。 OutputStream outputStream = socket.getOutputStream(); // 創(chuàng)建一個(gè)byte類型的buffer字節(jié)數(shù)組，用于存放讀取的本地文件 byte buffer[] = new byte[4 * 1024]; int temp = 0; // 循環(huán)讀取文件 while ((temp = inputStream.read(buffer)) != -1) { // 把數(shù)據(jù)寫(xiě)入到OuputStream對(duì)象中 outputStream.write(buffer, 0, temp); } // 發(fā)送讀取的數(shù)據(jù)到服務(wù)端 outputStream.flush(); /** 或創(chuàng)建一個(gè)報(bào)文，使用BufferedWriter寫(xiě)入**/ //String socketData = "[2143213;21343fjks;213]"; //BufferedWriter writer = new BufferedWriter(new OutputStreamWriter( //socket.getOutputStream())); //writer.write(socketData.replace("\n", " ") + "\n"); //writer.flush(); } catch (UnknownHostException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } } 

服務(wù)端實(shí)現(xiàn)：

public void serverReceviedByTcp() { // 聲明一個(gè)ServerSocket對(duì)象 ServerSocket serverSocket = null; try { // 創(chuàng)建一個(gè)ServerSocket對(duì)象，并讓這個(gè)Socket在1989端口監(jiān)聽(tīng) serverSocket = new ServerSocket(1989); // 調(diào)用ServerSocket的accept()方法，接受客戶端所發(fā)送的請(qǐng)求， // 如果客戶端沒(méi)有發(fā)送數(shù)據(jù)，那么該線程就阻塞，等到收到數(shù)據(jù)，繼續(xù)執(zhí)行。 Socket socket = serverSocket.accept(); // 從Socket當(dāng)中得到InputStream對(duì)象，讀取客戶端發(fā)送的數(shù)據(jù) InputStream inputStream = socket.getInputStream(); byte buffer[] = new byte[1024 * 4]; int temp = 0; // 從InputStream當(dāng)中讀取客戶端所發(fā)送的數(shù)據(jù) while ((temp = inputStream.read(buffer)) != -1) { System.out.println(new String(buffer, 0, temp)); } serverSocket.close(); } catch (IOException e) { e.printStackTrace(); } } 

5. 方法

(1) ServerSocket

監(jiān)聽(tīng)來(lái)自于客戶端的Socket連接，如果沒(méi)有連接，它將一直處于等待狀態(tài)

• ServerSocket(int port, int backlog, InetAddress bindAddr)在機(jī)器存在多IP的情況下，允許通過(guò)bindAddr來(lái)指定綁定到哪個(gè)IP；backlog是隊(duì)列中能接受的最大socket客戶端連接數(shù)（accept()之后將被取出）
• ServerSocket() 創(chuàng)建非綁定服務(wù)器套接字
• ServerSocket(int port) 創(chuàng)建綁定到特定端口的服務(wù)器套接字，等價(jià)于ServerSocket(port, 50, null)
• accept() Socket 如果接收到一個(gè)客戶端Socket的連接請(qǐng)求，返回一個(gè)與客戶端Socket相對(duì)應(yīng)的Socket
• close()

(2) Socket

• Socket() 創(chuàng)建未連接套接字
• Socket(String host, int port)
• Socket(InetAddress address, int port)創(chuàng)建一個(gè)流套接字并將其連接到指定 IP 地址的指定端口號(hào)，默認(rèn)使用本地主機(jī)默認(rèn)的IP和系統(tǒng)動(dòng)態(tài)分配的端口
• Socket(InetAddress address, int port, InetAddress localAddr, int localPort)創(chuàng)建一個(gè)套接字并將其連接到指定遠(yuǎn)程地址上的指定遠(yuǎn)程端口，多IP時(shí)
• getOutputStream() OutputStream 返回此套接字的輸出流
• getInputStream() inputStream 返回此套接字的輸入流
• connect(SocketAddress endpoint, int timeout) 將此套接字連接到服務(wù)器，并指定一個(gè)超時(shí)值
• close()

6.3.3HttpURLConnection

1. URL

1）對(duì)象代表統(tǒng)一資源定位器，是指向互聯(lián)網(wǎng)“資源”的指針
2）通常由協(xié)議名、主機(jī)、端口、資源路徑組成
3）URL包含一個(gè)可打開(kāi)到達(dá)該資源的輸入流，可以將URL理解成為URI的特例

• URL(String spec)
• openConnection() URLConnection
• getProtocol() String
• getHost() String
• getPort() int
• getPath() String 獲取路徑部分，/search.html
• getFile() String 獲取資源名稱，/search.html?keyword='你好'
• getQuery() String 獲取查詢字符串，keyword='你好'
• openStream() InputStream

2. URLConnection

抽象類，表示應(yīng)用程序和URL之間的通信連接，可以向URL發(fā)送請(qǐng)求，讀取URL指向的資源

• setDoInput(boolean doinput) 發(fā)送POST請(qǐng)求，必須設(shè)置，設(shè)置為true
• setDoOutput(boolean dooutput) 發(fā)送POST請(qǐng)求，必須設(shè)置，設(shè)置為true
• setUseCaches(boolean usecaches)是否使用緩存
• setRequestProperty(String key, String value) 設(shè)置普通的請(qǐng)求屬性
• setConnectTimeout(int timeout)設(shè)置連接超時(shí)的時(shí)間
• setReadTimeout(int timeoutMillis) 讀取輸入流的超時(shí)時(shí)間
• connect() 抽象方法，建立實(shí)際的連接
• getHeaderField(String key) String
• getHeaderFields() Map<String,List<String>> 獲取所有的響應(yīng)頭；getHeaderField(String name)獲取指定的響應(yīng)頭
• getOutputStream() OutputStream
• getInputStream() InputStream
• getContentLength() int

3. HttpURLConnection

(1) 簡(jiǎn)介

抽象類，是URLConnection的子類，增加了操作Http資源的便捷方法

• 對(duì)象不能直接構(gòu)造，需要通過(guò)URL類中的openConnection()方法來(lái)獲得。
• connect()函數(shù)，實(shí)際上只是建立了一個(gè)與服務(wù)器的TCP連接，并沒(méi)有實(shí)際發(fā)送HTTP請(qǐng)求。HTTP請(qǐng)求實(shí)際上直到我們獲取服務(wù)器響應(yīng)數(shù)據(jù)（如調(diào)用getInputStream()、getResponseCode()等方法）時(shí)才正式發(fā)送出去。
• 對(duì)HttpURLConnection對(duì)象的配置都需要在connect()方法執(zhí)行之前完成。
• HttpURLConnection是基于HTTP協(xié)議的，其底層通過(guò)socket通信實(shí)現(xiàn)。如果不設(shè)置超時(shí)（timeout），在網(wǎng)絡(luò)異常的情況下，可能會(huì)導(dǎo)致程序僵死而不繼續(xù)往下執(zhí)行。
• HTTP正文的內(nèi)容是通過(guò)OutputStream流寫(xiě)入的， 向流中寫(xiě)入的數(shù)據(jù)不會(huì)立即發(fā)送到網(wǎng)絡(luò)，而是存在于內(nèi)存緩沖區(qū)中，待流關(guān)閉時(shí)，根據(jù)寫(xiě)入的內(nèi)容生成HTTP正文。
• 調(diào)用getInputStream()方法時(shí)，返回一個(gè)輸入流，用于從中讀取服務(wù)器對(duì)于HTTP請(qǐng)求的返回信息。
• 我們可以使用connect()方法手動(dòng)的發(fā)送一個(gè)HTTP請(qǐng)求，但是如果要獲取HTTP響應(yīng)的時(shí)候，請(qǐng)求就會(huì)自動(dòng)的發(fā)起，比如我們使用getInputStream()方法的時(shí)候，所以完全沒(méi)有必要調(diào)用connect()方法。

(2) 方法

• setRequestMethod(String method)
• setInstanceFollowRedirects(boolean followRedirects)
• getResponseCode() int 獲取服務(wù)器的響應(yīng)碼
• getResponseMessage() String 獲取響應(yīng)消息
• getRequestMethod() String 獲取發(fā)送請(qǐng)求的方法，GET或POST
• disconnect() 抽象方法

(3) 實(shí)現(xiàn)多線程下載

步驟：
①：創(chuàng)建URL對(duì)象
②：獲取URL對(duì)象指向資源的大小（getContentLength()方法）
③：在本地創(chuàng)建一個(gè)與網(wǎng)路資源相同大小的空文件
④：計(jì)算每條線程應(yīng)該下載網(wǎng)絡(luò)資源的哪個(gè)部分（從哪個(gè)字節(jié)開(kāi)始，到哪個(gè)字節(jié)結(jié)束）
⑤：依次創(chuàng)建，啟動(dòng)多條線程來(lái)下載網(wǎng)絡(luò)資源的指定部分

(4) 實(shí)例

使用GET方式訪問(wèn)HTTP

public static void main(String[] args) { try { // 1. 得到訪問(wèn)地址的URL URL url = new URL( "http://localhost:8080/Servlet/do_login.do?username=test&password=123456"); // 2. 得到網(wǎng)絡(luò)訪問(wèn)對(duì)象java.net.HttpURLConnection HttpURLConnection connection = (HttpURLConnection) url .openConnection(); /* 3. 設(shè)置請(qǐng)求參數(shù)（過(guò)期時(shí)間，輸入、輸出流、訪問(wèn)方式），以流的形式進(jìn)行連接 */ // 設(shè)置是否向HttpURLConnection輸出 connection.setDoOutput(false); // 設(shè)置是否從httpUrlConnection讀入 connection.setDoInput(true); // 設(shè)置請(qǐng)求方式 connection.setRequestMethod("GET"); // 設(shè)置是否使用緩存 connection.setUseCaches(true); // 設(shè)置此 HttpURLConnection 實(shí)例是否應(yīng)該自動(dòng)執(zhí)行 HTTP 重定向 connection.setInstanceFollowRedirects(true); // 設(shè)置超時(shí)時(shí)間 connection.setConnectTimeout(3000); // 連接 connection.connect(); // 4. 得到響應(yīng)狀態(tài)碼的返回值 responseCode int code = connection.getResponseCode(); // 5. 如果返回值正常，數(shù)據(jù)在網(wǎng)絡(luò)中是以流的形式得到服務(wù)端返回的數(shù)據(jù) String msg = ""; if (code == 200) { // 正常響應(yīng) // 從流中讀取響應(yīng)信息 BufferedReader reader = new BufferedReader( new InputStreamReader(connection.getInputStream())); String line = null;while ((line = reader.readLine()) != null) { // 循環(huán)從流中讀取 msg += line + "\n"; } reader.close(); // 關(guān)閉流 } // 6. 斷開(kāi)連接，釋放資源 connection.disconnect(); // 顯示響應(yīng)結(jié)果 System.out.println(msg); } catch (IOException e) { e.printStackTrace(); } } 

使用POST方式訪問(wèn)HTTP

public static void main(String[] args) { try { // 1. 獲取訪問(wèn)地址URL URL url = new URL("http://localhost:8080/Servlet/do_login.do"); // 2. 創(chuàng)建HttpURLConnection對(duì)象 HttpURLConnection connection = (HttpURLConnection) url .openConnection(); /* 3. 設(shè)置請(qǐng)求參數(shù)等 */ // 請(qǐng)求方式 connection.setRequestMethod("POST"); // 超時(shí)時(shí)間 connection.setConnectTimeout(3000); // 設(shè)置是否輸出 connection.setDoOutput(true); // 設(shè)置是否讀入 connection.setDoInput(true); // 設(shè)置是否使用緩存 connection.setUseCaches(false); // 設(shè)置此 HttpURLConnection 實(shí)例是否應(yīng)該自動(dòng)執(zhí)行 HTTP 重定向 connection.setInstanceFollowRedirects(true); // 設(shè)置使用標(biāo)準(zhǔn)編碼格式編碼參數(shù)的名-值對(duì) connection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded"); // 連接 connection.connect(); /* 4. 處理輸入輸出 */ // 寫(xiě)入?yún)?shù)到請(qǐng)求中 String params = "username=test&password=123456"; OutputStream out = connection.getOutputStream(); out.write(params.getBytes()); out.flush(); out.close(); // 從連接中讀取響應(yīng)信息 String msg = ""; int code = connection.getResponseCode(); if (code == 200) { BufferedReader reader = new BufferedReader( new InputStreamReader(connection.getInputStream())); String line;while ((line = reader.readLine()) != null) { msg += line + "\n"; } reader.close(); } // 5. 斷開(kāi)連接 connection.disconnect();// 處理結(jié)果 System.out.println(msg); } catch (MalformedURLException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } } 

4. HttpClient

（Android6.0之后的SDK中移除了對(duì)于HttpClient的支持，僅作了解）
在一般情況下，如果只是需要向Web站點(diǎn)的某個(gè)簡(jiǎn)單頁(yè)面提交請(qǐng)求并獲取服務(wù)器響應(yīng)，HttpURLConnection完全可以勝任。但在絕大部分情況下，Web站點(diǎn)的網(wǎng)頁(yè)可能沒(méi)這么簡(jiǎn)單，這些頁(yè)面并不是通過(guò)一個(gè)簡(jiǎn)單的URL就可訪問(wèn)的，可能需要用戶登錄而且具有相應(yīng)的權(quán)限才可訪問(wèn)該頁(yè)面。在這種情況下，就需要涉及Session、Cookie的處理了，如果打算使用HttpURLConnection來(lái)處理這些細(xì)節(jié)，當(dāng)然也是可能實(shí)現(xiàn)的，只是處理起來(lái)難度就大了。

為了更好地處理向Web站點(diǎn)請(qǐng)求，包括處理Session、Cookie等細(xì)節(jié)問(wèn)題，Apache開(kāi)源組織提供了一個(gè)HttpClient項(xiàng)目。HttpClient就是一個(gè)增強(qiáng)版的HttpURLConnection，HttpURLConnection可以做的事情HttpClient全部可以做；HttpURLConnection沒(méi)有提供的有些功能，HttpClient也提供了，但它只是關(guān)注于如何發(fā)送請(qǐng)求、接收響應(yīng)，以及管理HTTP連接。

(1) HttpClient的使用

步驟：
①：創(chuàng)建HttpClient對(duì)象
②：需要GET請(qǐng)求，創(chuàng)建HttpCet對(duì)象；需要POST請(qǐng)求，創(chuàng)建HttpPost對(duì)象
③：需要發(fā)送請(qǐng)求參數(shù)，調(diào)用HttpGet、HttpPost共同的setParams(HttpParams params)，HttpPost對(duì)象還可以使用setEntity(HttpEntity entity)方法來(lái)設(shè)置請(qǐng)求參數(shù)。
④：調(diào)用HttpClient對(duì)象的execute(HttpUriRequest request) HttpResponse發(fā)送請(qǐng)求，執(zhí)行該方法返回一個(gè)HttpResponse。
⑤：調(diào)用HttpResponse的getAllHeaders()，getHeader(String name)獲取響應(yīng)頭；調(diào)用HttpResponse的getEntity()獲取HttpEntity對(duì)象（包裝了服務(wù)器的響應(yīng)內(nèi)容）

(2) 使用GET方式訪問(wèn)HTTP

public static void main(String[] args) { // 1. 創(chuàng)建HttpClient對(duì)象 CloseableHttpClient httpClient = HttpClientBuilder.create().build(); // 2. 創(chuàng)建HttpGet對(duì)象 HttpGet httpGet = new HttpGet( "http://localhost:8080/Servlet/do_login.do?username=test&password=123456"); CloseableHttpResponse response = null; try { // 3. 執(zhí)行GET請(qǐng)求 response = httpClient.execute(httpGet); System.out.println(response.getStatusLine()); // 4. 獲取響應(yīng)實(shí)體 HttpEntity entity = response.getEntity(); // 5. 處理響應(yīng)實(shí)體 if (entity != null) { System.out.println("長(zhǎng)度：" + entity.getContentLength()); System.out.println("內(nèi)容：" + EntityUtils.toString(entity)); } } catch (ClientProtocolException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { // 6. 釋放資源 try { response.close(); httpClient.close(); } catch (IOException e) { e.printStackTrace(); } } } 

(3) 使用POST方式訪問(wèn)HTTP

public static void main(String[] args) { // 1. 創(chuàng)建HttpClient對(duì)象 CloseableHttpClient httpClient = HttpClientBuilder.create().build(); // 2. 創(chuàng)建HttpPost對(duì)象 HttpPost post = new HttpPost( "http://localhost:8080/Servlet/do_login.do"); // 3. 設(shè)置POST請(qǐng)求傳遞參數(shù) List<NameValuePair> params = new ArrayList<NameValuePair>(); params.add(new BasicNameValuePair("username", "test")); params.add(new BasicNameValuePair("password", "12356")); try { UrlEncodedFormEntity entity = new UrlEncodedFormEntity(params); post.setEntity(entity); } catch (UnsupportedEncodingException e) { e.printStackTrace(); } // 4. 執(zhí)行請(qǐng)求并處理響應(yīng) try { CloseableHttpResponse response = httpClient.execute(post); HttpEntity entity = response.getEntity(); if (entity != null) { System.out.println("響應(yīng)內(nèi)容："); System.out.println(EntityUtils.toString(entity)); } response.close(); } catch (ClientProtocolException e) { e.printStackTrace(); } catch (IOException e) { e.printStackTrace(); } finally { // 釋放資源 try { httpClient.close(); } catch (IOException e) { e.printStackTrace(); } } } 

6.4 OkHttp

6.4.1 簡(jiǎn)介

HttpClient是Apache基金會(huì)的一個(gè)開(kāi)源網(wǎng)絡(luò)庫(kù)，功能十分強(qiáng)大，API數(shù)量眾多，但正是由于龐大的API數(shù)量使得我們很難在不破壞兼容性的情況下對(duì)它進(jìn)行升級(jí)和擴(kuò)展，所以Android團(tuán)隊(duì)在提升和優(yōu)化HttpClient方面的工作態(tài)度并不積極。官方在Android 2.3以后就不建議用了，并且在Android 5.0以后廢棄了HttpClient，在Android 6.0更是刪除了HttpClient。

HttpURLConnection是一種多用途、輕量極的HTTP客戶端，提供的API比較簡(jiǎn)單，可以容易地去使用和擴(kuò)展。不過(guò)在Android 2.2版本之前，HttpURLConnection一直存在著一些令人厭煩的bug。比如說(shuō)對(duì)一個(gè)可讀的InputStream調(diào)用close()方法時(shí)，就有可能會(huì)導(dǎo)致連接池失效了。那么我們通常的解決辦法就是直接禁用掉連接池的功能。因此一般推薦是在2.2之前使用HttpClient，因?yàn)槠鋌ug較少。在2.2之后推薦使用HttpURLConnection，因?yàn)锳PI簡(jiǎn)單、體積小、有壓縮和緩存機(jī)制，并且Android團(tuán)隊(duì)后續(xù)會(huì)繼續(xù)優(yōu)化HttpURLConnection。

自從Android4.4開(kāi)始，google已經(jīng)開(kāi)始將源碼中的HttpURLConnection替換為OkHttp，而市面上流行的Retrofit同樣是使用OkHttp進(jìn)行再次封裝而來(lái)的。

OkHttp是一個(gè)快速、高效的網(wǎng)絡(luò)請(qǐng)求庫(kù)，它的設(shè)計(jì)和實(shí)現(xiàn)的首要目標(biāo)便是高效，有如下特性：

• 支持HTTP/2, HTTP/2通過(guò)使用多路復(fù)用技術(shù)在一個(gè)單獨(dú)的TCP連接上支持并發(fā), 通過(guò)在一個(gè)連接上一次性發(fā)送多個(gè)請(qǐng)求來(lái)發(fā)送或接收數(shù)據(jù)；
• 如果HTTP/2不可用, 連接池復(fù)用技術(shù)也可以極大減少延時(shí)；
• 支持Gzip壓縮響應(yīng)體，降低傳輸內(nèi)容的大小；
• 支持Http緩存，避免重復(fù)請(qǐng)求；
• 如果您的服務(wù)器配置了多個(gè)IP地址, 當(dāng)?shù)谝粋€(gè)IP連接失敗的時(shí)候, OkHttp會(huì)自動(dòng)嘗試下一個(gè)IP；
• 使用Okio來(lái)簡(jiǎn)化數(shù)據(jù)的訪問(wèn)與存儲(chǔ)，提高性能；
• OkHttp還處理了代理服務(wù)器問(wèn)題和SSL握手失敗問(wèn)題；

6.4.2 OkHttp類與Http請(qǐng)求響應(yīng)的映射

1. Http請(qǐng)求

http請(qǐng)求包含：請(qǐng)求方法, 請(qǐng)求地址, 請(qǐng)求協(xié)議, 請(qǐng)求頭, 請(qǐng)求體這五部分。這些都在okhttp3.Request的類中有體現(xiàn), 這個(gè)類正是代表http請(qǐng)求的類。

public final class Request { final HttpUrl url;//請(qǐng)求地址 final String method;//請(qǐng)求方法 final Headers headers;//請(qǐng)求頭 final RequestBody body;//請(qǐng)求體 final Object tag; ... } 

2. Http響應(yīng)

Http響應(yīng)由訪問(wèn)協(xié)議, 響應(yīng)碼, 描述信息, 響應(yīng)頭, 響應(yīng)體來(lái)組成。

public final class Response implements Closeable { final Request request;//持有的請(qǐng)求 final Protocol protocol;//訪問(wèn)協(xié)議 final int code;//響應(yīng)碼 final String message;//描述信息 final Handshake handshake;//SSL/TLS握手協(xié)議驗(yàn)證時(shí)的信息, final Headers headers;//響應(yīng)頭 final ResponseBody body;//響應(yīng)體 ... } 

6.4.3 相關(guān)方法

1. OkHttpClient

• OkHttpClient()
• OkHttpClient(OkHttpClient.Builder builder)
• newCall(Request request) Call

OkHttpClient.Builder

• connectTimeout(long timeout, TimeUnit unit)
• readTimeout(long timeout, TimeUnit unit)
• writeTimeout(long timeout, TimeUnit unit)
• pingInterval(long interval, TimeUnit unit)
• cache(Cache cache) 入?yún)⑷纾?code>new Cache(File directory, long maxSize)
• cookieJar(CookieJar cookieJar) CookieJar是一個(gè)接口
• hostnameVerifier(HostnameVerifier hostnameVerifier) HostnameVerifier是一個(gè)接口，只有boolean verify(String hostname, SSLSession session)
• sslSocketFactory(SSLSocketFactory sslSocketFactory, X509TrustManager trustManager)

2. Request

• Request(Request.Builder builder)

Request.Builder

• addHeader(String name, String value) 添加鍵值對(duì)，不會(huì)覆蓋
• header(String name, String value) 添加鍵值對(duì)，會(huì)覆蓋
• url(String url)
• method(String method, RequestBody body)
• post(RequestBody body) 本質(zhì)：method("POST", body)
• build() Request

RequestBody

• create(MediaType contentType, final File file) RequestBody
• create(MediaType contentType, String content) RequestBody
• create(MediaType contentType, byte[] content) RequestBody

FormBody

RequestBody的子類

FormBody.Builder

• add(String name, String value) FormBody.Builder
• build() FormBody

MultipartBody

RequestBody的子類

MultipartBody.Builder

• Builder()
• Builder(String boundary)
• setType(MediaType type)
• addPart(Headers headers, RequestBody body)
• addFormDataPart(String name, String filename, RequestBody body)
• build() MultipartBody

3. Call

Call負(fù)責(zé)發(fā)送請(qǐng)求和讀取響應(yīng)

• enqueue(Callback responseCallback)加入調(diào)度隊(duì)列，異步執(zhí)行
• execute() Response 同步執(zhí)行
• cancel()

4. Response

• body() ResponseBody
• code() int http請(qǐng)求的狀態(tài)碼
• isSuccessful() code為2XX時(shí)，返回true，否則false
• headers() Headers

ResponseBody

• string() String
• bytes() byte[]
• byteStream() InputStream
• charStream() Reader
• contentLength() long

5. MediaType

RequestBody的數(shù)據(jù)格式都要指定Content-Type，就是指定MIME，常見(jiàn)的有三種：

• application/x-www-form-urlencoded 數(shù)據(jù)是個(gè)普通表單（默認(rèn)）
• multipart/form-data 數(shù)據(jù)里有文件
• application/json 數(shù)據(jù)是個(gè)json

方法：

• parse(String string) MediaType

參數(shù)	說(shuō)明
text/html	HTML格式
text/plain	純文本格式
image/gif	gif圖片格式
image/jpeg	jpg圖片格式
image/png	png圖片格式
application/json	JSON數(shù)據(jù)格式
application/pdf	pdf格式
application/msword	Word文檔格式
application/octet-stream	二進(jìn)制流數(shù)據(jù)
application/x-www-form-urlencoded	普通表單數(shù)據(jù)
multipart/form-data	表單數(shù)據(jù)里有文件

6. 自動(dòng)管理Cookie

Request經(jīng)常都要攜帶Cookie，request創(chuàng)建時(shí)可以通過(guò)header設(shè)置參數(shù)，Cookie也是參數(shù)之一。就像下面這樣：

Request request = new Request.Builder() .url(url) .header("Cookie", "xxx") .build(); 

然后可以從返回的response里得到新的Cookie，你可能得想辦法把Cookie保存起來(lái)。
但是OkHttp可以不用我們管理Cookie，自動(dòng)攜帶，保存和更新Cookie。
方法是在創(chuàng)建OkHttpClient設(shè)置管理Cookie的CookieJar：

private final HashMap<String, List<Cookie>> cookieStore = new HashMap<>(); OkHttpClient okHttpClient = new OkHttpClient.Builder() .cookieJar(new CookieJar() { @Override public void saveFromResponse(HttpUrl httpUrl, List<Cookie> list) { cookieStore.put(httpUrl.host(), list); }@Override public List<Cookie> loadForRequest(HttpUrl httpUrl) { List<Cookie> cookies = cookieStore.get(httpUrl.host()); return cookies != null ? cookies : new ArrayList<Cookie>(); } }) .build(); 

這樣以后發(fā)送Request都不用管Cookie這個(gè)參數(shù)也不用去response獲取新Cookie什么的了。還能通過(guò)cookieStore獲取當(dāng)前保存的Cookie。
最后，new OkHttpClient()只是一種快速創(chuàng)建OkHttpClient的方式，更標(biāo)準(zhǔn)的是使用OkHttpClient.Builder()。后者可以設(shè)置一堆參數(shù)，例如超時(shí)時(shí)間什么的。

6.4.4 get請(qǐng)求

1. 異步的get請(qǐng)求

//step 1: 創(chuàng)建 OkHttpClient 對(duì)象 OkHttpClient okHttpClient = new OkHttpClient(); //step 2： 創(chuàng)建一個(gè)請(qǐng)求，不指定請(qǐng)求方法時(shí)默認(rèn)是GET。 Request.Builder requestBuilder = new Request.Builder().url("http://www.baidu.com"); //可以省略，默認(rèn)是GET請(qǐng)求 requestBuilder.method("GET", null); //step 3：創(chuàng)建 Call 對(duì)象 Call call = okHttpClient.newCall(requestBuilder.build()); //step 4: 開(kāi)始異步請(qǐng)求 call.enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { }@Override public void onResponse(Call call, Response response) throws IOException { //獲得返回體 ResponseBody body = response.body(); } }); 

首先要將OkHttpClient的對(duì)象與Request的對(duì)象建立起來(lái)聯(lián)系，使用okHttpClient的newCall()方法得到一個(gè)Call對(duì)象，這個(gè)Call對(duì)象的作用就是相當(dāng)于將請(qǐng)求封裝成了一個(gè)任務(wù)，既然是任務(wù)，自然就會(huì)有execute()和cancel()等方法。

最后，我們希望以異步的方式去執(zhí)行請(qǐng)求，所以我們調(diào)用的是call.enqueue，將call加入調(diào)度隊(duì)列，然后等待任務(wù)執(zhí)行完成，我們?cè)贑allback中即可得到結(jié)果。但要注意的是，call的回調(diào)是子線程，所以是不能直接操作界面的。當(dāng)請(qǐng)求成功時(shí)就會(huì)回調(diào)onResponse()方法，我們可以看到返回的結(jié)果是Response對(duì)象，在此我們比較關(guān)注的是請(qǐng)求中的返回體body（ResponseBody類型），大多數(shù)的情況下我們希望獲得字符串從而進(jìn)行json解析獲得數(shù)據(jù)，所以可以通過(guò)body.string()的方式獲得字符串。如果希望獲得返回的二進(jìn)制字節(jié)數(shù)組，則調(diào)用response.body().bytes()；如果你想拿到返回的inputStream，則調(diào)用response.body().byteStream()。

2. 同步的get請(qǐng)求

調(diào)用Call#execute()方法，在主線程運(yùn)行

6.4.5 post請(qǐng)求

1. Post上傳表單（鍵值對(duì)）

//step1: 同樣的需要?jiǎng)?chuàng)建一個(gè)OkHttpClick對(duì)象 OkHttpClient okHttpClient = new OkHttpClient(); //step2: 創(chuàng)建 FormBody.Builder FormBody formBody = new FormBody.Builder() .add("name", "dsd") //添加鍵值對(duì) .build(); //step3: 創(chuàng)建請(qǐng)求 Request request = new Request.Builder().url("http://www.baidu.com") .post(formBody) .build() //step4： 建立聯(lián)系 創(chuàng)建Call對(duì)象 okHttpClient.newCall(request).enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { }@Override public void onResponse(Call call, Response response) throws IOException { } }); 

2. Post異步上傳文件

// step 1: 創(chuàng)建 OkHttpClient 對(duì)象 OkHttpClient okHttpClient = new OkHttpClient(); //step 2:創(chuàng)建 RequestBody 以及所需的參數(shù) //2.1 獲取文件 File file = new File(Environment.getExternalStorageDirectory() + "test.txt"); //2.2 創(chuàng)建 MediaType 設(shè)置上傳文件類型 MediaType MEDIATYPE = MediaType.parse("text/plain; charset=utf-8"); //2.3 獲取請(qǐng)求體 RequestBody requestBody = RequestBody.create(MEDIATYPE, file); //step 3：創(chuàng)建請(qǐng)求 Request request = new Request.Builder().url("http://www.baidu.com") .post(requestBody) .build(); //step 4 建立聯(lián)系 okHttpClient.newCall(request).enqueue(new Callback() { @Override public void onFailure(Call call, IOException e) { }@Override public void onResponse(Call call, Response response) throws IOException { } }); 

3. Post方式提交流

以流的方式POST提交請(qǐng)求體. 請(qǐng)求體的內(nèi)容由流寫(xiě)入產(chǎn)生. 這個(gè)例子是流直接寫(xiě)入Okio的BufferedSink. 你的程序可能會(huì)使用OutputStream, 你可以使用BufferedSink.outputStream()來(lái)獲取. OkHttp的底層對(duì)流和字節(jié)的操作都是基于Okio庫(kù), Okio庫(kù)也是Square開(kāi)發(fā)的另一個(gè)IO庫(kù), 填補(bǔ)I/O和NIO的空缺, 目的是提供簡(jiǎn)單便于使用的接口來(lái)操作IO.

public static final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8"); private final OkHttpClient client = new OkHttpClient();public void run() throws Exception { RequestBody requestBody = new RequestBody() { @Override public MediaType contentType() { return MEDIA_TYPE_MARKDOWN; }@Override public void writeTo(BufferedSink sink) throws IOException { sink.writeUtf8("Numbers\n"); sink.writeUtf8("-------\n"); for (int i = 2; i <= 997; i++) { sink.writeUtf8(String.format(" * %s = %s\n", i, factor(i))); } }private String factor(int n) { for (int i = 2; i < n; i++) { int x = n / i; if (x * i == n) return factor(x) + " × " + i; } return Integer.toString(n); } };Request request = new Request.Builder() .url("https://api.github.com/markdown/raw") .post(requestBody) .build();Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); } 

4. Post方式提交String

下面是使用HTTP POST提交請(qǐng)求到服務(wù). 這個(gè)例子提交了一個(gè)markdown文檔到web服務(wù), 以HTML方式渲染markdown. 因?yàn)檎麄€(gè)請(qǐng)求體都在內(nèi)存中, 因此避免使用此api提交大文檔（大于1MB）.

public static final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");private final OkHttpClient client = new OkHttpClient();public void run() throws Exception { String postBody = "" + "Releases\n" + "--------\n" + "\n" + " * _1.0_ May 6, 2013\n" + " * _1.1_ June 15, 2013\n" + " * _1.2_ August 11, 2013\n";Request request = new Request.Builder() .url("https://api.github.com/markdown/raw") .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, postBody)) .build();Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);System.out.println(response.body().string()); } 

5、Post方式提交分塊請(qǐng)求

MultipartBody.Builder可以構(gòu)建復(fù)雜的請(qǐng)求體, 與HTML文件上傳形式兼容. 多塊請(qǐng)求體中每塊請(qǐng)求都是一個(gè)請(qǐng)求體, 可以定義自己的請(qǐng)求頭. 這些請(qǐng)求頭可以用來(lái)描述這塊請(qǐng)求, 例如它的Content-Disposition. 如果Content-Length和Content-Type可用的話, 他們會(huì)被自動(dòng)添加到請(qǐng)求頭中.

private static final String IMGUR_CLIENT_ID = "..."; private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");private final OkHttpClient client = new OkHttpClient();public void run() throws Exception { // Use the imgur image upload API as documented at https://api.imgur.com/endpoints/image RequestBody requestBody = new MultipartBody.Builder() .setType(MultipartBody.FORM) .addFormDataPart("title", "Square Logo") .addFormDataPart("image", "logo-square.png", RequestBody.create(MEDIA_TYPE_PNG, new File("website/static/logo-square.png"))) .build();Request request = new Request.Builder() .header("Authorization", "Client-ID " + IMGUR_CLIENT_ID) .url("https://api.imgur.com/3/image") .post(requestBody) .build();Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);System.out.println(response.body().string()); } 

六、其他用法

1、提取響應(yīng)頭

典型的HTTP頭是一個(gè)Map<String, String> : 每個(gè)字段都有一個(gè)或沒(méi)有值. 但是一些頭允許多個(gè)值。
當(dāng)寫(xiě)請(qǐng)求頭的時(shí)候, 使用header(name, value)可以設(shè)置唯一的name、value. 如果已經(jīng)有值, 舊的將被移除, 然后添加新的. 使用addHeader(name, value)可以添加多值（添加, 不移除已有的）.
當(dāng)讀取響應(yīng)頭時(shí), 使用header(name)返回最后出現(xiàn)的name、value. 通常情況這也是唯一的name、value. 如果沒(méi)有值, 那么header(name)將返回null. 如果想讀取字段對(duì)應(yīng)的所有值, 使用headers(name)`會(huì)返回一個(gè)list.
為了獲取所有的Header, Headers類支持按index訪問(wèn).

private final OkHttpClient client = new OkHttpClient(); public void run() throws Exception { Request request = new Request.Builder() .url("https://api.github.com/repos/square/okhttp/issues") .header("User-Agent", "OkHttp Headers.java") .addHeader("Accept", "application/json; q=0.5") .addHeader("Accept", "application/vnd.github.v3+json") .build(); Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println("Server: " + response.header("Server")); System.out.println("Date: " + response.header("Date")); System.out.println("Vary: " + response.headers("Vary")); } 

2、使用Gson來(lái)解析JSON響應(yīng)

Gson是一個(gè)在JSON和Java對(duì)象之間轉(zhuǎn)換非常方便的api庫(kù). 這里我們用Gson來(lái)解析Github API的JSON響應(yīng).
注意: ResponseBody.charStream()使用響應(yīng)頭Content-Type指定的字符集來(lái)解析響應(yīng)體. 默認(rèn)是UTF-8.

private final OkHttpClient client = new OkHttpClient(); private final Gson gson = new Gson();public void run() throws Exception { Request request = new Request.Builder() .url("https://api.github.com/gists/c2a7c39532239ff261be") .build(); Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);Gist gist = gson.fromJson(response.body().charStream(), Gist.class); for (Map.Entry<String, GistFile> entry : gist.files.entrySet()) { System.out.println(entry.getKey()); System.out.println(entry.getValue().content); } }static class Gist { Map<String, GistFile> files; }static class GistFile { String content; } 

3、響應(yīng)緩存

OKHTTP如果要設(shè)置緩存，首要的條件就是設(shè)置一個(gè)緩存文件夾，在Android中為了安全起見(jiàn)，一般設(shè)置為私密數(shù)據(jù)空間。通過(guò)getExternalCacheDir()獲取。
如然后通過(guò)調(diào)用OKHttpClient.Builder中的cache()方法。如下面代碼所示：

//緩存文件夾 File cacheFile = new File(getExternalCacheDir().toString(),"cache"); //緩存大小為10M int cacheSize = 10 * 1024 * 1024; //創(chuàng)建緩存對(duì)象 Cache cache = new Cache(cacheFile,cacheSize);OkHttpClient client = new OkHttpClient.Builder() .cache(cache) .build(); 

設(shè)置好Cache我們就可以正常訪問(wèn)了。我們可以通過(guò)獲取到的Response對(duì)象拿到它正常的消息和緩存的消息。

Response的消息有兩種類型，CacheResponse和NetworkResponse。CacheResponse代表從緩存取到的消息，NetworkResponse代表直接從服務(wù)端返回的消息。
示例代碼如下：

private void testCache(){ //緩存文件夾 File cacheFile = new File(getExternalCacheDir().toString(),"cache"); //緩存大小為10M int cacheSize = 10 * 1024 * 1024; //創(chuàng)建緩存對(duì)象 final Cache cache = new Cache(cacheFile,cacheSize);new Thread(new Runnable() { @Override public void run() { OkHttpClient client = new OkHttpClient.Builder() .cache(cache) .build(); //官方的一個(gè)示例的url String url = "http://publicobject.com/helloworld.txt";Request request = new Request.Builder() .url(url) .build(); Call call1 = client.newCall(request); Response response1 = null; try { //第一次網(wǎng)絡(luò)請(qǐng)求 response1 = call1.execute(); Log.i(TAG, "testCache: response1 :"+response1.body().string()); Log.i(TAG, "testCache: response1 cache :"+response1.cacheResponse()); Log.i(TAG, "testCache: response1 network :"+response1.networkResponse()); response1.body().close(); } catch (IOException e) { e.printStackTrace(); }Call call12 = client.newCall(request);try { //第二次網(wǎng)絡(luò)請(qǐng)求 Response response2 = call12.execute(); Log.i(TAG, "testCache: response2 :"+response2.body().string()); Log.i(TAG, "testCache: response2 cache :"+response2.cacheResponse()); Log.i(TAG, "testCache: response2 network :"+response2.networkResponse()); Log.i(TAG, "testCache: response1 equals response2:"+response2.equals(response1)); response2.body().close(); } catch (IOException e) { e.printStackTrace(); } } }).start();} 

我們?cè)谏厦娴拇a中，用同一個(gè)url地址分別進(jìn)行了兩次網(wǎng)絡(luò)訪問(wèn)，然后分別用Log打印它們的信息。打印的結(jié)果主要說(shuō)明了一個(gè)現(xiàn)象，第一次訪問(wèn)的時(shí)候，Response的消息是NetworkResponse消息，此時(shí)CacheResponse的值為Null.而第二次訪問(wèn)的時(shí)候Response是CahceResponse，而此時(shí)NetworkResponse為空。也就說(shuō)明了上面的示例代碼能夠進(jìn)行網(wǎng)絡(luò)請(qǐng)求的緩存。

其實(shí)控制緩存的消息頭往往是服務(wù)端返回的信息中添加的如”Cache-Control:max-age=60”。所以，會(huì)有兩種情況。

1. 客戶端和服務(wù)端開(kāi)發(fā)能夠很好溝通，按照達(dá)成一致的協(xié)議，服務(wù)端按照規(guī)定添加緩存相關(guān)的消息頭。
2. 客戶端與服務(wù)端的開(kāi)發(fā)根本就不是同一家公司，沒(méi)有辦法也不可能要求服務(wù)端按照客戶端的意愿進(jìn)行開(kāi)發(fā)。

第一種辦法當(dāng)然很好，只要服務(wù)器在返回消息的時(shí)候添加好Cache-Control相關(guān)的消息便好。

第二種情況，就很麻煩，你真的無(wú)法左右別人的行為。怎么辦呢？好在OKHTTP能夠很輕易地處理這種情況。那就是定義一個(gè)攔截器，
人為地添加Response中的消息頭，然后再傳遞給用戶，這樣用戶拿到的Response就有了我們理想當(dāng)中的消息頭Headers，從而達(dá)到控制緩存的意圖，正所謂移花接木。

緩存之?dāng)r截器

因?yàn)閿r截器可以拿到Request和Response，所以可以輕而易舉地加工這些東西。在這里我們?nèi)藶榈靥砑覥ache-Control消息頭。

class CacheInterceptor implements Interceptor{@Override public Response intercept(Chain chain) throws IOException {Response originResponse = chain.proceed(chain.request());//設(shè)置緩存時(shí)間為60秒，并移除了pragma消息頭，移除它的原因是因?yàn)閜ragma也是控制緩存的一個(gè)消息頭屬性 return originResponse.newBuilder().removeHeader("pragma") .header("Cache-Control","max-age=60").build(); } } 

定義好攔截器中后，我們可以添加到OKHttpClient中了。

private void testCacheInterceptor(){ //緩存文件夾 File cacheFile = new File(getExternalCacheDir().toString(),"cache"); //緩存大小為10M int cacheSize = 10 * 1024 * 1024; //創(chuàng)建緩存對(duì)象 final Cache cache = new Cache(cacheFile,cacheSize);OkHttpClient client = new OkHttpClient.Builder() .addNetworkInterceptor(new CacheInterceptor()) .cache(cache) .build(); ....... } 

代碼后面部分有省略。主要通過(guò)在OkHttpClient.Builder()中addNetworkInterceptor()中添加。而這樣也挺簡(jiǎn)單的，就幾步完成了緩存代碼。

攔截器進(jìn)行緩存的缺點(diǎn)

1. 網(wǎng)絡(luò)訪問(wèn)請(qǐng)求的資源是文本信息，如新聞列表，這類信息經(jīng)常變動(dòng)，一天更新好幾次，它們用的緩存時(shí)間應(yīng)該就很短。
2. 網(wǎng)絡(luò)訪問(wèn)請(qǐng)求的資源是圖片或者視頻，它們變動(dòng)很少，或者是長(zhǎng)期不變動(dòng)，那么它們用的緩存時(shí)間就應(yīng)該很長(zhǎng)。

那么，問(wèn)題來(lái)了。
因?yàn)镺KHTTP開(kāi)發(fā)建議是同一個(gè)APP，用同一個(gè)OKHTTPCLIENT對(duì)象這是為了只有一個(gè)緩存文件訪問(wèn)入口。這個(gè)很容易理解，單例模式嘛。但是問(wèn)題攔截器是在OKHttpClient.Builder當(dāng)中添加的。如果在攔截器中定義緩存的方法會(huì)導(dǎo)致圖片的緩存和新聞列表的緩存時(shí)間是一樣的，這顯然是不合理的，真實(shí)的情況不應(yīng)該是圖片請(qǐng)求有它的緩存時(shí)間，新聞列表請(qǐng)求有它的緩存時(shí)間，應(yīng)該是每一個(gè)Request有它的緩存時(shí)間。 那么，有解決的方案嗎？ 有的，okhttp官方有建議的方法。

okhttp官方文檔建議緩存方法

okhttp中建議用CacheControl這個(gè)類來(lái)進(jìn)行緩存策略的制定。
它內(nèi)部有兩個(gè)很重要的靜態(tài)實(shí)例。

/**強(qiáng)制使用網(wǎng)絡(luò)請(qǐng)求*/ public static final CacheControl FORCE_NETWORK = new Builder().noCache().build();/*** 強(qiáng)制性使用本地緩存，如果本地緩存不滿足條件，則會(huì)返回code為504*/ public static final CacheControl FORCE_CACHE = new Builder() .onlyIfCached() .maxStale(Integer.MAX_VALUE, TimeUnit.SECONDS) .build(); 

我們看到FORCE_NETWORK常量用來(lái)強(qiáng)制使用網(wǎng)絡(luò)請(qǐng)求。FORCE_CACHE只取本地的緩存。它們本身都是CacheControl對(duì)象，由內(nèi)部的Buidler對(duì)象構(gòu)造。下面我們來(lái)看看CacheControl.Builder

CacheControl.Builder

它有如下方法：

• noCache()//不使用緩存，用網(wǎng)絡(luò)請(qǐng)求
• noStore()//不使用緩存，也不存儲(chǔ)緩存
• onlyIfCached()//只使用緩存
• noTransform()//禁止轉(zhuǎn)碼
• maxAge(10, TimeUnit.MILLISECONDS)//設(shè)置超時(shí)時(shí)間為10ms。
• maxStale(10, TimeUnit.SECONDS)//超時(shí)之外的超時(shí)時(shí)間為10s
• minFresh(10, TimeUnit.SECONDS)//超時(shí)時(shí)間為當(dāng)前時(shí)間加上10秒鐘。

知道了CacheControl的相關(guān)信息，那么它怎么使用呢？不同于攔截器設(shè)置緩存，CacheControl是針對(duì)Request的，所以它可以針對(duì)每個(gè)請(qǐng)求設(shè)置不同的緩存策略。比如圖片和新聞列表。下面代碼展示如何用CacheControl設(shè)置一個(gè)60秒的超時(shí)時(shí)間。

private void testCacheControl(){ //緩存文件夾 File cacheFile = new File(getExternalCacheDir().toString(),"cache"); //緩存大小為10M int cacheSize = 10 * 1024 * 1024; //創(chuàng)建緩存對(duì)象 final Cache cache = new Cache(cacheFile,cacheSize);new Thread(new Runnable() { @Override public void run() { OkHttpClient client = new OkHttpClient.Builder() .cache(cache) .build(); //設(shè)置緩存時(shí)間為60秒 CacheControl cacheControl = new CacheControl.Builder() .maxAge(60, TimeUnit.SECONDS) .build(); Request request = new Request.Builder() .url("http://blog.csdn.net/briblue") .cacheControl(cacheControl) .build(); try { Response response = client.newCall(request).execute(); response.body().close(); } catch (IOException e) { e.printStackTrace(); } } }).start();} 

強(qiáng)制使用緩存

前面有講CacheControl.FORCE_CACHE這個(gè)常量。

public static final CacheControl FORCE_CACHE = new Builder() .onlyIfCached() .maxStale(Integer.MAX_VALUE, TimeUnit.SECONDS) 

它內(nèi)部其實(shí)就是調(diào)用onlyIfCached()和maxStale方法。
它的使用方法為

Request request = new Request.Builder() .url("http://blog.csdn.net/briblue") .cacheControl(Cache.FORCE_CACHE) .build(); 

但是如前面后提到的，如果緩存不符合條件會(huì)返回504.這個(gè)時(shí)候我們要根據(jù)情況再進(jìn)行編碼，如緩存不行就再進(jìn)行一次網(wǎng)絡(luò)請(qǐng)求。

Response forceCacheResponse = client.newCall(request).execute();if (forceCacheResponse.code() != 504) {// 資源已經(jīng)緩存了，可以直接使用} else {// 資源沒(méi)有緩存，或者是緩存不符合條件了。}

不使用緩存

前面也有講CacheControl.FORCE_NETWORK這個(gè)常量。

public static final CacheControl FORCE_NETWORK = new Builder().noCache().build(); 

它的內(nèi)部其實(shí)是調(diào)用noCache()方法，也就是不緩存的意思。
它的使用方法為

Request request = new Request.Builder() .url("http://blog.csdn.net/briblue") .cacheControl(Cache.FORCE_NETWORK) .build(); 

還有一種情況將maxAge設(shè)置為0，也不會(huì)取緩存，直接走網(wǎng)絡(luò)。

Request request = new Request.Builder() .url("http://blog.csdn.net/briblue") .cacheControl(new CacheControl.Builder() .maxAge(0, TimeUnit.SECONDS)) .build(); 

4、取消一個(gè)Call

使用Call.cancel()可以立即停止掉一個(gè)正在執(zhí)行的call. 如果一個(gè)線程正在寫(xiě)請(qǐng)求或者讀響應(yīng), 將會(huì)引發(fā)IOException. 當(dāng)call沒(méi)有必要的時(shí)候, 使用這個(gè)api可以節(jié)約網(wǎng)絡(luò)資源. 例如當(dāng)用戶離開(kāi)一個(gè)應(yīng)用時(shí), 不管同步還是異步的call都可以取消.
你可以通過(guò)tags來(lái)同時(shí)取消多個(gè)請(qǐng)求. 當(dāng)你構(gòu)建一請(qǐng)求時(shí), 使用RequestBuilder.tag(tag)來(lái)分配一個(gè)標(biāo)簽, 之后你就可以用OkHttpClient.cancel(tag)來(lái)取消所有帶有這個(gè)tag的call.

 private final ScheduledExecutorService executor = Executors.newScheduledThreadPool(1);private final OkHttpClient client = new OkHttpClient();public void run() throws Exception { Request request = new Request.Builder() .url("http://httpbin.org/delay/2") // This URL is served with a 2 second delay. .build();final long startNanos = System.nanoTime(); final Call call = client.newCall(request);// Schedule a job to cancel the call in 1 second. executor.schedule(new Runnable() { @Override public void run() { System.out.printf("%.2f Canceling call.%n", (System.nanoTime() - startNanos) / 1e9f); call.cancel(); System.out.printf("%.2f Canceled call.%n", (System.nanoTime() - startNanos) / 1e9f); } }, 1, TimeUnit.SECONDS);try { System.out.printf("%.2f Executing call.%n", (System.nanoTime() - startNanos) / 1e9f); Response response = call.execute(); System.out.printf("%.2f Call was expected to fail, but completed: %s%n", (System.nanoTime() - startNanos) / 1e9f, response); } catch (IOException e) { System.out.printf("%.2f Call failed as expected: %s%n", (System.nanoTime() - startNanos) / 1e9f, e); } } 

5、超時(shí)

沒(méi)有響應(yīng)時(shí)使用超時(shí)結(jié)束call. 沒(méi)有響應(yīng)的原因可能是客戶點(diǎn)鏈接問(wèn)題、服務(wù)器可用性問(wèn)題或者這之間的其他東西. OkHttp支持連接超時(shí), 讀取超時(shí)和寫(xiě)入超時(shí).

private final OkHttpClient client;public ConfigureTimeouts() throws Exception { client = new OkHttpClient.Builder() .connectTimeout(10, TimeUnit.SECONDS) .writeTimeout(10, TimeUnit.SECONDS) .readTimeout(30, TimeUnit.SECONDS) .build(); }public void run() throws Exception { Request request = new Request.Builder() .url("http://httpbin.org/delay/2") // This URL is served with a 2 second delay. .build();Response response = client.newCall(request).execute(); System.out.println("Response completed: " + response); } 

6、每個(gè)call的配置

使用OkHttpClient, 所有的HTTP Client配置包括代理設(shè)置、超時(shí)設(shè)置、緩存設(shè)置. 當(dāng)你需要為單個(gè)call改變配置的時(shí)候, 調(diào)用OkHttpClient.newBuilder(). 這個(gè)api將會(huì)返回一個(gè)builder, 這個(gè)builder和原始的client共享相同的連接池, 分發(fā)器和配置.
下面的例子中，我們讓一個(gè)請(qǐng)求是500ms的超時(shí)、另一個(gè)是3000ms的超時(shí)。

private final OkHttpClient client = new OkHttpClient();public void run() throws Exception { Request request = new Request.Builder() .url("http://httpbin.org/delay/1") // This URL is served with a 1 second delay. .build();try { // Copy to customize OkHttp for this request. OkHttpClient copy = client.newBuilder() .readTimeout(500, TimeUnit.MILLISECONDS) .build();Response response = copy.newCall(request).execute(); System.out.println("Response 1 succeeded: " + response); } catch (IOException e) { System.out.println("Response 1 failed: " + e); }try { // Copy to customize OkHttp for this request. OkHttpClient copy = client.newBuilder() .readTimeout(3000, TimeUnit.MILLISECONDS) .build();Response response = copy.newCall(request).execute(); System.out.println("Response 2 succeeded: " + response); } catch (IOException e) { System.out.println("Response 2 failed: " + e); } } 

七、處理驗(yàn)證

這部分和HTTP AUTH有關(guān).

1、HTTP AUTH

使用HTTP AUTH需要在server端配置http auth信息, 其過(guò)程如下:

• 客戶端發(fā)送http請(qǐng)求（沒(méi)有Authorization header）
• 服務(wù)器發(fā)現(xiàn)配置了http auth, 于是檢查request里面有沒(méi)有"Authorization"的http header
  如果有, 則判斷Authorization里面的內(nèi)容是否在用戶列表里面, Authorization header的典型數(shù)據(jù)為"Authorization: Basic jdhaHY0=", 其中Basic表示基礎(chǔ)認(rèn)證, jdhaHY0=是base64編碼的"user:passwd"字符串. 如果沒(méi)有，或者用戶密碼不對(duì)，則返回http code 401頁(yè)面給客戶端.
• 標(biāo)準(zhǔn)的http瀏覽器在收到401頁(yè)面之后, 應(yīng)該彈出一個(gè)對(duì)話框讓用戶輸入帳號(hào)密碼; 并在用戶點(diǎn)確認(rèn)的時(shí)候再次發(fā)出請(qǐng)求, 這次請(qǐng)求里面將帶上Authorization header.
• 服務(wù)器端認(rèn)證通過(guò)，并返回頁(yè)面
• 瀏覽器顯示頁(yè)面
  一次典型的訪問(wèn)場(chǎng)景是：

2、OkHttp認(rèn)證

OkHttp會(huì)自動(dòng)重試未驗(yàn)證的請(qǐng)求. 當(dāng)響應(yīng)是401 Not Authorized時(shí)，Authenticator會(huì)被要求提供證書(shū). Authenticator的實(shí)現(xiàn)中需要建立一個(gè)新的包含證書(shū)的請(qǐng)求. 如果沒(méi)有證書(shū)可用, 返回null來(lái)跳過(guò)嘗試.
使用Response.challenges()來(lái)獲得任何authentication challenges的 schemes 和 realms. 當(dāng)完成一個(gè)Basic challenge, 使用Credentials.basic(username, password)來(lái)解碼請(qǐng)求頭.

private final OkHttpClient client;public Authenticate() { client = new OkHttpClient.Builder() .authenticator(new Authenticator() { @Override public Request authenticate(Route route, Response response) throws IOException { System.out.println("Authenticating for response: " + response); System.out.println("Challenges: " + response.challenges()); String credential = Credentials.basic("jesse", "password1"); return response.request().newBuilder() .header("Authorization", credential) .build(); } }) .build(); }public void run() throws Exception { Request request = new Request.Builder() .url("http://publicobject.com/secrets/hellosecret.txt") .build();Response response = client.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);System.out.println(response.body().string()); } 

當(dāng)認(rèn)證無(wú)法工作時(shí), 為了避免多次重試, 你可以返回空來(lái)放棄認(rèn)證. 例如, 當(dāng)exact credentials已經(jīng)嘗試過(guò), 你可能會(huì)直接想跳過(guò)認(rèn)證, 可以這樣做:

if (credential.equals(response.request().header("Authorization"))) { return null; // If we already failed with these credentials, don't retry.} 

當(dāng)重試次數(shù)超過(guò)定義的次數(shù), 你若想跳過(guò)認(rèn)證, 可以這樣做:

if (responseCount(response) >= 3) { return null; // If we've failed 3 times, give up. }private int responseCount(Response response) { int result = 1; while ((response = response.priorResponse()) != null) { result++; } return result; } 

參考文獻(xiàn)

OkHttp使用完全教程

本頁(yè)內(nèi)容由塔燈網(wǎng)絡(luò)科技有限公司通過(guò)網(wǎng)絡(luò)收集編輯所得，所有資料僅供用戶學(xué)習(xí)參考，本站不擁有所有權(quán)，如您認(rèn)為本網(wǎng)頁(yè)中由涉嫌抄襲的內(nèi)容，請(qǐng)及時(shí)與我們聯(lián)系，并提供相關(guān)證據(jù)，工作人員會(huì)在5工作日內(nèi)聯(lián)系您，一經(jīng)查實(shí)，本站立刻刪除侵權(quán)內(nèi)容。本文鏈接:http://www.junxiaosheng.cn/20440.html