okhttp的间接和总结

最新推荐文章于 2021-01-20 18:04:18 发布

lianchaolc

最新推荐文章于 2021-01-20 18:04:18 发布

阅读量276

点赞数

OkHttp

Android系统提供了两种HTTP通信类，HttpURLConnection和HttpClient。

OkHttp是一个相对成熟的解决方案，据说Android4.4的源码中可以看到HttpURLConnection已经替换成OkHttp实现了。所以我们更有理由相信OkHttp的强大

OkHttp处理了很多网络疑难杂症：会从很多常用的连接问题中自动恢复。如果您的服务器配置了多个IP地址，当第一个IP连接失败的时候，OkHttp会自动尝试下一个IP。OkHttp还处理了代理服务器问题和SSL握手失败问题。

使用 OkHttp 无需重写您程序中的网络代码。OkHttp实现了几乎和Java.net.HttpURLConnection一样的API。如果你用了 Apache HttpClient，则OkHttp也提供了一个对应的okhttp-apache 模块

使用 OkHttp 无需重写您程序中的网络代码。OkHttp实现了几乎和Java.net.HttpURLConnection一样的API。如果你用了 Apache HttpClient，则OkHttp也提供了一个对应的okhttp-apache模块。、

OkHttpClient client = new OkHttpClient();

String run(String url) throws IOException {

Request request = new Request.Builder().url(url).build();

Response response = client.newCall(request).execute(); if (response.isSuccessful()) { return response.body().string();

} else { throw new IOException("Unexpected code " + response);

}

Request是OkHttp中访问的请求，Builder是辅助类。Response即OkHttp中的响应。

Response类：

public boolean isSuccessful()

Returns true if the code is in [200..300),

which means the request was successfully received, understood, and accepted.

response.body()返回ResponseBody类

可以方便的获取string

public final String string() throws IOException

Returns the response as a string decoded with the charset of the Content-Type header. If that header is either absent or lacks a charset,

this will attempt to decode the response body as UTF-8.Throws:

IOException

当然也能获取到流的形式：

1	public final InputStream byteStream()

HTTP POST

POST提交Json数据

public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");

OkHttpClient client = new OkHttpClient();

String post(String url, String json) throws IOException {

RequestBody body = RequestBody.create(JSON, json);

Request request = new Request.Builder()

.url(url)

.post(body)

.build();

Response response = client.newCall(request).execute();

f (response.isSuccessful()) {

return response.body().string();

} else {

throw new IOException("Unexpected code " + response);

}

使用Request的post方法来提交请求体RequestBody

POST提交键值对

很多时候我们会需要通过POST方式把键值对数据传送到服务器。 OkHttp提供了很方便的方式来做这件事情。

import java.io.IOException;

import java.util.List;

import java.util.concurrent.TimeUnit;

import org.apache.http.client.utils.URLEncodedUtils;

import org.apache.http.message.BasicNameValuePair;

import cn.wiz.sdk.constant.WizConstant;

import com.squareup.okhttp.Callback;

import com.squareup.okhttp.OkHttpClient;

import com.squareup.okhttp.Request;

import com.squareup.okhttp.Response;

public class OkHttpUtil {

private static final OkHttpClient mOkHttpClient = new OkHttpClient();

static{

mOkHttpClient.setConnectTimeout(30, TimeUnit.SECONDS);

}

/**

* 该不会开启异步线程。

* @param request

* @return

* @throws IOException

*/

public static Response execute(Request request) throws IOException{

return mOkHttpClient.newCall(request).execute();

}

/**

* 开启异步线程访问网络

* @param request

* @param responseCallback

*/

public static void enqueue(Request request, Callback responseCallback){

mOkHttpClient.newCall(request).enqueue(responseCallback);

}

/**

* 开启异步线程访问网络, 且不在意返回结果（实现空callback）

* @param request

*/

public static void enqueue(Request request){

mOkHttpClient.newCall(request).enqueue(new Callback() {

@Override

public void onResponse(Response arg0) throws IOException {

}

@Override

public void onFailure(Request arg0, IOException arg1) {

}

});

}

public static String getStringFromServer(String url) throws IOException{

Request request = new Request.Builder().url(url).build();

Response response = execute(request);

if (response.isSuccessful()) {

String responseUrl = response.body().string();

return responseUrl;

} else {

throw new IOException("Unexpected code " + response);

}

private static final String CHARSET_NAME = "UTF-8";

/**

* 这里使用了HttpClinet的API。只是为了方便

* @param params

* @return

*/

public static String formatParams(List<BasicNameValuePair> params){

return URLEncodedUtils.format(params, CHARSET_NAME);

}

/**

* 为HttpGet 的 url 方便的添加多个name value 参数。

* @param url

* @param params

* @return

*/

public static String attachHttpGetParams(String url, List<BasicNameValuePair> params){

return url + "?" + formatParams(params);

}

/**

* 为HttpGet 的 url 方便的添加1个name value 参数。

* @param url

* @param name

* @param value

* @return

*/

public static String attachHttpGetParam(String url, String name, String value){

return url + "?" + name + "=" + value;

}

高级

高级属性其实用的不多，这里主要是对OkHttp github官方教程进行了翻译。

同步get

下载一个文件，打印他的响应头，以string形式打印响应体。
响应体的 string() 方法对于小文档来说十分方便、高效。但是如果响应体太大（超过1MB），应避免适应 string()方法，因为他会将把整个文档加载到内存中。
对于超过1MB的响应body，应使用流的方式来处理body。

private final OkHttpClient client = new OkHttpClient();

public void run() throws Exception {

Request request = new Request.Builder()

.url("http://publicobject.com/helloworld.txt")

.build();

Response response = client.newCall(request).execute();

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());

}

异步get

在一个工作线程中下载文件，当响应可读时回调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());

}

});

}

提取响应头

典型的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"));

}

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());

}

Post方式提交流

以流的方式POST提交请求体。请求体的内容由流写入产生。这个例子是流直接写入Okio的BufferedSink。你的程序可能会使用OutputStream，你可以使用BufferedSink.outputStream()来获取。

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());

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;

}

OkHttpClient client = new OkHttpClient();

String post(String url, String json) throws IOException {

RequestBody formBody = new FormEncodingBuilder()

.add("platform", "android")

.add("name", "bug")

.add("subject", "XXXXXXXXXXXXXXX")

.build();

Request request = new Request.Builder()

.url(url)

.post(body)

.build();

Response response = client.newCall(request).execute();

if (response.isSuccessful()) {

return response.body().string();

} else {

throw new IOException("Unexpected code " + response);

}

以上信息来自：HttpResponseCache - Android SDK |Android Developers

取消一个Call

使用Call.cancel()可以立即停止掉一个正在执行的call。如果一个线程正在写请求或者读响应，将会引发IOException。当call没有必要的时候，使用这个api可以节约网络资源。例如当用户离开一个应用时。不管同步还是异步的call都可以取消。
你可以通过tags来同时取消多个请求。当你构建一请求时，使用RequestBuilder.tag(tag)来分配一个标签。之后你就可以用OkHttpClient.cancel(tag)来取消所有带有这个tag的call。

以上信息来自：HttpResponseCache - Android SDK |Android Developers

取消一个Call

private final OkHttpClient client;

public ConfigureTimeouts() throws Exception {

client = new OkHttpClient();

client.setConnectTimeout(10, TimeUnit.SECONDS);

client.setWriteTimeout(10, TimeUnit.SECONDS);

client.setReadTimeout(30, TimeUnit.SECONDS);

}

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);

}

理验证

这部分和HTTP AUTH有关。
相关资料：HTTP AUTH 那些事 - 王绍全的博客 - 博客频道 - CSDN.NET

OkHttp会自动重试未验证的请求。当响应是401 Not Authorized时，Authenticator会被要求提供证书。Authenticator的实现中需要建立一个新的包含证书的请求。如果没有证书可用，返回null来跳过尝试。

public List<Challenge> challenges()

Returns the authorization challenges appropriate for this response's code.

If the response code is 401 unauthorized,

this returns the "WWW-Authenticate" challenges.

If the response code is 407 proxy unauthorized, this returns the "Proxy-Authenticate" challenges.

Otherwise this returns an empty list of challenges.

HttpClient相关API，对于这个行为不做评价。为了更好的在应对网络访问，学习下okhttp还是蛮必要的，本篇博客首先介绍okhttp的简单使用，主要包含：

· 一般的get请求

· 一般的post请求

· 基于Http的文件上传

· 文件下载

· 加载图片

(二) Http Post 携带参数

看来上面的简单的get请求，基本上整个的用法也就掌握了，比如post携带参数，也仅仅是Request的构造的不同。

1. Request request = buildMultipartFormRequest(

2. url, new File[]{file}, new String[]{fileKey}, null);

3. FormEncodingBuilder builder = new FormEncodingBuilder();

4. builder.add("username","张鸿洋");

6. Request request = new Request.Builder()

7. .url(url)

8. .post(builder.build())

9. .build();

10. mOkHttpClient.newCall(request).enqueue(new Callback(){});

大家都清楚，post的时候，参数是包含在请求体中的；所以我们通过FormEncodingBuilder。添加多个String键值对，然后去构造RequestBody，最后完成我们Request的构造。

后面的就和上面一样了。

（三）基于Http的文件上传

接下来我们在介绍一个可以构造RequestBody的Builder，叫做MultipartBuilder。当我们需要做类似于表单上传的时候，就可以使用它来构造我们的requestBody。

1. File file = new File(Environment.getExternalStorageDirectory(), "balabala.mp4");

3. RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);

5. RequestBody requestBody = new MultipartBuilder()

6. .type(MultipartBuilder.FORM)

7. .addPart(Headers.of(

8. "Content-Disposition",

9. "form-data; name=\"username\""),

10. RequestBody.create(null, "张鸿洋"))

11. .addPart(Headers.of(

12. "Content-Disposition",

13. "form-data; name=\"mFile\";

14. filename=\"wjd.mp4\""), fileBody)

15. .build();

16.

17. Request request = new Request.Builder()

18. .url("http://192.168.1.103:8080/okHttpServer/fileUpload")

19. .post(requestBody)

20. .build();

21.

22. Call call = mOkHttpClient.newCall(request);

23. call.enqueue(new Callback()

24. {

25. //...

26. });

lianchaolc

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
复制链接

分享到 QQ

分享到新浪微博

扫一扫

okhttp的间接 和 总结

HTTP POST

POST提交Json数据

POST提交键值对

高级

同步get

异步get

提取响应头

Post方式提交String

Post方式提交流

取消一个Call

取消一个Call

理验证

okhttp的间接和总结