OkHttp3详解

一.Request
每一次网络请求都是一个Request，Request是对url,method,header,body的封装，也是对Http协议中请求行,请求头,实体内容的封装
Request request = new Request  
                  .Builder()  
                  .url(url)  
                  .post(body)  
                  .addHeader("Accept","*/*")  
                  .cacheContro()  
                  .build(); 
 
通常我们通过构建折模式来构建一个Request，Request主要有如下属性:
private final HttpUrl url; //请求url封装  
private final String method; //请求方法  
private final Headers headers; //请求头  
private final RequestBody body; //请求体,也就是http协议的实体内容  
private final Object tag; //被请求的标签  
private volatile URL javaNetUrl; // Lazily initialized.  
private volatile URI javaNetUri; // Lazily initialized.  
private volatile CacheControl cacheControl; // 缓存控制的封装  

----------------------------------------------------------------------------------------------------------------------------------
1.HttpUrl
HttpUrl主要用来规范普通的url连接，并且解析url的组成部分
我们来看一下url的构成；
(1).HttpUrl
HttpUrl主要用来规范普通的url连接，并且解析url的组成部分
scheme://username:password@host:port/pathSegment/pathSegment?queryParameter#fragment;
① Url的构成
普通URL的各部分组成
http://www.aspxfans.com:8080/news/index.asp?boardID=5&ID=24618&page=1#name
从上面的URL可以看出，一个完整的URL包括以下几部分：
1.协议部分：该URL的协议部分为“http：”，这代表网页使用的是HTTP协议。在Internet中可以使用多种协议，如HTTP，FTP等等本例中使用的是HTTP协议。在"HTTP"后面的“//”为分隔符
2.域名部分：该URL的域名部分为“www.aspxfans.com”。一个URL中，也可以使用IP地址作为域名使用
3.端口部分：跟在域名后面的是端口，域名和端口之间使用“:”作为分隔符。端口不是一个URL必须的部分，如果省略端口部分，将采用默认端口
4.虚拟目录部分：从域名后的第一个“/”开始到最后一个“/”为止，是虚拟目录部分。虚拟目录也不是一个URL必须的部分。本例中的虚拟目录是“/news/”
5.文件名部分：从域名后的最后一个“/”开始到“？”为止，是文件名部分，如果没有“?”,则是从域名后的最后一个“/”开始到“#”为止，是文件部分，如果没有“？”和“#”，那么从域名后的最后一个“/”开始到结束，都是文件名部分。本例中的文件名是“index.asp”。文件名部分也不是一个URL必须的部分，如果省略该部分，则使用默认的文件名
6.锚部分：从“#”开始到最后，都是锚部分。本例中的锚部分是“name”。锚部分也不是一个URL必须的部分
7.参数部分：从“？”开始到“#”为止之间的部分为参数部分，又称搜索部分、查询部分。本例中的参数部分为“boardID=5&ID=24618&page=1”。参数可以允许有多个参数，参数与参数之间用“&”作为分隔符。

使用parse解析url字符串：
HttpUrl url = HttpUrl.parse("https://www.google.com/search?q=maplejaw");  
通过构造者模式来常见:
HttpUrl url = new HttpUrl.Builder()  
        .scheme("https")  
        .host("www.google.com")  
        .addPathSegment("search")  
        .addQueryParameter("q", "maplejaw")  
        .build();


(2)
Headers
Headers用于配置请求头，对于请求头配置大家一定不陌生吧，比如Content-Type,User-Agent和Cache-Control等等。
创建Headers也有两种方式。如下：
① of()创建：传入的数组必须是偶数对，否则会抛出异常。
Headers.of("name1","value1","name2","value2",.....);  
还可以使用它的重载方法of(Map map)方法来创建

② 构建者模式创建：
Headers mHeaders=new Headers.Builder()  
           .set("name1","value1") //set表示name1是唯一的，会覆盖掉已经存在的  
           .add("name2","value2") //add不会覆盖已经存在的头，可以存在多个  
           .build();  
Headers内部是通过一个数组来保存header (不用Map原因：Map的Key是唯一的，而header要求不唯一)
    private final String[] namesAndValues;

Headers.java
public final class Headers {
private final String[] namesAndValues;
......

    public String name(int index) {
        return this.namesAndValues[index * 2];
    }
    ......
    public String value(int index) {
        return this.namesAndValues[index * 2 + 1];
    }

public String toString() { // 转变成String，方便写入请求头
        StringBuilder result = new StringBuilder();
        int i = 0;
        for(int size = this.size(); i < size; ++i) {
            result.append(this.name(i)).append(": ").append(this.value(i)).append("\n");
        }
        return result.toString();
    }

......

}

(3) CacheControl
Cache-Control对应请求头中Cache-Control中的值，我们先来看一下Http协议中Cache-Control
① Cache-Control：
Cache-Control指定请求和响应遵循的缓存机制。在请求消息或响应消息中设置Cache-Control并不会修改另一个消息处理过程中的缓存处理过程。
请求时的缓存指令有下几种：
Public：所有内容都将被缓存(客户端和代理服务器都可缓存)。
Private：内容只缓存到私有缓存中(仅客户端可以缓存，代理服务器不可缓存)
no-cache：请求或者响应消息不能缓存
no-store：不使用缓存，也不存储缓存
max-age：缓存的内容将在指定时间(秒)后失效, 这个选项只在HTTP 1.1可用, 并如果和Last-Modified一起使用时, 优先级较高
在 xxx 秒后，浏览器重新发送请求到服务器，指定时间(秒)内,客户端会直接返回cache而不会发起网络请求，若过期会自动发起网络请求
min-fresh：指示客户端可以接收响应时间小于当前时间加上指定时间的响应。
max-stale：指示客户端可以接收超出超时期间的响应消息。如果指定max-stale消息的值，那么客户机可以接收超出超时期指定值之内的响应消息。

② CacheControl类
(1)常用的函数
final CacheControl.Builder builder = new CacheControl.Builder();  
           builder.noCache();//不使用缓存，全部走网络  
           builder.noStore();//不使用缓存，也不存储缓存  
           builder.onlyIfCached();//只使用缓存  
           builder.noTransform();//禁止转码  
           builder.maxAge(10, TimeUnit.MILLISECONDS);//指示客户机可以接收生存期不大于指定时间的响应。  
           builder.maxStale(10, TimeUnit.SECONDS);//指示客户机可以接收超出超时期间的响应消息  
           builder.minFresh(10, TimeUnit.SECONDS);//指示客户机可以接收响应时间小于当前时间加上指定时间的响应。  
           CacheControl cache = builder.build();//cacheControl  

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

    ......

    static {
        FORCE_CACHE = (new CacheControl.Builder()).onlyIfCached().maxStale(2147483647, TimeUnit.SECONDS).build();
    }
    ......
}

③请求时如何使用:
final CacheControl.Builder builder = new CacheControl.Builder();  
            builder.maxAge(10, TimeUnit.MILLISECONDS);  
            CacheControl cache = builder.build();  
            final Request request = new Request.Builder().cacheControl(cache).url(requestUrl).build();  
            final Call call = mOkHttpClient.newCall(request);//  
            call.enqueue(new Callback() {  
                @Override  
                public void onFailure(Call call, IOException e) {  
                    failedCallBack("访问失败", callBack);  
                    Log.e(TAG, e.toString());  
                }  
  
                @Override  
                public void onResponse(Call call, Response response) throws IOException {  
                    if (response.isSuccessful()) {  
                        String string = response.body().string();  
                        Log.e(TAG, "response ----->" + string);  
                        successCallBack((T) string, callBack);  
                    } else {  
                        failedCallBack("服务器错误", callBack);  
                    }  
                }  
            });  
            return call;  
        } catch (Exception e) {  
            Log.e(TAG, e.toString());  
        }  
}

以上如果Cache没有过去会直接返回cache而不会去发起网络请求，若过期自动发起网络请求，注意：如果您使用FORCE_CACHE和网络的响应需求，OkHttp则会返回一个504提示，告诉你不可满足请求响应，所以我们加一个判断在没有网络的情况下使用

//判断网络是否连接  
boolean connected = NetworkUtil.isConnected(context);  
if (!connected) {  
    request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE).build();  
}  
----------------------------------------------------------------------------------------------------------------------------------
2.RequestBody
requestBody也就是请求实体内容，我们先来看一下如何来构建一个RequestBody
(1)Request.create()方法创建

public static final MediaType TEXT = MediaType.parse("text/plain; charset=utf-8");  
   public static final MediaType STREAM = MediaType.parse("application/octet-stream");  
   public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");  
  
   //构建字符串请求体  
   RequestBody body1 = RequestBody.create(TEXT, string);  
   //构建字节请求体  
   RequestBody body2 = RequestBody.create(STREAM, byte);  
   //构建文件请求体  
   RequestBody body3 = RequestBody.create(STREAM, file);  
   //post上传json  
   RequestBody body4 = RequestBody.create(JSON, json);//json为String类型的  
  
   //将请求体设置给请求方法内  
   Request request = new Request.Builder()  
     .url(url)  
     .post(xx)// xx表示body1，body2，body3，body4中的某一个  
     .build();

(2)构建表单请求体,提交键值对(OkHttp3没有FormEncodingBuilder这个类，替代它的是功能更加强大的FormBody：)
//构建表单RequestBody  
    RequestBody formBody=new FormBody.Builder()  
                .add("name","maplejaw")  
                .add("age","18")  
                 ...       
                .build();  

(3)构建分块表单请求体:(OkHttp3取消了MultipartBuilder,取而代之的是MultipartBody.Builder()
                  既可以添加表单,又可以也可以添加文件等二进制数据)
public static final MediaType STREAM = MediaType.parse("application/octet-stream");  
      //构建表单RequestBody  

      RequestBody multipartBody=new MultipartBody.Builder()  
                .setType(MultipartBody.FORM)           //指明为 multipart/form-data 类型  
                .addFormDataPart("age","20")            //添加表单数据  
                .addFormDataPart("avatar","111.jpg",RequestBody.create(STREAM,file)) 
                                         //添加文件,其中avatar为表单名，111.jpg为文件名。  
               .addPart(..)         //该方法用于添加RequestBody,Headers和添加自定义Part，一般来说以上已经够用
               .build();

RequestBody也就是请求实体内容，对于一个Get请求时没有实体内容的，Post提交才有，而且浏览器与服务器通信时基本上只有表单上传才会用到POST提交，所以RequestBody其实也就是封装了浏览器表单上传时对应的实体内容