OkHttp3源码详解(一) Request类

最新推荐文章于 2024-05-18 16:25:44 发布
最新推荐文章于 2024-05-18 16:25:44 发布
阅读量490 收藏 2
点赞数
文章标签： json 移动开发

 

每一次网络请求都是一个Request，Request是对url,method,header,body的封装，也是对Http协议中请求行,请求头,实体内容的封装

1 public final class Request {
2   private final HttpUrl url;
3   private final String method;
4   private final Headers headers;
5   private final RequestBody body;
6   private final Object tag;
7 
8   private volatile CacheControl cacheControl; // Lazily initialized.

1.HttpUrl

HttpUrl主要用来规范普通的url连接，并且解析url的组成部分

现通过下面的例子来示例httpUrl的使用
https://www.google.com/search?q=maplejaw
①使用parse解析url字符串：

HttpUrl url = HttpUrl.parse("https://www.google.com/search?q=maplejaw");

②通过构造者模式来常见:

1 HttpUrl url = new HttpUrl.Builder()
2         .scheme("https")
3         .host("www.google.com")
4         .addPathSegment("search")
5         .addQueryParameter("q", "maplejaw")
6         .build();

2.Headers

Headers用于配置请求头，对于请求头配置大家一定不陌生吧，比如Content-Type,User-Agent和Cache-Control等等。

创建Headers也有两种方式。如下：
(1)of()创建：传入的数组必须是偶数对，否则会抛出异常。

Headers.of("name1","value1","name2","value2",.....);

还可以使用它的重载方法of(Map<String,String> map)方法来创建

(2)构建者模式创建：

Headers mHeaders=new Headers.Builder()
            .set("name1","value1")//set表示name1是唯一的，会覆盖掉已经存在的
            .add("name2","value2")//add不会覆盖已经存在的头，可以存在多个
            .build();

我们来看一下Header的内部，源码就不粘贴了很简单，Headers内部是通过一个数组来保存header private final String[] namesAndValues;大家可能会有这样的疑问，为什么不用Map而用数组呢？因为Map的Key是唯一的，而header要求不唯一

另外，数组方便取数据吗？很方便，我们来看着三个方法

最后通过toString方法转变成String，方便写入请求头，

 1 @Override 
 2 public String toString() {
 3     StringBuilder result = new StringBuilder();
 4     for (int i = 0, size = size(); i < size; i++) {
 5       result.append(name(i)).append(": ").append(value(i)).append("\n");
 6     }
 7     return result.toString();
 8 }
 9 
10 /** Returns the field at {@code position} or null if that is out of range. */
11 public String name(int index) {
12     int nameIndex = index * 2;
13     if (nameIndex < 0 || nameIndex >= namesAndValues.length) {
14       return null;
15     }
16     return namesAndValues[nameIndex];
17 }
18  
19 /** Returns the value at {@code index} or null if that is out of range. */
20 public String value(int index) {
21     int valueIndex = index * 2 + 1;
22     if (valueIndex < 0 || valueIndex >= namesAndValues.length) {
23       return null;
24     }
25     return namesAndValues[valueIndex];
26   }

 

3.RequestBody

 requestBody也就是请求实体内容，我们先来看一下如何来构建一个RequestBody

(1)Request.create()方法创建

 1 public static final MediaType TEXT = MediaType.parse("text/plain; charset=utf-8");
 2 public static final MediaType STREAM = MediaType.parse("application/octet-stream");
 3 public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
 4 
 5 //构建字符串请求体
 6 RequestBody body1 = RequestBody.create(TEXT, string);
 7 //构建字节请求体
 8 RequestBody body2 = RequestBody.create(STREAM, byte);
 9 //构建文件请求体
10 RequestBody body3 = RequestBody.create(STREAM, file);
11 //post上传json
12 RequestBody body4 = RequestBody.create(JSON, json);//json为String类型的
13 
14 //将请求体设置给请求方法内
15 Request request = new Request.Builder()
16 .url(url)
17 .post(xx)// xx表示body1，body2，body3，body4中的某一个
18 .build();
19
View Code

(2)构建表单请求体,提交键值对(OkHttp3没有FormEncodingBuilder这个类，替代它的是功能更加强大的FormBody：)

 //构建表单RequestBody
RequestBody formBody=new FormBody.Builder()
                 .add("name","maplejaw")
                 .add("age","18")
                  ...     
                 .build();

 (3)构建分块表单请求体:(OkHttp3取消了MultipartBuilder,取而代之的是MultipartBody.Builder()
                  既可以添加表单,又可以也可以添加文件等二进制数据)

 1 public static final MediaType STREAM = MediaType.parse("application/octet-stream");
 2  //构建表单RequestBody
 3 RequestBody multipartBody=new MultipartBody.Builder()
 4                 .setType(MultipartBody.FORM)//指明为 multipart/form-data 类型
 5                 .addFormDataPart("age","20") //添加表单数据
 6                 .addFormDataPart("avatar","111.jpg",RequestBody.create(STREAM,file)) //添加文件,其中avatar为表单名，111.jpg为文件名。
 7                 .addPart(..)//该方法用于添加RequestBody,Headers和添加自定义Part，一般来说以上已经够用
 8                 .build();
 9  
10

知道了RequestBody的创建，我们来看一下源码
RequestBody也就是请求实体内容，对于一个Get请求时没有实体内容的，Post提交才有，而且浏览器与服务器通信时基本上只有表单上传才会用到POST提交，所以RequestBody其实也就是封装了浏览器表单上传时对应的实体内容，对于实体内容是什么样还不清楚的可以去看一下我的一篇博客Android的Http协议的通信详解

OkHttp3中RequestBody有三种创建方式

 ①方式一：

 public static RequestBody create(MediaType contentType, String content) {
    Charset charset = Util.UTF_8;
    if (contentType != null) {
      charset = contentType.charset();//MediaType的为请求头中的ContentType创建方式:public static final MediaType TEXT = 
                                      //MediaType.parse("text/plain; charset=utf-8")
      if (charset == null) {
        charset = Util.UTF_8;<span style="font-family:Microsoft YaHei;">//如果contentType中没有指定charset,默认使用UTF-8</span>
        contentType = MediaType.parse(contentType + "; charset=utf-8");
      }
    }
    byte[] bytes = content.getBytes(charset);
    return create(contentType, bytes);
  }
View Code

②方式二:FormBody表单创建，我们来看一下

FormBody用于普通post表单上传键值对，我们先来看一下创建的方法，再看源码

1  RequestBody formBody=new FormBody.Builder()
2                  .add("name","maplejaw")
3                  .add("age","18")
4                   ...     
5                  .build();

FormBody源码

 1 public final class FormBody extends RequestBody {
 2   private static final MediaType CONTENT_TYPE =
 3       MediaType.parse("application/x-www-form-urlencoded");
 4 
 5   private final List<String> encodedNames;
 6   private final List<String> encodedValues;
 7 
 8   private FormBody(List<String> encodedNames, List<String> encodedValues) {
 9     this.encodedNames = Util.immutableList(encodedNames);
10     this.encodedValues = Util.immutableList(encodedValues);
11   }
12 
13   /** The number of key-value pairs in this form-encoded body. */
14   public int size() {
15     return encodedNames.size();
16   }
17 
18   public String encodedName(int index) {
19     return encodedNames.get(index);
20   }
21 
22   public String name(int index) {
23     return percentDecode(encodedName(index), true);
24   }
25 
26   public String encodedValue(int index) {
27     return encodedValues.get(index);
28   }
29 
30   public String value(int index) {
31     return percentDecode(encodedValue(index), true);
32   }
33 
34   @Override public MediaType contentType() {
35     return CONTENT_TYPE;
36   }
37 
38   @Override public long contentLength() {
39     return writeOrCountBytes(null, true);
40   }
41 
42   @Override public void writeTo(BufferedSink sink) throws IOException {
43     writeOrCountBytes(sink, false);
44   }
45 
46   /**
47    * Either writes this request to {@code sink} or measures its content length. We have one method
48    * do double-duty to make sure the counting and content are consistent, particularly when it comes
49    * to awkward operations like measuring the encoded length of header strings, or the
50    * length-in-digits of an encoded integer.
51    */
52   private long writeOrCountBytes(BufferedSink sink, boolean countBytes) {
53     long byteCount = 0L;
54 
55     Buffer buffer;
56     if (countBytes) {
57       buffer = new Buffer();
58     } else {
59       buffer = sink.buffer();
60     }
61 
62     for (int i = 0, size = encodedNames.size(); i < size; i++) {
63       if (i > 0) buffer.writeByte('&');
64       buffer.writeUtf8(encodedNames.get(i));
65       buffer.writeByte('=');
66       buffer.writeUtf8(encodedValues.get(i));
67     }
68 
69     if (countBytes) {
70       byteCount = buffer.size();
71       buffer.clear();
72     }
73 
74     return byteCount;
75   }
76 
77   public static final class Builder {
78     private final List<String> names = new ArrayList<>();
79     private final List<String> values = new ArrayList<>();
80 
81     public Builder add(String name, String value) {
82       names.add(HttpUrl.canonicalize(name, FORM_ENCODE_SET, false, false, true, true));
83       values.add(HttpUrl.canonicalize(value, FORM_ENCODE_SET, false, false, true, true));
84       return this;
85     }
86 
87     public Builder addEncoded(String name, String value) {
88       names.add(HttpUrl.canonicalize(name, FORM_ENCODE_SET, true, false, true, true));
89       values.add(HttpUrl.canonicalize(value, FORM_ENCODE_SET, true, false, true, true));
90       return this;
91     }
92 
93     public FormBody build() {
94       return new FormBody(names, values);
95     }
96   }
97 }
View Code

我们主要来看一下方法writeOrCountBytes，通过writeOrCountBytes来计算请求体大小和将请求体写入BufferedSink。

至于BufferSink和Buffer类，这两个类是Okio中的类，Buffer相当于一个缓存区，BufferedSink相当于OutputStream,它扩展了

OutputStream的功能，Okio的完整源码我后续也会写博客

③方式三：MultipartBody分块表单创建

MultipartBody， 既可以添加表单,又可以也可以添加文件等二进制数据，我们就看几个重要的方法

 public static Part createFormData(String name, String filename, RequestBody body) {
      if (name == null) {
        throw new NullPointerException("name == null");
      }
      StringBuilder disposition = new StringBuilder("form-data; name=");
      appendQuotedString(disposition, name);
 
      if (filename != null) {
        disposition.append("; filename=");
        appendQuotedString(disposition, filename);
      }
 
      return create(Headers.of("Content-Disposition", disposition.toString()), body);
    }
View Code

我们来看这个方法，我们是addPart还是addFormDataPart最终都走到了这个方法，封装成一个Part对象，也就是实体内容中

的Content-Disposition跟文件二进制流或者键值对的值

MultipartBody和FormBody大体上相同，主要区别在于writeOrCountBytes方法，分块表单主要是将每个块的大小进行累加来求出请求体大小，如果其中有一个块没有指定大小，就会返回-1。所以分块表单中如果包含文件，默认是无法计算出大小的，除非你自己给文件的RequestBody指定contentLength。

  private long writeOrCountBytes(BufferedSink sink, boolean countBytes) throws IOException {
    long byteCount = 0L;
 
    Buffer byteCountBuffer = null;
    if (countBytes) {
      //如果是计算大小的话，就new个
      sink = byteCountBuffer = new Buffer();
    }
    //循环块
    for (int p = 0, partCount = parts.size(); p < partCount; p++) {
      Part part = parts.get(p);
      //获取每个块的头
      Headers headers = part.headers;
      //获取每个块的请求体
      RequestBody body = part.body;
 
      //写 --xxxxxxxxxx 边界     
      sink.write(DASHDASH);
      sink.write(boundary);
      sink.write(CRLF);
 
      //写块的头
      if (headers != null) {
        for (int h = 0, headerCount = headers.size(); h < headerCount; h++) {
          sink.writeUtf8(headers.name(h))
              .write(COLONSPACE)
              .writeUtf8(headers.value(h))
              .write(CRLF);
        }
      }
 
      //写块的Content_Type
      MediaType contentType = body.contentType();
      if (contentType != null) {
        sink.writeUtf8("Content-Type: ")
            .writeUtf8(contentType.toString())
            .write(CRLF);
      }
 
      //写块的大小
      long contentLength = body.contentLength();
      if (contentLength != -1) {
        sink.writeUtf8("Content-Length: ")
            .writeDecimalLong(contentLength)
            .write(CRLF);
      } else if (countBytes) {
        // We can't measure the body's size without the sizes of its components.
        //如果有个块没有这名大小，就返回-1.
        byteCountBuffer.clear();
        return -1L;
      }
 
      sink.write(CRLF);
 
      //如果是计算大小就累加，否则写入BufferedSink
      if (countBytes) {
        byteCount += contentLength;
      } else {
        body.writeTo(sink);
      }
 
      sink.write(CRLF);
    }
 
 //写 --xxxxxxxxxx-- 结束边界
    sink.write(DASHDASH);
    sink.write(boundary);
    sink.write(DASHDASH);
    sink.write(CRLF);
 
 
    if (countBytes) {
      byteCount += byteCountBuffer.size();
      byteCountBuffer.clear();
    }
 
    return byteCount;
  }
View Code

4.CacheControl

( 1)  Cache-Control：

Cache-Control指定请求和响应遵循的缓存机制。在请求消息或响应消息中设置Cache-Control并不会修改另一个消息处理过程中的缓存处理过程。请求时的缓存指令有下几种：

  1. Public：所有内容都将被缓存(客户端和代理服务器都可缓存)。
  2. Private：内容只缓存到私有缓存中(仅客户端可以缓存，代理服务器不可缓存)
  3. no-cache：请求或者响应消息不能缓存
  4. no-store：不使用缓存，也不存储缓存
  5. max-age：缓存的内容将在指定时间(秒)后失效, 这个选项只在HTTP 1.1可用, 并如果和Last-Modified一起使用时, 优先级较高
  6. 在 xxx 秒后，浏览器重新发送请求到服务器，指定时间(秒)内,客户端会直接返回cache而不会发起网络请求，若过期会自动发起网络请求
  7. min-fresh：指示客户端可以接收响应时间小于当前时间加上指定时间的响应。
  8. max-stale：指示客户端可以接收超出超时期间的响应消息。如果指定max-stale消息的值，那么客户机可以接收超出超时期指定值之内的响应消息。

（2）CacheControl类

①常用的函数

 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
View Code

②CacheControl的两个常量：

 public static final CacheControl FORCE_NETWORK = new Builder().noCache().build();//不使用缓存
  public static final CacheControl FORCE_CACHE = new Builder()
      .onlyIfCached()
      .maxStale(Integer.MAX_VALUE, TimeUnit.SECONDS)
      .build();//只使用缓存
View Code

③请求时如何使用:

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());
        }
View Code

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

     //判断网络是否连接
        boolean connected = NetworkUtil.isConnected(context);
         if (!connected) {
             request = request.newBuilder().cacheControl(CacheControl.FORCE_CACHE).build();
          }

 

weixin_33912445
关注
  • 0
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Android中okhttp3使用详解
08-29
主要介绍了Android中okhttp3使用详解，非常具有实用价值，需要的朋友可以参考下
一步步带你读懂 Okhttp 源码
徐公，微信公众号同名
09-04 2523
前言 okHttp， square 公司开源的网络请求神器，截止到 2019-09-02，在 Github 上面已经超过 34K 的 star，足见他的受欢迎程度。 到目前为止，他的最新版本是 4.1.0， 使用 kotlin 语言写的，由于本人对 kotlin 语言不是很熟悉，这篇文章已 3.5.0 的版本为基础进行分析。 简介 Rxjava+Okhttp+Refrofit 如今已经成为项目网...
OkHttp3源码详解(一Request类)
热门推荐
刘建的博客
09-03 1万+
上次在哪篇博客看到这句话，我们不重复造轮子不表示我们不需要知道轮子该怎么造及如何更好的造，我觉得很有道理 对于用到项目的某个开源项目我们不应该只停留在会用的阶段，废话不多说，直接开始okhttp源码的学习之路
OkHttp3源码详解(一) Request类，2024移动开发者未来的出路在哪里
03-22 825
文章所有资料全部已经打包整理好，免费分享给有需要的人，另外小编手头上整理了大量Android架构师全套学习资料，Android核心高级技术PDF文档+全套高级学习资料+视频+2021 BAT 大厂面试真题解析，都是免费分享给大家的，全部都已整理在GitHub上，有需要的朋友可以点击前往领取更多。8495825)]由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频如果你觉得这些内容对你有帮助，可以添加下面V无偿领取！（备注Android）
OkHttp3源码详解(一) Request类，2021年Android开发实战
m0_65145426的博客
12-17 1701
HttpUrl主要用来规范普通的url连接，并且解析url的组成部分 现通过下面的例子来示例httpUrl的使用 https://www.google.com/search?q=maplejaw ①使用parse解析url字符串： HttpUrl url = HttpUrl.parse(“https://www.google.com/search?q=maplejaw”); ②通过构造者模式来常见: HttpUrl url = new HttpUrl.Builder() .scheme(“
OkHttp3源码详解(一) Request类，android混合开发专利
m0_66264655的博客
01-24 1139
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;..
OKhttp3源码
08-18
Okhttp3的源码，便于研究Okhttp的机制
OkHttp源码详解
11-30
详细讲解OKHttp的实现。。。。。。在网络请求的小节中，我们已经看到了Interceptor的布局，在负责和服务器建立连接的ConnectInterceptor之前，就是CacheInterceptor。他们执行过程就是：在建立连接之前，我们检查...
okhttp3源码运行
12-10
https://blog.csdn.net/sky_castle/article/details/84943896
spring集成okhttp3的步骤详解
08-27
okhttp是一个封装URL,比HttpClient更友好易用的工具，下面这篇文章主要给大家介绍了关于spring集成okhttp3的相关资料，文中通过示例代码介绍的非常详细，对大家的学习或工作具有一定的参考学习价值，需要的朋友们...
Ubuntu22.04本地部署qwen模型、jupyterlab开发环境、LoRA微调全流程-续
最新发布
weixin_42118737的博客
05-18 656
接着上一篇，在Ubuntu22.04本地部署qwen模型，准备数据，进行LoRA微调。
Python中的requests.post的参数json与参数data有什么区别
但老师
05-17 284
在我们自己搭建web或者爬虫的时候, 都需要用到requests这个第三方模块, 大部分时候我们使用的都是其中的data参数, 但是偶尔也需要用到json。
uni-app环境变量 & 动态配置manifest.json
每天都要努力学习哦~~
05-18 638
1.需要本地调试时，点击HBuilder X工具栏“运行”，选择自定义的对应的环境；2.代码中通过获取配置的变量，或者全局注册或者局部引入env.js 通过 ENV_CONFIG[process.env.UNI_SCRIPT].requestBaseUrl获取3.发布时, 点击HBuilder X工具栏“运行”，选择自定义的对应的环境,编译后打开微信开发者工具或者支付宝开发者工具,上传即可(运行的哪个环境,上传的就是哪个环境),也可以点击HBuilder X工具栏 "发行" ,选择自定义的对应的环境。
springboot接口同时接收文件和json数据
lovebosom的博客
05-18 140
MultipartFile file HttpMediaTypeNotSupportedException
HarmonyOS应用模型Stage基本介绍
编程小栈
05-13 806
HarmonyOS应用模型概况。一般来说现在的鸿蒙应用使用的模型都是stage模型，之前的FA模型，现在已经被弃用了。就在本博客中，我们将会介绍一些这个模型下的一些基本重要的概念
Delphi7：SuperObject 的示例
程序猿视角
05-15 444
另外，由于 Delphi 7 是一个相对较旧的版本，如果你打算在新的项目中使用 JSON 功能，建议考虑升级到更新的 Delphi 版本或使用其他现代的 JSON 库，这样可以获得更好的性能和更多的功能。不是一个 Delphi 7 自带或官方的库，但可能是指一些开源的 JSON 解析库，比如。务必参考你所使用的库的官方文档或示例代码以确保正确性。请注意，上述代码是基于假设的示例，并且可能需要根据你实际使用的。如果你有一个 JSON 格式的字符串，你可以使用。或类似的方法来设置和获取 JSON 对象的值。
QJsonObject构建指定的JSON结构
A185822153的专栏
05-16 315
接着，为每条消息创建了一个QJsonObject󠁪，并设置了"role"和"content"键值对。最后，将消息对象加入到数组中，并将这个数组添加到最外层的json对象里。如今我们生活处处用到AI,AI 带给了我们很多方便，但作为程序员我们，虽然不能开发什么 AI，但时不时需要调用国内四大平台的AI接口。1，我们先以QJsonObject 构建 "messages": [ {"role": "user","content": "你好"}] 为例。如下接口数据 ，有些人不知道怎么构建。总结：是不是很简单。
webGis 气象格点数据解析
weiweiweb888的博客
05-17 159
格点数据的原始数据一般是数据或grib2数据，然后解析后的数据。
okhttp3 Request 复用
09-20
复用okhttp3 Request可以通过以下步骤来实现： 1. 首先，判断URL地址是否相等，如果相等，则可以直接返回true，说明该Request可以复用。 2. 然后，判断是否采用了http2的请求。因为http2可以合并请求并重用相同的...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值