OkHttp3.0（一）OkHttp的基本使用

OkHttp3.0系列博客&＃xff0c;适合从零基础开始&＃xff0c;深入学习OkHttp3.0&＃xff0c;可以掌握OkHttp的基本使用、源码分析。本文是第一篇文章&＃xff0c;主要介绍OkHttp3.0的基本使用&＃xff0c;由于自己并没有维护服务器端&＃xff0c;并且找一些适合作为测试的公开接口比较麻烦&＃xff0c;所以转载了别人的&＃xff0c;个人觉得写得挺不错&＃xff0c;简单明了&＃xff0c;容易理解掌握。

I.简介

HTTP是现代应用常用的一种交换数据和媒体的网络方式&＃xff0c;高效地使用HTTP能让资源加载更快&＃xff0c;节省带宽。OkHttp是一个高效的HTTP客户端&＃xff0c;它有以下默认特性&＃xff1a;

• 支持HTTP/2&＃xff0c;允许所有同一个主机地址的请求共享同一个socket连接
• 连接池减少请求延时
• 透明的GZIP压缩减少响应数据的大小
• 缓存响应内容&＃xff0c;避免一些完全重复的请求

当网络出现问题的时候OkHttp依然坚守自己的职责&＃xff0c;它会自动恢复一般的连接问题&＃xff0c;如果你的服务有多个IP地址&＃xff0c;当第一个IP请求失败时&＃xff0c;OkHttp会交替尝试你配置的其他IP&＃xff0c;OkHttp使用现代TLS技术(SNI, ALPN)初始化新的连接&＃xff0c;当握手失败时会回退到TLS 1.0。

note: OkHttp 支持 Android 2.3 及以上版本Android平台&＃xff0c; 对于 Java, JDK 1.7及以上.

II.使用

OkHttp的使用是非常简单的. 它的请求/响应 API 使用构造器模式builders来设计&＃xff0c;它支持阻塞式的同步请求和带回调的异步请求。

Download OkHttp3

implementation &＃39;com.squareup.okhttp3:okhttp:3.10.0&＃39;


当你看到这的时候&＃xff0c;可能最新的稳定版已经不是3.10.0了&＃xff0c;你需要移步官方GitHub来查看最新版本。 官方地址 https://github.com/square/okhttp&＃xff0c;另外不要忘了在清单文件声明访问Internet的权限&＃xff0c;如果使用 DiskLruCache&＃xff0c;那还得声明写外存的权限。

1.1. 异步GET请求

-new OkHttpClient;
-构造Request对象&＃xff1b;
-通过前两步中的对象构建Call对象&＃xff1b;
-通过Call#enqueue(Callback)方法来提交异步请求&＃xff1b;

String url &＃61; "http://wwww.baidu.com";
OkHttpClient okHttpClient &＃61; new OkHttpClient();
final Request request &＃61; new Request.Builder().url(url).get()//默认就是GET请求&＃xff0c;可以不写.build();
Call call &＃61; okHttpClient.newCall(request);
call.enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: ");}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {Log.d(TAG, "onResponse: " &＃43; response.body().string());}
});


异步发起的请求会被加入到 Dispatcher 中的 runningAsyncCalls双端队列中通过线程池来执行。

1.2. 同步GET请求

前面几个步骤和异步方式一样&＃xff0c;只是最后一部是通过 Call#execute() 来提交请求&＃xff0c;注意这种方式会阻塞调用线程&＃xff0c;所以在Android中应放在子线程中执行&＃xff0c;否则有可能引起ANR异常&＃xff0c;Android3.0 以后已经不允许在主线程访问网络。

String url &＃61; "http://wwww.baidu.com";
OkHttpClient okHttpClient &＃61; new OkHttpClient();
final Request request &＃61; new Request.Builder().url(url).build();
final Call call &＃61; okHttpClient.newCall(request);
new Thread(new Runnable() {&＃64;Overridepublic void run() {try {Response response &＃61; call.execute();Log.d(TAG, "run: " &＃43; response.body().string());} catch (IOException e) {e.printStackTrace();}}
}).start();


2.1. POST方式提交String

这种方式与前面的区别就是在构造Request对象时&＃xff0c;需要多构造一个RequestBody对象&＃xff0c;用它来携带我们要提交的数据。在构造 RequestBody 需要指定MediaType&＃xff0c;用于描述请求/响应 body 的内容类型&＃xff0c;关于 MediaType 的更多信息可以查看 RFC 2045&＃xff0c;RequstBody的几种构造方式&＃xff1a;

request_body

MediaType mediaType &＃61; MediaType.parse("text/x-markdown; charset&＃61;utf-8");
String requestBody &＃61; "I am Jdqm.";
Request request &＃61; new Request.Builder().url("https://api.github.com/markdown/raw").post(RequestBody.create(mediaType, requestBody)).build();
OkHttpClient okHttpClient &＃61; new OkHttpClient();
okHttpClient.newCall(request).enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: " &＃43; e.getMessage());}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {Log.d(TAG, response.protocol() &＃43; " " &＃43;response.code() &＃43; " " &＃43; response.message());Headers headers &＃61; response.headers();for (int i &＃61; 0; i });


响应内容

http/1.1 200 OK
Date:Sat, 10 Mar 2018 05:23:20 GMT
Content-Type:text/html;charset&＃61;utf-8
Content-Length:18
Server:GitHub.com
Status:200 OK
X-RateLimit-Limit:60
X-RateLimit-Remaining:52
X-RateLimit-Reset:1520661052
X-CommonMarker-Version:0.17.4
Access-Control-Expose-Headers:ETag, Link, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-IntervalAccess-Control-Allow-Origin:*
Content-Security-Policy:default-src &＃39;none&＃39;
Strict-Transport-Security:max-age&＃61;31536000; includeSubdomains; preload
X-Content-Type-Options:nosniff
X-Frame-Options:deny
X-XSS-Protection:1; mode&＃61;block
X-Runtime-rack:0.019668
Vary:Accept-Encoding
X-GitHub-Request-Id:1474:20A83:5CC0B6:7A7C1B:5AA36BC8
onResponse:

I am Jdqm.

2.2 POST方式提交流

RequestBody requestBody &＃61; new RequestBody() {&＃64;Nullable&＃64;Overridepublic MediaType contentType() {return MediaType.parse("text/x-markdown; charset&＃61;utf-8");}&＃64;Overridepublic void writeTo(BufferedSink sink) throws IOException {sink.writeUtf8("I am Jdqm.");}
};Request request &＃61; new Request.Builder().url("https://api.github.com/markdown/raw").post(requestBody).build();
OkHttpClient okHttpClient &＃61; new OkHttpClient();
okHttpClient.newCall(request).enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: " &＃43; e.getMessage());}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {Log.d(TAG, response.protocol() &＃43; " " &＃43;response.code() &＃43; " " &＃43; response.message());Headers headers &＃61; response.headers();for (int i &＃61; 0; i });


2.3. POST提交文件

MediaType mediaType &＃61; MediaType.parse("text/x-markdown; charset&＃61;utf-8");
OkHttpClient okHttpClient &＃61; new OkHttpClient();
File file &＃61; new File("test.md");
Request request &＃61; new Request.Builder().url("https://api.github.com/markdown/raw").post(RequestBody.create(mediaType, file)).build();
okHttpClient.newCall(request).enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: " &＃43; e.getMessage());}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {Log.d(TAG, response.protocol() &＃43; " " &＃43;response.code() &＃43; " " &＃43; response.message());Headers headers &＃61; response.headers();for (int i &＃61; 0; i });


2.4. POST方式提交表单

OkHttpClient okHttpClient &＃61; new OkHttpClient();
RequestBody requestBody &＃61; new FormBody.Builder().add("search", "Jurassic Park").build();
Request request &＃61; new Request.Builder().url("https://en.wikipedia.org/w/index.php").post(requestBody).build();okHttpClient.newCall(request).enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: " &＃43; e.getMessage());}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {Log.d(TAG, response.protocol() &＃43; " " &＃43;response.code() &＃43; " " &＃43; response.message());Headers headers &＃61; response.headers();for (int i &＃61; 0; i });


提交表单时&＃xff0c;使用 RequestBody 的实现类FormBody来描述请求体&＃xff0c;它可以携带一些经过编码的 key-value 请求体&＃xff0c;键值对存储在下面两个集合中&＃xff1a;

private final List encodedNames;private final List encodedValues;


2.5. POST方式提交分块请求

MultipartBody 可以构建复杂的请求体&＃xff0c;与HTML文件上传形式兼容。多块请求体中每块请求都是一个请求体&＃xff0c;可以定义自己的请求头。这些请求头可以用来描述这块请求&＃xff0c;例如它的 Content-Disposition 。如果 Content-Length 和 Content-Type 可用的话&＃xff0c;他们会被自动添加到请求头中。

private static final String IMGUR_CLIENT_ID &＃61; "...";
private static final MediaType MEDIA_TYPE_PNG &＃61; MediaType.parse("image/png");private void postMultipartBody() {OkHttpClient client &＃61; new OkHttpClient();// Use the imgur image upload API as documented at https://api.imgur.com/endpoints/imageMultipartBody body &＃61; new MultipartBody.Builder("AaB03x").setType(MultipartBody.FORM).addPart(Headers.of("Content-Disposition", "form-data; name&＃61;\"title\""),RequestBody.create(null, "Square Logo")).addPart(Headers.of("Content-Disposition", "form-data; name&＃61;\"image\""),RequestBody.create(MEDIA_TYPE_PNG, new File("website/static/logo-square.png"))).build();Request request &＃61; new Request.Builder().header("Authorization", "Client-ID " &＃43; IMGUR_CLIENT_ID).url("https://api.imgur.com/3/image").post(body).build();Call call &＃61; client.newCall(request);call.enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {System.out.println(response.body().string());}});
}


III.拦截器-interceptor

OkHttp的拦截器链可谓是其整个框架的精髓&＃xff0c;用户可传入的 interceptor 分为两类&＃xff1a;
①一类是全局的 interceptor&＃xff0c;该类 interceptor 在整个拦截器链中最早被调用&＃xff0c;通过 OkHttpClient.Builder#addInterceptor(Interceptor) 传入&＃xff1b;
②另外一类是非网页请求的 interceptor &＃xff0c;这类拦截器只会在非网页请求中被调用&＃xff0c;并且是在组装完请求之后&＃xff0c;真正发起网络请求前被调用&＃xff0c;所有的 interceptor 被保存在 List interceptors 集合中&＃xff0c;按照添加顺序来逐个调用&＃xff0c;具体可参考 RealCall#getResponseWithInterceptorChain() 方法。通过 OkHttpClient.Builder#addNetworkInterceptor(Interceptor) 传入&＃xff1b;

这里举一个简单的例子&＃xff0c;例如有这样一个需求&＃xff0c;我要监控App通过 OkHttp 发出的所有原始请求&＃xff0c;以及整个请求所耗费的时间&＃xff0c;针对这样的需求就可以使用第一类全局的 interceptor 在拦截器链头去做。

OkHttpClient okHttpClient &＃61; new OkHttpClient.Builder().addInterceptor(new LoggingInterceptor()).build();
Request request &＃61; new Request.Builder().url("http://www.publicobject.com/helloworld.txt").header("User-Agent", "OkHttp Example").build();
okHttpClient.newCall(request).enqueue(new Callback() {&＃64;Overridepublic void onFailure(Call call, IOException e) {Log.d(TAG, "onFailure: " &＃43; e.getMessage());}&＃64;Overridepublic void onResponse(Call call, Response response) throws IOException {ResponseBody body &＃61; response.body();if (body !&＃61; null) {Log.d(TAG, "onResponse: " &＃43; response.body().string());body.close();}}
});


public class LoggingInterceptor implements Interceptor {private static final String TAG &＃61; "LoggingInterceptor";&＃64;Overridepublic Response intercept(Chain chain) throws IOException {Request request &＃61; chain.request();long startTime &＃61; System.nanoTime();Log.d(TAG, String.format("Sending request %s on %s%n%s",request.url(), chain.connection(), request.headers()));Response response &＃61; chain.proceed(request);long endTime &＃61; System.nanoTime();Log.d(TAG, String.format("Received response for %s in %.1fms%n%s",response.request().url(), (endTime - startTime) / 1e6d, response.headers()));return response;}
}


针对这个请求&＃xff0c;打印出来的结果

Sending request http://www.publicobject.com/helloworld.txt on null
User-Agent: OkHttp ExampleReceived response for https://publicobject.com/helloworld.txt in 1265.9ms
Server: nginx/1.10.0 (Ubuntu)
Date: Wed, 28 Mar 2018 08:19:48 GMT
Content-Type: text/plain
Content-Length: 1759
Last-Modified: Tue, 27 May 2014 02:35:47 GMT
Connection: keep-alive
ETag: "5383fa03-6df"
Accept-Ranges: bytes


注意到一点是这个请求做了重定向&＃xff0c;原始的 request url 是 http://www.publicobject.com/helloworld.tx&＃xff0c;而响应的 request url 是 https://publicobject.com/helloworld.txt&＃xff0c;这说明一定发生了重定向&＃xff0c;但是做了几次重定向其实我们这里是不知道的&＃xff0c;要知道这些的话&＃xff0c;可以使用 addNetworkInterceptor()去做。更多的关于 interceptor的使用以及它们各自的优缺点&＃xff0c;请移步OkHttp官方说明文档。

完整interceptor-chain

IV. 自定义dns服务

Okhttp默认情况下使用的是系统

V.其他

1. 推荐让 OkHttpClient 保持单例&＃xff0c;用同一个 OkHttpClient 实例来执行你的所有请求&＃xff0c;因为每一个 OkHttpClient 实例都拥有自己的连接池和线程池&＃xff0c;重用这些资源可以减少延时和节省资源&＃xff0c;如果为每个请求创建一个 OkHttpClient 实例&＃xff0c;显然就是一种资源的浪费。当然&＃xff0c;也可以使用如下的方式来创建一个新的 OkHttpClient 实例&＃xff0c;它们共享连接池、线程池和配置信息。

OkHttpClient eagerClient &＃61; client.newBuilder().readTimeout(500, TimeUnit.MILLISECONDS).build();Response response &＃61; eagerClient.newCall(request).execute();


1. 每一个Call&＃xff08;其实现是RealCall&＃xff09;只能执行一次&＃xff0c;否则会报异常&＃xff0c;具体参见 RealCall#execute()

作者&＃xff1a;Jdqm
链接&＃xff1a;https://www.jianshu.com/p/da4a806e599b
來源&＃xff1a;简书
简书著作权归作者所有&＃xff0c;任何形式的转载都请联系作者获得授权并注明出处。