1、网络请求发展
历史上Http请求库优缺点
httpURLConnection—>Apache http ClIEnt—>Volley—->okhttp
2、项目开源地址
https://github.com/square/okhttp
3、Okhttp是什么
OKhttp是一个网络请求开源项目，AndroID网络请求轻量级框架,支持文件上传与下载，支持https。2、Okhttp的作用Okhttp是一个高效的http库:
支持http/2, http/2通过使用多路复用技术在一个单独的TCP连接上支持并发, 通过在一个连接上一次性发送多个请求来发送或接收数据如果http/2不可用, 连接池复用技术也可以极大减少延时支持GZIP, 可以压缩下载体积响应缓存可以直接避免重复请求会从很多常用的连接问题中自动恢复如果您的服务器配置了多个IP地址, 当第一个IP连接失败的时候, Okhttp会自动尝试下一个IP Okhttp还处理了代理服务器问题和SSL握手失败问题优势
使用 Okhttp无需重写您程序中的网络代码。Okhttp实现了几乎和java.net.httpURLConnection一样的API。如果您用了 Apache httpClIEnt，则Okhttp也提供了一个对应的okhttp-apache 模块3、Okhttp的基本使用Okhttp的基本使用，从以下五方面讲解：
1.Get请求(同步和异步)2.POST请求表单(key-value)3.POST请求提交(JsON/String/文件等)4.文件下载5.请求超时设置加入build.gradle
compile 'com.squareup.okhttp3:okhttp:3.6.0'@H_419_152@3.1、http请求和响应的组成http请求
所以一个类库要完成一个http请求, 需要包含 请求方法, 请求地址, 请求协议, 请求头, 请求体这五部分. 这些都在okhttp3.Request的类中有体现, 这个类正是代表http请求的类. 看下图:
其中
httpUrl类代表请求地址,String method代表请求方法,headers代表请求头,Requestbody代表请求体.Object tag这个是用来取消http请求的标志, 这个我们先不管.http响应
响应组成图:
可以看到大体由
应答首行, 应答头, 应答体构成. 但是应答首行表达的信息过多, http/1.1表示访问协议, 200是响应码, OK是描述状态的消息.根据单一职责, 我们不应该把这么多内容用一个应答首行来表示. 这样的话, 我们的响应就应该由访问协议, 响应码, 描述信息, 响应头, 响应体来组成.
3.2、Okhttp请求和响应的组成Okhttp请求
构造一个http请求, 并查看请求具体内容:
final Request request = new Request.Builder().url("https://github.com/").build();@H_419_152@我们看下在内存中, 这个请求是什么样子的, 是否如我们上文所说和
请求方法, 请求地址, 请求头, 请求体一一对应.
Okhttp响应Okhttp库怎么表示一个响应:
可以看到Response类里面有Protocol代表请求协议,int code代表响应码,String message代表描述信息,headers代表响应头,ResponseBody代表响应体. 当然除此之外, 还有Request代表持有的请求,Handshake代表SSL/TLS握手协议验证时的信息, 这些额外信息我们暂时不问.有了刚才说的Okhttp响应的类组成, 我们看下Okhttp请求后响应在内存中的内容:
final Request request = new Request.Builder().url("https://github.com/").build();Response response = clIEnt.newCall(request).execute();@H_419_152@3.3、GET请求同步方法同步GET的意思是一直等待http请求, 直到返回了响应. 在这之间会阻塞进程, 所以通过get不能在AndroID的主线程中执行, 否则会报错.
对于同步请求在请求时需要开启子线程，请求成功后需要跳转到UI线程修改UI。
public voID getDatasync(){ new Thread(new Runnable() { @OverrIDe public voID run() { try { OkhttpClIEnt clIEnt = new OkhttpClIEnt();//创建OkhttpClIEnt对象 Request request = new Request.Builder() .url("http://www.baIDu.com")//请求接口。如果需要传参拼接到接口后面。 .build();//创建Request 对象 Response response = null; response = clIEnt.newCall(request).execute();//得到Response 对象 if (response.isSuccessful()) { Log.d("kwwl","response.code()=="+response.code()); Log.d("kwwl","response.message()=="+response.message()); Log.d("kwwl","res=="+response.body().string()); //此时的代码执行在子线程，修改UI的 *** 作请使用handler跳转到UI线程。 } } catch (Exception e) { e.printstacktrace(); } } }).start();}@H_419_152@此时打印结果如下：
response.code()==200；response.message()OK；res{“code”:200,“message”:success};@H_419_152@
OkhttpClIEnt实现了Call.Factory接口, 是Call的工厂类,Call负责发送执行请求和读取响应.
Request代表http请求, 通过Request.Builder辅助类来构建.
clIEnt.newCall(request)通过传入一个http request, 返回一个Call调用. 然后执行execute()方法, 同步获得Response代表http请求的响应. response.body()是ResponseBody类, 代表响应体注意事项：
1，Response.code是http响应行中的code，如果访问成功则返回200.这个不是服务器设置的，而是http协议中自带的。res中的code才是服务器设置的。注意二者的区别。
2，response.body().string()本质是输入流的读 *** 作，所以它还是网络请求的一部分，所以这行代码必须放在子线程。
3，response.body().string()只能调用一次，在第一次时有返回值，第二次再调用时将会返回null。原因是：response.body().string()的本质是输入流的读 *** 作，必须有服务器的输出流的写 *** 作时客户端的读 *** 作才能得到数据。而服务器的写 *** 作只执行一次，所以客户端的读 *** 作也只能执行一次，第二次将返回null。
4、响应体的string()方法对于小文档来说十分方便高效. 但是如果响应体太大（超过1MB）, 应避免使用 string()方法, 因为它会将把整个文档加载到内存中.
5、对于超过1MB的响应body, 应使用流的方式来处理响应body. 这和我们处理xml文档的逻辑是一致的, 小文件可以载入内存树状解析, 大文件就必须流式解析.
注解：
3.4、GET请求异步方法
responseBody.string()获得字符串的表达形式, 或responseBody.bytes()获得字节数组的表达形式, 这两种形式都会把文档加入到内存. 也可以通过responseBody.charStream()和responseBody.byteStream()返回流来处理.异步GET是指在另外的工作线程中执行http请求, 请求时
不会阻塞当前的线程, 所以可以在AndroID主线程中使用.这种方式不用再次开启子线程，但回调方法是执行在子线程中，所以在更新UI时还要跳转到UI线程中。
下面是在一个工作线程中下载文件, 当响应可读时回调
Callback接口. 当响应头准备好后, 就会调用Callback接口, 所以读取响应体时可能会阻塞. Okhttp现阶段不提供异步API来接收响应体。private final OkhttpClIEnt clIEnt = new OkhttpClIEnt(); public voID run() throws Exception { Request request = new Request.Builder() .url("http://publicobject.com/helloworld.txt") .build(); clIEnt.newCall(request).enqueue(new Callback() { @OverrIDe public voID onFailure(Request request, Throwable throwable) { throwable.printstacktrace(); } @OverrIDe public voID onResponse(Response response) throws IOException { if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); headers responseheaders = response.headers(); for (int i = 0; i < responseheaders.size(); i++) { System.out.println(responseheaders.name(i) + ": " + responseheaders.value(i)); } System.out.println(response.body().string()); } });}@H_419_152@异步请求的打印结果与注意事项与同步请求时相同。最大的不同点就是异步请求不需要开启子线程，
enqueue方法会自动将网络请求部分放入子线程中执行。注意事项：
1，回调接口的onFailure方法和onResponse执行在子线程。2，response.body().string()方法也必须放在子线程中。当执行这行代码得到结果后，再跳转到UI线程修改UI。3.5、post请求方法Post请求也分同步和异步两种方式，同步与异步的区别和get方法类似，所以此时只讲解post异步请求的使用方法。
private voID postDataWithParame() { OkhttpClIEnt clIEnt = new OkhttpClIEnt();//创建OkhttpClIEnt对象。 FormBody.Builder formBody = new FormBody.Builder();//创建表单请求体 formBody.add("username","zhangsan");//传递键值对参数 Request request = new Request.Builder()//创建Request 对象。 .url("http://www.baIDu.com") .post(formBody.build())//传递请求体 .build(); clIEnt.newCall(request).enqueue(new Callback() {。。。});//回调方法的使用与get异步请求相同，此时略。}@H_419_152@看完代码我们会发现：post请求中并没有设置请求方式为POST，回忆在get请求中也没有设置请求方式为GET，那么是怎么区分请求方式的呢？重点是Request.Builder类的post方法，在Request.Builder对象创建最初默认是get请求，所以在get请求中不需要设置请求方式，当调用post方法时把请求方式修改为POST。所以此时为POST请求。
3.6、POST请求传递参数的方法总结3.6.1、Post方式提交String下面是使用http POST提交请求到服务. 这个例子提交了一个markdown文档到web服务, 以HTML方式渲染markdown. 因为整个请求体都在内存中, 因此避免使用此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());}@H_419_152@3.6.2、Post方式提交流以流的方式POST提交请求体. 请求体的内容由流写入产生. 这个例子是流直接写入Okio的BufferedSink. 你的程序可能会使用OutputStream, 你可以使用BufferedSink.outputStream()来获取. Okhttp的底层对流和字节的 *** 作都是基于Okio库, Okio库也是Square开发的另一个IO库, 填补I/O和NIO的空缺, 目的是提供简单便于使用的接口来 *** 作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());}@H_419_152@3.6.3、Post方式提交文件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 { file file = new file("README.md"); Request request = new Request.Builder() .url("https://API.github.com/markdown/raw") .post(Requestbody.create(MEDIA_TYPE_MARKDOWN, file)) .build(); Response response = clIEnt.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string());}@H_419_152@3.6.4、Post方式提交表单使用FormEnCodingBuilder来构建和HTML标签相同效果的请求体. 键值对将使用一种HTML兼容形式的URL编码来进行编码.
private final OkhttpClIEnt clIEnt = new OkhttpClIEnt(); public voID run() throws Exception { Requestbody formBody = new FormBody.Builder() .add("search", "Jurassic Park") .build(); Request request = new Request.Builder() .url("https://en.wikipedia.org/w/index.PHP") .post(formBody) .build(); Response response = clIEnt.newCall(request).execute(); if (!response.isSuccessful()) throw new IOException("Unexpected code " + response); System.out.println(response.body().string()); }@H_419_152@3.7、POST其他用法3.7.1、提取响应头典型的http头像是一个
Map<String, String>: 每个字段都有一个或没有值. 但是一些头允许多个值, 像Guava的Multimap例如:
http响应里面提供的vary响应头, 就是多值的. Okhttp的API试图让这些情况都适用.
当写请求头的时候, 使用header(name, value)可以设置唯一的name、value. 如果已经有值, 旧的将被移除,然后添加新的. 使用addheader(name, value)可以添加多值（添加, 不移除已有的）.当读取响应头时, 使用header(name)返回最后出现的name、value. 通常情况这也是唯一的name、value.如果没有值, 那么header(name)将返回null. 如果想读取字段对应的所有值,使用headers(name)会返回一个List.为了获取所有的header, headers类支持按index访问.
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"));}@H_419_152@3.7.2、使用Gson来解析JsON响应Gson是一个在JsON和Java对象之间转换非常方便的API库. 这里我们用Gson来解析Github API的JsON响应.
注意: ResponseBody.charStream()使用响应头Content-Type指定的字符集来解析响应体. 默认是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; }@H_419_152@3.7.3、响应缓存为了缓存响应, 你需要一个你可以读写的缓存目录, 和缓存大小的限制. 这个缓存目录应该是私有的, 不信任的程序应不能读取缓存内容.
一个缓存目录同时拥有多个缓存访问是错误的. 大多数程序只需要调用一次new Okhttp(), 在第一次调用时配置好缓存, 然后其他地方只需要调用这个实例就可以了. 否则两个缓存示例互相干扰, 破坏响应缓存, 而且有可能会导致程序崩溃.
响应缓存使用http头作为配置. 你可以在请求头中添加Cache-Control: max-stale=3600 , Okhttp缓存会支持. 你的服务通过响应头确定响应缓存多长时间, 例如使用Cache-Control: max-age=9600.
private final OkhttpClIEnt clIEnt; public CacheResponse(file cacheDirectory) throws Exception { int cacheSize = 10 * 1024 * 1024; // 10 MiB Cache cache = new Cache(cacheDirectory, cacheSize); clIEnt = new OkhttpClIEnt(); clIEnt.setCache(cache);} public voID run() throws Exception { Request request = new Request.Builder() .url("http://publicobject.com/helloworld.txt") .build(); Response response1 = clIEnt.newCall(request).execute(); if (!response1.isSuccessful()) throw new IOException("Unexpected code " + response1); String response1Body = response1.body().string(); System.out.println("Response 1 response: " + response1); System.out.println("Response 1 cache response: " + response1.cacheResponse()); System.out.println("Response 1 network response: " + response1.networkResponse()); Response response2 = clIEnt.newCall(request).execute(); if (!response2.isSuccessful()) throw new IOException("Unexpected code " + response2); String response2Body = response2.body().string(); System.out.println("Response 2 response: " + response2); System.out.println("Response 2 cache response: " + response2.cacheResponse()); System.out.println("Response 2 network response: " + response2.networkResponse()); System.out.println("Response 2 equals Response 1? " + response1Body.equals(response2Body));}@H_419_152@如果需要阻值response使用缓存, 使用
CacheControl.FORCE_NETWORK. 如果需要阻值response使用网络, 使用CacheControl.FORCE_CACHE.警告
3.8、综合实例
如果你使用FORCE_CACHE, 但是response要求使用网络, Okhttp将会返回一个504 Unsatisfiable Request响应.参考链接
activity_main<?xml version="1.0" enCoding="utf-8"?><linearLayout xmlns:androID="http://schemas.androID.com/apk/res/androID" androID:layout_wIDth="match_parent" androID:layout_height="match_parent" androID:orIEntation="vertical"> <linearLayout androID:layout_wIDth="match_parent" androID:layout_height="wrap_content" androID:gravity="center_horizontal" androID:orIEntation="horizontal"> <button androID:ID="@+ID/syncGet" androID:layout_wIDth="wrap_content" androID:layout_height="wrap_content" androID:text="同步请求"/> <button androID:ID="@+ID/asyncget" androID:layout_wIDth="wrap_content" androID:layout_height="wrap_content" androID:text="异步请求"/> <button androID:ID="@+ID/post" androID:layout_wIDth="wrap_content" androID:layout_height="wrap_content" androID:text="表单提交"/> <button androID:ID="@+ID/fileDownload" androID:layout_wIDth="wrap_content" androID:layout_height="wrap_content" androID:text="文件下载"/> </linearLayout> <TextVIEw androID:ID="@+ID/tv_text" androID:layout_wIDth="match_parent" androID:layout_height="wrap_content"/></linearLayout>@H_419_152@MainActivity
package com.example.okhttpdemo;import androID.os.Bundle;import androID.support.v7.app.AppCompatActivity;import androID.util.Log;import androID.vIEw.VIEw;import androID.Widget.button;import androID.Widget.TextVIEw;import java.io.file;import java.io.fileOutputStream;import java.io.IOException;import java.io.inputStream;import java.util.concurrent.TimeUnit;import okhttp3.Call;import okhttp3.Callback;import okhttp3.FormBody;import okhttp3.OkhttpClIEnt;import okhttp3.Request;import okhttp3.Response;public class MainActivity extends AppCompatActivity implements VIEw.OnClickListener { private button syncGet; private button asyncget; private button post; private button fileDownload; private TextVIEw tvtext; private String result; private static OkhttpClIEnt clIEnt = new OkhttpClIEnt(); /** * 在这里直接设置连接超时，静态方法内，在构造方法被调用前就已经初始话了 */ static { clIEnt.newBuilder().connectTimeout(10, TimeUnit.SECONDS); clIEnt.newBuilder().readTimeout(10, TimeUnit.SECONDS); clIEnt.newBuilder().writeTimeout(10, TimeUnit.SECONDS); } private Request request; @OverrIDe protected voID onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentVIEw(R.layout.activity_main); initialize(); initListener(); } /** * 事件监听 */ private voID initListener() { syncGet.setonClickListener(this); asyncget.setonClickListener(this); post.setonClickListener(this); fileDownload.setonClickListener(this); } /** * 初始化布局控件 */ private voID initialize() { syncGet = (button) findVIEwByID(R.ID.syncGet); asyncget = (button) findVIEwByID(R.ID.asyncget); post = (button) findVIEwByID(R.ID.post); tvtext = (TextVIEw) findVIEwByID(R.ID.tv_text); fileDownload = (button) findVIEwByID(R.ID.fileDownload); } @OverrIDe public voID onClick(VIEw v) { switch (v.getID()) { case R.ID.syncGet: initSyncdata(); break; case R.ID.asyncget: initAsyncGet(); break; case R.ID.post: initPost(); break; case R.ID.fileDownload: downLoadfile(); break; default： break; } } /** * get请求同步方法 */ private voID initSyncdata() { new Thread(new Runnable() { @OverrIDe public voID run() { try { request = new Request.Builder().url(Contants.SYNC_URL).build(); Response response = clIEnt.newCall(request).execute(); result = response.body().string(); runOnUiThread(new Runnable() { @OverrIDe public voID run() { tvtext.setText(result); Log.d("MainActivity", "hello"); } }); } catch (Exception e) { e.printstacktrace(); } } }).start(); } /** * 异步请求 */ private voID initAsyncGet() { new Thread(new Runnable() { @OverrIDe public voID run() { request = new Request.Builder().url(Contants.ASYNC_URL).build(); clIEnt.newCall(request).enqueue(new Callback() { /** * @param call 是一个接口， 是一个准备好的可以执行的request * 可以取消，对位一个请求对象，只能单个请求 * @param e */ @OverrIDe public voID onFailure(Call call, IOException e) { Log.d("MainActivity", "请求失败"); } /** * * @param call * @param response 是一个响应请求 * @throws IOException */ @OverrIDe public voID onResponse(Call call, Response response) throws IOException { /** * 通过拿到response这个响应请求，然后通过body().string(),拿到请求到的数据 * 这里最好用string() 而不要用toString（） * toString（）每个类都有的，是把对象转换为字符串 * string（）是把流转为字符串 */ result = response.body().string(); runOnUiThread(new Runnable() { @OverrIDe public voID run() { tvtext.setText(result); } }); } }); } }).start(); } /** * 表单提交 */ private voID initPost() { String url = "http://112.124.22.238:8081/course_API/banner/query"; FormBody formBody = new FormBody.Builder() .add("type", "1") .build(); request = new Request.Builder().url(url) .post(formBody).build(); new Thread(new Runnable() { @OverrIDe public voID run() { clIEnt.newCall(request).enqueue(new Callback() { @OverrIDe public voID onFailure(Call call, IOException e) { } @OverrIDe public voID onResponse(Call call, final Response response) throws IOException { runOnUiThread(new Runnable() { @OverrIDe public voID run() { tvtext.setText("提交成功"); } }); } }); } }).start(); } /** * 文件下载地址 */ private voID downLoadfile() { String url = "http://www.0551fangchan.com/images/keupload/20120917171535_49309.jpg"; request = new Request.Builder().url(url).build(); OkhttpClIEnt clIEnt = new OkhttpClIEnt(); clIEnt.newCall(request).enqueue(new Callback() { @OverrIDe public voID onFailure(Call call, IOException e) { } @OverrIDe public voID onResponse(Call call, Response response) throws IOException { //把请求成功的response转为字节流 inputStream inputStream = response.body().byteStream(); /** * 在这里要加上权限 在mainfests文件中 * <uses-permission androID:name="androID.permission.INTERNET"/> * <uses-permission androID:name="androID.permission.WRITE_EXTERNAL_STORAGE"/> */ //在这里用到了文件输出流 fileOutputStream fileOutputStream = new fileOutputStream(new file("/sdcard/logo.jpg")); //定义一个字节数组 byte[] buffer = new byte[2048]; int len = 0; while ((len = inputStream.read(buffer)) != -1) { //写出到文件 fileOutputStream.write(buffer, 0, len); } //关闭输出流 fileOutputStream.flush(); Log.d("wuyinlei", "文件下载成功..."); } }); }}@H_419_152@参考1、https://blog.csdn.net/fightingXia/article/details/70947701
总结
2、https://blog.csdn.net/chenzujIE/article/details/46994073
3、https://blog.csdn.net/weixin_30700099/article/details/95962192
4、https://www.jianshu.com/p/5a12ae6d741a
5、https://www.jianshu.com/p/ca8a982a116b
6、https://wuyinlei.blog.csdn.net/article/details/50579564以上是内存溢出为你收集整理的Android：OkHttp的理解和使用全部内容，希望文章能够帮你解决Android：OkHttp的理解和使用所遇到的程序开发问题。
如果觉得内存溢出网站内容还不错，欢迎将内存溢出网站推荐给程序员好友。
欢迎分享，转载请注明来源：内存溢出
微信扫一扫
支付宝扫一扫
评论列表（0条）