OkHttp库简介

布满荆棘的人生 2022-05-24 23:16 184阅读 0赞

一直以来，Java并没有什么比较好用的HTTP库，JDK自带的HTTP类又非常旧，难以使用。今天我发现了一个使用比较广泛的[OkHttp][]库，它在安卓和Java领域都有使用，在Github上的星数有两万多，所以我们可以放心的使用。

## 安装 ##

先来看看如何安装OkHttp。最简单的方法就是直接下载jar包，然后放到项目类路径中。官网上就有[下载链接][Link 1]，直接下载即可使用。当然这里要说的是如何使用Maven和Gradle来下载它，目前最新的OkHttp版本是3.10。使用Maven的话，复制下面的到`pom.xml`中。

<dependency>
      <groupId>com.squareup.okhttp3</groupId>
      <artifactId>okhttp</artifactId>
      <version>3.10.0</version>
    </dependency>

使用Gradle的话，复制下面的代码。

compile 'com.squareup.okhttp3:okhttp:3.10.0'

## 使用 ##

### 获取网页内容 ###

首先需要构造一个OkHttpClient对象，然后在构造一个Request对象，然后获取Response对象就可以了。Response对象中包含网页的各种信息，用Response.body方法即可获取网页内容。下面是获取百度首页代码的例子。

public static void getWebContent() throws IOException {
            OkHttpClient client = new OkHttpClient();
            String baidu_url = "https://www.baidu.com";
            Request request = new Request.Builder()
                    .url(baidu_url)
                    .build();
            try (Response response = client.newCall(request).execute()) {
                Headers headers = response.headers();
                String body = response.body().string();
                System.out.println("--------headers--------\n" + headers);
                System.out.println("--------body--------\n" + body);
    
            }

代码执行结果如下。

--------headers--------
    Cache-Control: private, no-cache, no-store, proxy-revalidate, no-transform
    Connection: Keep-Alive
    Content-Type: text/html
    Date: Thu, 03 May 2018 16:34:29 GMT
    Last-Modified: Mon, 23 Jan 2017 13:23:50 GMT
    Pragma: no-cache
    Server: bfe/1.0.8.18
    Set-Cookie: BDORZ=27315; max-age=86400; domain=.baidu.com; path=/
    Transfer-Encoding: chunked
    
    --------body--------
    <!DOCTYPE html>
    <html> <head><meta http-equiv=content-type content=text/html;charset=utf-8><meta http-equiv=X-UA-Compatible content=IE=Edge><meta content=always name=referrer><link rel=stylesheet type=text/css href=https://ss1.bdstatic.com/5eN1bjq8AAUYm2zgoY3K/r/www/cache/bdorz/baidu.min.css><title>百度一下，你就知道</title></head> <body link=#0000cc> <div id=wrapper> <div id=head> <div class=head_wrapper> <div class=s_form> <div class=s_form_wrapper> <div id=lg> <img hidefocus=true src=//www.baidu.com/img/bd_logo1.png width=270 height=129> </div> <form id=form name=f action=//www.baidu.com/s class=fm> <input type=hidden name=bdorz_come value=1> <input type=hidden name=ie value=utf-8> <input type=hidden name=f value=8> <input type=hidden name=rsv_bp value=1> <input type=hidden name=rsv_idx value=1> <input type=hidden name=tn value=baidu><span class="bg s_ipt_wr"><input id=kw name=wd class=s_ipt value maxlength=255 autocomplete=off autofocus=autofocus></span><span class="bg s_btn_wr"><input type=submit id=su value=百度一下 class="bg s_btn" autofocus></span> </form> </div> </div> <div id=u1> <a href=http://news.baidu.com name=tj_trnews class=mnav>新闻</a> <a href=https://www.hao123.com name=tj_trhao123 class=mnav>hao123</a> <a href=http://map.baidu.com name=tj_trmap class=mnav>地图</a> <a href=http://v.baidu.com name=tj_trvideo class=mnav>视频</a> <a href=http://tieba.baidu.com name=tj_trtieba class=mnav>贴吧</a> <noscript> <a href=http://www.baidu.com/bdorz/login.gif?login&tpl=mn&u=http%3A%2F%2Fwww.baidu.com%2f%3fbdorz_come%3d1 name=tj_login class=lb>登录</a> </noscript> <script>document.write('<a href="http://www.baidu.com/bdorz/login.gif?login&tpl=mn&u='+ encodeURIComponent(window.location.href+ (window.location.search === "" ? "?" : "&")+ "bdorz_come=1")+ '" name="tj_login" class="lb">登录</a>'); </script> <a href=//www.baidu.com/more/ name=tj_briicon class=bri style="display: block;">更多产品</a> </div> </div> </div> <div id=ftCon> <div id=ftConw> <p id=lh> <a href=http://home.baidu.com>关于百度</a> <a href=http://ir.baidu.com>About Baidu</a> </p> <p id=cp>©2017 Baidu <a href=http://www.baidu.com/duty/>使用百度前必读</a>  <a href=http://jianyi.baidu.com/ class=cp-feedback>意见反馈</a> 京ICP证030173号  <img src=//www.baidu.com/img/gs.gif> </p> </div> </div> </div> </body> </html>

### GET方式发送信息 ###

我找了找，OkHttp库好像没有GET发送信息的方式，我想了想GET发送信息就是直接把信息作为路径参数发送，所以完全可以自己构造。这大概就是OkHttp不提供该方法的原因吧。

### POST方式发送信息 ###

这里直接引用了官方的代码实例，可以参考[原网页][Link 2]。简单说，就是先构造一个RequestBody对象，然后将其传递给Request对象的post方法。这里这个例子发送的是JSON数据，如果我们改一下MediaType就可以发送其他类型的数据了。

public class PostExample { 
      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();
        try (Response response = client.newCall(request).execute()) {
          return response.body().string();
        }
      }
    
      String bowlingJson(String player1, String player2) {
        return "{'winCondition':'HIGH_SCORE',"
            + "'name':'Bowling',"
            + "'round':4,"
            + "'lastSaved':1367702411696,"
            + "'dateStarted':1367702378785,"
            + "'players':["
            + "{'name':'" + player1 + "','history':[10,8,6,7,8],'color':-13388315,'total':39},"
            + "{'name':'" + player2 + "','history':[6,10,5,10,10],'color':-48060,'total':41}"
            + "]}";
      }
    
      public static void main(String[] args) throws IOException {
        PostExample example = new PostExample();
        String json = example.bowlingJson("Jesse", "Jake");
        String response = example.post("http://www.roundsapp.com/post", json);
        System.out.println(response);
      }
    }

### POST发送表单 ###

作为一个常见需求，我写了一个例子作为参考。OkHttp库也对此作了特别处理，我们可以利用FormBody.Builder非常方便的构造表单专用的RequestBody。当然，用上面的方法也可以，注意一下表单的媒体类型是`application/x-www-form-urlencoded`即可。

static void postForm() throws IOException {
            OkHttpClient client = new OkHttpClient();
            String url = "http://httpbin.org/post";
            RequestBody requestBody = new FormBody.Builder().add("name", "yitian")
                    .add("age", "25")
                    .build();
    
            // 等价方法
    // requestBody = RequestBody.create(MediaType.parse("application/x-www-form-urlencoded;charset=utf8"),
    // "name=yitian&age=25");
            Request request = new Request.Builder()
                    .url(url)
                    .post(requestBody)
                    .build();
            String body = client.newCall(request).execute().body().string();
            System.out.println("---------post form---------");
            System.out.println(body);
        }

### 异步获取信息 ###

有时候需要请求的数据比较大，使用前面的同步方式会造成卡顿，这时候就需要异步方式了。异步方式其实也很简单，只需要改为使用OkHttpClient的enquene方法，该方法接受一个Callback对象，作为异步操作的回调。Callback接口有两个方法，一个是成功之后的操作，一个是失败之后的操作。下面是异步获取网页内容的例子，大家一看就会明白。

static void getWebContentAsync() throws IOException {
            OkHttpClient client = new OkHttpClient();
            String baidu_url = "https://www.baidu.com";
            Request request = new Request.Builder()
                    .url(baidu_url)
                    .build();
            client.newCall(request).enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    e.printStackTrace();
                }
    
                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    Headers headers = response.headers();
                    String body = response.body().string();
                    System.out.println("--------headers--------\n" + headers);
                    System.out.println("--------body--------\n" + body);
                }
            });
        }

### 异步下载文件 ###

另外一个常见需求就是下载文件，用OkHttp也可以非常方便的做到。当然由于网络上下载文件一般用时比较长，所以这个过程一般情况下都要做成异步的。下面的例子是从百度图片库中下载一张图片，保存图片使用了Java 8中NIO的方法，相对于以前使用嵌套的文件流相比优雅了许多。下载文件这个过程用时可能比较慢，所以这个例子需要稍微多一些时间。一开始我尝试下载外网上的图片，结果好几分钟才下载完，然后我一看文件还出错了。所以最后还是改成百度上的图片。

static void downloadImage() {
            String img_url = "http://imgsrc.baidu.com/forum/pic/item/887018fa828ba61e7e0990be4a34970a314e5905.jpg";
    
            Request request = new Request.Builder().url(img_url).build();
            OkHttpClient client = new OkHttpClient();
            client.newCall(request).enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    e.printStackTrace();
                }
    
                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    try (InputStream input = response.body().byteStream()) {
                        File image = new File("src/main/resources/img.jpg");
                        Files.copy(input, image.toPath(), StandardCopyOption.REPLACE_EXISTING);
                    }
                }
            });
        }

### 上传文件 ###

和下载文件相对应的就是上传文件。在资源文件夹`src/main/resources`中新建一个文本文件（因为上传图片什么的太大了），取名`hello.txt`，内容随便写点什么。然后用下面的代码就可以上传文件了。需要特别提一点，我这个例子是**将文件作为表单内容以表单形式提交的**。网上很多例子是直接将文件内容作为数据提交的，这两种方法直接有一些差别，一会儿会提到。

static void uploadFile() throws IOException {
            String url = "http://httpbin.org/post";
            File file = new File("src/main/resources/hello.txt");
            OkHttpClient client = new OkHttpClient();
    
            RequestBody requestBody = RequestBody.create(MediaType.parse("text/plain"), file);
            MultipartBody multipartBody = new MultipartBody.Builder()
                    .setType(MultipartBody.FORM)
                    .addFormDataPart("file", file.getName(), requestBody)
                    .build();
            Request request = new Request.Builder()
                    .url(url)
                    .post(multipartBody)
                    .build();
    
            client.newCall(request).enqueue(new Callback() {
                @Override
                public void onFailure(Call call, IOException e) {
                    e.printStackTrace();
                }
    
                @Override
                public void onResponse(Call call, Response response) throws IOException {
                    String body = response.body().string();
                    System.out.println(body);
                }
            });
        }

上面的代码执行结果如下。可以看到，文件内容处于files部分，这是用表单形式提交文件的标志。

-------上传文件--------
    {
      "args": {}, 
      "data": "", 
      "files": {
        "file": "hello world."
      }, 
      "form": {}, 
      "headers": {
        "Accept-Encoding": "gzip", 
        "Connection": "close", 
        "Content-Length": "211", 
        "Content-Type": "multipart/form-data; boundary=92eedd36-cbcc-487b-8b62-c8161356fb2e", 
        "Host": "httpbin.org", 
        "User-Agent": "okhttp/3.10.0"
      }, 
      "json": null, 
      "origin": "110.18.236.170", 
      "url": "http://httpbin.org/post"
    }

前面提到的另外一种将文件内容作为数据提交的代码形式如下，这种形式没有使用MultipartBody。

RequestBody requestBody = RequestBody.create(MediaType.parse("text/plain"), file);
            Request request = new Request.Builder()
                    .url(url)
                    .post(requestBody)
                    .build();

代码运行结果如下，可以看到文件内容跑到了data部分，files部分什么都没有。

-------上传文件--------
    {
      "args": {}, 
      "data": "hello world.", 
      "files": {}, 
      "form": {}, 
      "headers": {
        "Accept-Encoding": "gzip", 
        "Connection": "close", 
        "Content-Length": "12", 
        "Content-Type": "text/plain", 
        "Host": "httpbin.org", 
        "User-Agent": "okhttp/3.10.0"
      }, 
      "json": null, 
      "origin": "110.18.236.170", 
      "url": "http://httpbin.org/post"
    }

最后再提一点，上传文件无外乎就是这两种形式，没有其他的办法了。当然如果你硬要将某些API组合起来的话也可以运行，但是运行结果基本上就是这两种之一。我一开始就是用错了一个方法，导致一直是第二种结果，最后才发现我代码写错了，修改之后变成了第一种表单形式的上传。

以上就是OkHttp的一些简单用法，希望对大家有所帮助。OkHttp库的缺点就是没有官方文档，大概作者觉得这个库使用起来很简单，干脆就不写文档了。不过虽然没有文档，但是官方上给出了[大量例子][Link 3]，这些例子都很简单，大家应该看一眼就能明白。我的代码在[Github][]上，有兴趣的同学可以看看。

[OkHttp]: https://github.com/square/okhttp
[Link 1]: http://square.github.io/okhttp/
[Link 2]: https://github.com/square/okhttp/blob/master/samples/guide/src/main/java/okhttp3/guide/PostExample.java
[Link 3]: https://github.com/square/okhttp/tree/master/samples
[Github]: https://github.com/techstay/java-learn/tree/master/okhttp-sample