okhttp使用备忘录

前言

OkHttp是目前使用最广泛的移动端网络底层库。在Volley、Retrofit等知名上层网络库中,都可以看到它的身影。即使在高版本的Android系统中的URLConnection中也可以看到它的身影。�

因为,各大网络库对OkHttp进行了封装。我们虽然使用方便,却不免失去了一定的灵活性。如果OkHttp拥有的功能,上层库却没有封装,我们在使用时,就会比较麻烦。因此,我们在这里尝试直接使用OkHttp,看看未经封装的OkHttp如何使用。

Request

OkHttp将请求封装在了Request类中。我们大致看看Request的成员:

public final class Request{
    private final HttpUrl url;
    private final String method;
    private final Headers headers;
    private final RequestBody body;
    private final Object tag;
}

其中HttpUrl类代表请求地址, String method代表请求方法, Headers代表请求头, RequestBody代表请求体. Object tag是用来取消http请求的标志, 这个我们先不管.

我们在使用OkHttp时,我们可以用Request提供的Builder生成我们想要的Request。

final Request request = new Request.Builder().url("https://github.com/").build();

完成Request的创建后,我们可以调用:

final Request request = new Request.Builder().url("https://github.com/").build();
Response response = client.newCall(request).execute();

Request被调用的方式,我们可以发现,这是一个同步网络请求。请求完成后,会直接返回Response给我们。下面,我们就来看看Response的结构。

Response

public final class Response{
  private final Request request;
  private final Protocol protocol;
  private final int code;
  private final String message;
  private final HandShake handShake;
  private final Headers headers;
  private final ResponseBody body;
  private Response networkResponse;
  private Response cacheResponse;
  private final Response priorResponse;
}

可以看到Response类里面有Protocol代表请求协议, int code代表响应码, String message代表描述信息, Headers代表响应头, ResponseBody代表响应体. 当然除此之外, 还有Request代表持有的请求, Handshake代表SSL/TLS握手协议验证时的信息, 这些额外信息我们暂时不问.

介绍完RequestResponse两个重要的类,下面我们可看看,OkHttp的各种请求的调用方法。

GET请求

同步GET

同步GET的意思是一直等待http请求, 直到返回了响应. 在这之间会阻塞进程, 所以通过get不能在Android的主线程中执行, 否则会报错。

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{
  Request request = new Request.Builder()
        .url("https://github.com/")
        .build();

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

异步GET

异步GET的意思是OkHttp会帮我们另外开启后台线程发送http请求,开启后台线程后,不再阻碍当前线程的执行。当http请求完成后,会以回调的方式,将请求结果返回到当前线程。

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{
  Request request = new Request.Builder()
        .url("https://github.com/")
        .build();

  Response response = client.newCall(request).enqueue(new Callback(){

    @Override
    public void onResponse(Response response) throw IOException{

    }

    @Override
    public void onFailure(Request request , Throwable throwable){

    }
  });      
}

POST请求

在上面的GET请求的介绍中,我们已经分别介绍了同步请求和异常请求。在POST请求的介绍中,我们不再以同步和异步进行分类,只介绍同步情况,而把精力集中在,POST上传的内容形式的分类上。

POST提交String

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{

  String uploadInfo = "Need to Upload!";

  Request request = new Request.Builder()
        .url("https://github.com/")
        .post(RequestBody.create("text/x-markdown; charset=utf-8" , uploadInfo))
        .build();

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

POST提交文件

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{

  File file = new File("README.md");

  Request request = new Request.Builder()
        .url("https://github.com/")
        .post(RequestBody.create("text/x-markdown; charset=utf-8" , file))
        .build();

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

POST提交表单

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{

  RequestBody formBody = new formBody.Builder()
      .add("user" , "oldFrog")
      .build();

  Request request = new Request.Builder()
        .url("https://github.com/")
        .post(formBody)
        .build();

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

POST提交分块请求

private final OkHttpClient client = new OkHttpClient();

public void run() throw Exception{

  RequestBody requestBody = new MultipartBody.Builder()
      .setType(MultipartBody.FORM)
      .addFormDataPart("user" , "oldFrog")
      .addFormDataPart("image" , "logo.png" , RequestBody.create(MEDIA_TYPE_PNG, new File("local_logo.png")))    
      .build();

  Request request = new Request.Builder()
        .url("https://github.com/")
        .post(requestBody)
        .build();

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

POST提交Stream

private static final MediaType MEDIA_TYPE_PLAINTEXT = MediaType
    .parse("text/plain; charset=utf-8");
  private final OkHttpClient client = new OkHttpClient();
 
  @Test
  public void testPostStream() throws Exception {
 
    RequestBody requestBody = new RequestBody() {
      @Override
      public MediaType contentType() {
        return MEDIA_TYPE_PLAINTEXT;
      }
 
      @Override
      public void writeTo(BufferedSink sink) throws IOException {
 
        File file = new File("src/test/resources/Lorem Ipsum.txt");
        try (BufferedReader br = new BufferedReader(new FileReader(file))) {
          String line;
          while ((line = br.readLine()) != null) {
            sink.writeUtf8(line);
          }
        }
      }
 
    };
 
    Request request = new Request.Builder()
      .url("http://httpbin.org/post")
      .post(requestBody)
      .build();
 
    Response response = client.newCall(request).execute();
   }

至此,就介绍了okhttp的基本使用。后面会开始分析okhttp的源码,以深入其进阶使用。 如有问题,欢迎指正。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

相关文章

来自专栏区块链技术专栏

EOS 权限管理之-权限的使用 (你绝对找不到的干货)

相信看这篇教程的人,对我之前的一些账户操作已经进行了了解,如果不了解的,可以移步 https://eosfans.io/topics/372.

7883
来自专栏FreeBuf

命令行下的“蒙面歌王”rundll32.exe

*本文原创作者:lcx,本文属FreeBuf原创奖励计划,未经许可禁止转载 ** 在Windows系统中,为了节省内存和实现代码重用,微软在Windows操作系...

2279
来自专栏极客编程

EOS区块链平台智能合约示例HelloWorld

一般环境设置通过上一篇文章已经说明,这方面的问题大家可以看本博客上一篇文章,本文引用了官方EOS在Git上的示例。

832
来自专栏Android源码框架分析

Android后台杀死系列之三:LowMemoryKiller原理(4.3-6.0)

本篇是Android后台杀死系列的第三篇,前面两篇已经对后台杀死注意事项,杀死恢复机制做了分析,本篇主要讲解的是Android后台杀死原理。相对于后台杀死恢复,...

1575
来自专栏琯琯博客

awesome-php

收集整理一些常用的PHP类库, 资源以及技巧. 以便在工作中迅速的查找所需… 这个列表中的内容有来自 awesome-php 的翻译, 有来自开发者周刊以及个人...

8409
来自专栏大内老A

我的WCF之旅(9):如何在WCF中使用tcpTrace来进行Soap Trace

无论对于Web Service还是WCF,Client和Service之间交互的唯一形式是通过发送和接收Soap Message。在我们对Web Service...

2007
来自专栏令仔很忙

新手学Struts(一)----JSP+Servlet讲解MVC实现原理

最近在学SSH(Struts+ Hibernate+Spring),这也算是一个比较经典的框架了,之前都是看人家大牛说这个框架,那个框架,说的真溜,自己也是佩...

1003
来自专栏Felix的技术分享

Stetho工具介绍

2154
来自专栏王二麻子IT技术交流园地

Javascript实现简单跨域调用

什么是JSONP? 1、一个众所周知的问题,Ajax直接请求普通文件存在跨域无权限访问的问题,甭管你是静态页面、动态网页、web服务、WCF,只要是跨域请求,...

2809
来自专栏自动化测试实战

看到就是赚到!Selenium完整框架——告别2017

3689

扫码关注云+社区