OKHttp使用详解,步骤挺详细的,适合初学者使用!

一,OKHttp介绍

okhttp是一个第三方类库,用于android中请求网络。

这是一个开源项目,是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso和LeakCanary) 。用于替代HttpUrlConnection和Apache HttpClient(android API23 里已移除HttpClient)。

okhttp有自己的官网,官网网址:OKHttp官网

如果想了解原码可以在github上下载,地址是:https://github.com/square/okhttp

在AndroidStudio中使用不需要下载jar包,直接添加依赖即可: 
compile ‘com.squareup.okhttp3:okhttp:3.4.1’

下面对以OKHttp3来详细介绍OKHttp的使用方法。

二,get请求的使用方法

使用OKHttp进行网络请求支持两种方式,一种是同步请求,一种是异步请求。下面分情况进行介绍。

1,get的同步请求

对于同步请求在请求时需要开启子线程,请求成功后需要跳转到UI线程修改UI。 
使用示例如下:

  1.  
    public void getDatasync(){
  2.  
    new Thread(new Runnable() {
  3.  
    @Override
  4.  
    public void run() {
  5.  
    try {
  6.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象
  7.  
    Request request = new Request.Builder()
  8.  
    .url("http://www.baidu.com")//请求接口。如果需要传参拼接到接口后面。
  9.  
    .build();//创建Request 对象
  10.  
    Response response = null;
  11.  
    response = client.newCall(request).execute();//得到Response 对象
  12.  
    if (response.isSuccessful()) {
  13.  
    Log.d("kwwl","response.code()=="+response.code());
  14.  
    Log.d("kwwl","response.message()=="+response.message());
  15.  
    Log.d("kwwl","res=="+response.body().string());
  16.  
    //此时的代码执行在子线程,修改UI的操作请使用handler跳转到UI线程。
  17.  
    }
  18.  
    } catch (Exception e) {
  19.  
    e.printStackTrace();
  20.  
    }
  21.  
    }
  22.  
    }).start();
  23.  
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20
  • 21
  • 22
  • 23
  • 24

此时打印结果如下: 
response.code()==200; 
response.message()==OK; 
res=={“code”:200,”message”:success};

注意事项: 
1,Response.code是http响应行中的code,如果访问成功则返回200.这个不是服务器设置的,而是http协议中自带的。res中的code才是服务器设置的。注意二者的区别。 
2,response.body().string()本质是输入流的读操作,所以它还是网络请求的一部分,所以这行代码必须放在子线程。 
3,response.body().string()只能调用一次,在第一次时有返回值,第二次再调用时将会返回null。原因是:response.body().string()的本质是输入流的读操作,必须有服务器的输出流的写操作时客户端的读操作才能得到数据。而服务器的写操作只执行一次,所以客户端的读操作也只能执行一次,第二次将返回null。

2,get的异步请求

这种方式不用再次开启子线程,但回调方法是执行在子线程中,所以在更新UI时还要跳转到UI线程中。 
使用示例如下:

  1.  
    private void getDataAsync() {
  2.  
    OkHttpClient client = new OkHttpClient();
  3.  
    Request request = new Request.Builder()
  4.  
    .url("http://www.baidu.com")
  5.  
    .build();
  6.  
    client.newCall(request).enqueue(new Callback() {
  7.  
    @Override
  8.  
    public void onFailure(Call call, IOException e) {
  9.  
    }
  10.  
    @Override
  11.  
    public void onResponse(Call call, Response response) throws IOException {
  12.  
    if(response.isSuccessful()){//回调的方法执行在子线程。
  13.  
    Log.d("kwwl","获取数据成功了");
  14.  
    Log.d("kwwl","response.code()=="+response.code());
  15.  
    Log.d("kwwl","response.body().string()=="+response.body().string());
  16.  
    }
  17.  
    }
  18.  
    });
  19.  
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19
  • 20

异步请求的打印结果与注意事项与同步请求时相同。最大的不同点就是异步请求不需要开启子线程,enqueue方法会自动将网络请求部分放入子线程中执行。

注意事项: 
1,回调接口的onFailure方法和onResponse执行在子线程。 
2,response.body().string()方法也必须放在子线程中。当执行这行代码得到结果后,再跳转到UI线程修改UI。

三,post请求的使用方法

Post请求也分同步和异步两种方式,同步与异步的区别和get方法类似,所以此时只讲解post异步请求的使用方法。 
使用示例如下:

  1.  
    private void postDataWithParame() {
  2.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
  3.  
    FormBody.Builder formBody = new FormBody.Builder();//创建表单请求体
  4.  
    formBody.add("username","zhangsan");//传递键值对参数
  5.  
    Request request = new Request.Builder()//创建Request 对象。
  6.  
    .url("http://www.baidu.com")
  7.  
    .post(formBody.build())//传递请求体
  8.  
    .build();
  9.  
    client.newCall(request).enqueue(new Callback() {。。。});//回调方法的使用与get异步请求相同,此时略。
  10.  
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

看完代码我们会发现:post请求中并没有设置请求方式为POST,回忆在get请求中也没有设置请求方式为GET,那么是怎么区分请求方式的呢?重点是Request.Builder类的post方法,在Request.Builder对象创建最初默认是get请求,所以在get请求中不需要设置请求方式,当调用post方法时把请求方式修改为POST。所以此时为POST请求。

四,POST请求传递参数的方法总结

在post请求使用方法中讲了一种传递参数的方法,就是创建表单请求体对象,然后把表单请求体对象作为post方法的参数。post请求传递参数的方法还有很多种,但都是通过post方法传递的。下面我们看一下Request.Builder类的post方法的声明:

public Builder post(RequestBody body)
  • 1

由方法的声明可以看出,post方法接收的参数是RequestBody 对象,所以只要是RequestBody 类以及子类对象都可以当作参数进行传递。FormBody就是RequestBody 的一个子类对象。

1,使用FormBody传递键值对参数

这种方式用来上传String类型的键值对 
使用示例如下:

  1.  
    private void postDataWithParame() {
  2.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
  3.  
    FormBody.Builder formBody = new FormBody.Builder();//创建表单请求体
  4.  
    formBody.add("username","zhangsan");//传递键值对参数
  5.  
    Request request = new Request.Builder()//创建Request 对象。
  6.  
    .url("http://www.baidu.com")
  7.  
    .post(formBody.build())//传递请求体
  8.  
    .build();
  9.  
    client.newCall(request).enqueue(new Callback() {。。。});//此处省略回调方法。
  10.  
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11

2,使用RequestBody传递Json或File对象

RequestBody是抽象类,故不能直接使用,但是他有静态方法create,使用这个方法可以得到RequestBody对象。

这种方式可以上传Json对象或File对象。 
上传json对象使用示例如下:

  1.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
  2.  
    MediaType JSON = MediaType.parse("application/json; charset=utf-8");//数据类型为json格式,
  3.  
    String jsonStr = "{\"username\":\"lisi\",\"nickname\":\"李四\"}";//json数据.
  4.  
    RequestBody body = RequestBody.create(JSON, josnStr);
  5.  
    Request request = new Request.Builder()
  6.  
    .url("http://www.baidu.com")
  7.  
    .post(body)
  8.  
    .build();
  9.  
    client.newCall(request).enqueue(new Callback() {。。。});//此处省略回调方法。
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

上传File对象使用示例如下:

  1.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
  2.  
    MediaType fileType = MediaType.parse("File/*");//数据类型为json格式,
  3.  
    File file = new File("path");//file对象.
  4.  
    RequestBody body = RequestBody.create(fileType , file );
  5.  
    Request request = new Request.Builder()
  6.  
    .url("http://www.baidu.com")
  7.  
    .post(body)
  8.  
    .build();
  9.  
    client.newCall(request).enqueue(new Callback() {。。。});//此处省略回调方法。
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9

3,使用MultipartBody同时传递键值对参数和File对象

这个字面意思是多重的body。我们知道FromBody传递的是字符串型的键值对,RequestBody传递的是多媒体,那么如果我们想二者都传递怎么办?此时就需要使用MultipartBody类。 
使用示例如下:

  1.  
    OkHttpClient client = new OkHttpClient();
  2.  
    MultipartBody multipartBody =new MultipartBody.Builder()
  3.  
    .setType(MultipartBody.FORM)
  4.  
    .addFormDataPart("groupId",""+groupId)//添加键值对参数
  5.  
    .addFormDataPart("title","title")
  6.  
    .addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//添加文件
  7.  
    .build();
  8.  
    final Request request = new Request.Builder()
  9.  
    .url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)
  10.  
    .post(multipartBody)
  11.  
    .build();
  12.  
    client.newCall(request).enqueue(new Callback() {。。。});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13

4,自定义RequestBody实现流的上传

在上面的分析中我们知道,只要是RequestBody类以及子类都可以作为post方法的参数,下面我们就自定义一个类,继承RequestBody,实现流的上传。 
使用示例如下: 
首先创建一个RequestBody类的子类对象:

  1.  
    RequestBody body = new RequestBody() {
  2.  
    @Override
  3.  
    public MediaType contentType() {
  4.  
    return null;
  5.  
    }
  6.  
     
  7.  
    @Override
  8.  
    public void writeTo(BufferedSink sink) throws IOException {//重写writeTo方法
  9.  
    FileInputStream fio= new FileInputStream(new File("fileName"));
  10.  
    byte[] buffer = new byte[1024*8];
  11.  
    if(fio.read(buffer) != -1){
  12.  
    sink.write(buffer);
  13.  
    }
  14.  
    }
  15.  
    };
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16

然后使用body对象:

  1.  
    OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
  2.  
    Request request = new Request.Builder()
  3.  
    .url("http://www.baidu.com")
  4.  
    .post(body)
  5.  
    .build();
  6.  
    client.newCall(request).enqueue(new Callback() {。。。});
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7

以上代码的与众不同就是body对象,这个body对象重写了write方法,里面有个sink对象。这个是OKio包中的输出流,有write方法。使用这个方法我们可以实现上传流的功能。

使用RequestBody上传文件时,并没有实现断点续传的功能。我可以使用这种方法结合RandomAccessFile类实现断点续传的功能。

五,设置请求头

OKHttp中设置请求头特别简单,在创建request对象时调用一个方法即可。 
使用示例如下:

  1.  
    Request request = new Request.Builder()
  2.  
    .url("http://www.baidu.com")
  3.  
    .header("User-Agent", "OkHttp Headers.java")
  4.  
    .addHeader("token", "myToken")
  5.  
    .build();
  • 1
  • 2
  • 3
  • 4
  • 5

其他部分代码略。

六,下载文件

在OKHttp中并没有提供下载文件的功能,但是在Response中可以获取流对象,有了流对象我们就可以自己实现文件的下载。代码如下: 
这段代码写在回调接口CallBack的onResponse方法中:

  1.  
    try{
  2.  
    InputStream is = response.body().byteStream();//从服务器得到输入流对象
  3.  
    long sum = 0;
  4.  
    File dir = new File(mDestFileDir);
  5.  
    if (!dir.exists()){
  6.  
    dir.mkdirs();
  7.  
    }
  8.  
    File file = new File(dir, mdestFileName);//根据目录和文件名得到file对象
  9.  
    FileOutputStream fos = new FileOutputStream(file);
  10.  
    byte[] buf = new byte[1024*8];
  11.  
    int len = 0;
  12.  
    while ((len = is.read(buf)) != -1){
  13.  
    fos.write(buf, 0, len);
  14.  
    }
  15.  
    fos.flush();
  16.  
    return file;
  17.  
     
  18.  
    }
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
  • 11
  • 12
  • 13
  • 14
  • 15
  • 16
  • 17
  • 18
  • 19

七,对于OKHttp的使用封装

由于okhttp是偏底层的网络请求类库,返回结果的回调方法仍然执行在子线程中,需要自己跳转到UI线程,使用麻烦。为了使用方便需要对OKHttp进行再次封装。对于OKHttp的封装首推的就是hongyang大神的OKHttpUtils。我个人在看过OKHttp的原码和借鉴各大神的封装源码后封装了一套自己的OKHttpUtils。这套OKHttpUtils最大的优点是简单和便于使用,这是我项目中实际用的网络请求工具类,完全可以说拿来即用。而且代码简单,可供学习使用。

github的地址是:https://github.com/guozhengXia/OkHttpUtils

封装的功能有: 
* 一般的get请求 
* 一般的post请求 
* 上传单个文件(包含进度) 
* 上传list集合文件 
* 上传map集合文件 
* 文件下载(包含进度) 
* 图片下载(实现了图片的压缩)

7-OKHttp使用详解,步骤挺详细的,适合初学者使用!的更多相关文章

  1. 【二次元的CSS】—— 用 DIV + CSS3 画咸蛋超人(详解步骤)

    [二次元的CSS]—— 用 DIV + CSS3 画咸蛋超人(详解步骤) 2016-05-17 HTML5cn 仅仅使用div作为身体的布局,用css3的各种transform和圆角属性来绘制各部位的 ...

  2. spring配置文件详解--真的蛮详细

    spring配置文件详解--真的蛮详细   转自: http://book.51cto.com/art/201004/193743.htm 此处详细的为我们讲解了spring2.5的实现原理,感觉非常 ...

  3. Java 序列化Serializable详解(附详细例子)

    Java 序列化Serializable详解(附详细例子) 1.什么是序列化和反序列化 Serialization(序列化)是一种将对象以一连串的字节描述的过程:反序列化deserialization ...

  4. keepalived的配置详解(非常详细)

    keepalived的配置详解(非常详细) 2017-01-22 15:24 2997人阅读 评论(0) 收藏 举报  分类: 运维学习(25)    转载自:http://blog.csdn.net ...

  5. 命令创建.net core3.0 web应用详解(超详细教程)

    原文:命令创建.net core3.0 web应用详解(超详细教程) 你是不是曾经膜拜那些敲几行代码就可以创建项目的大神,学习了命令创建项目你也可以成为大神,其实命令创建项目很简单. 1.cmd命令行 ...

  6. KafkaProducer Sender 线程详解(含详细的执行流程图)

    目录 1.Sender 线程详解 2.RecordAccumulator 核心方法详解 温馨提示:本文基于 Kafka 2.2.1 版本. 上文 <源码分析 Kafka 消息发送流程> 已 ...

  7. Maven使用详解,非常详细

    本文转:http://blog.csdn.net/u010425776/article/details/52027706 什么是Maven? 如今我们构建一个项目需要用到很多第三方的类库,如写一个使用 ...

  8. Java自动化测试框架-12 - TestNG之xml文件详解篇 (详细教程)

    1.简介 现在这篇,我们来学习TestNG.xml文件,前面我们已经知道,TestNG就是运行这个文件来执行测试用例的.通过本篇,你可以进一步了解到:这个文件是配置测试用例,测试套件.简单来说,利用这 ...

  9. yolo3各部分代码详解(超详细)

    0.摘要 最近一段时间在学习yolo3,看了很多博客,理解了一些理论知识,但是学起来还是有些吃力,之后看了源码,才有了更进一步的理解.在这里,我不在赘述网络方面的代码,网络方面的代码比较容易理解,下面 ...

随机推荐

  1. Mongodb集群节点故障恢复场景分析(转)

    一个适当配置的Mongodb分片集群是没有单点故障.本文描述了分片集群中存在的几种不同的潜在的节点故障场景,以及Mongodb对这些节点故障是怎么处理的.1.Mongos节点宕机一个Mongos进程应 ...

  2. APP安全性测试总结--网上转载

    移动APP安全测试   老鹰a0人评论7103人阅读2018-08-06 16:22:07   1        移动APP安全风险分析 1.1     安全威胁分析 安全威胁从三个不同环节进行划分, ...

  3. 知识点4: 配置echarts折线图和饼图

    折线图 效果图 html <template> <div id="v11-charts3"></div> </template> j ...

  4. sqlalchemy sql express language

    metadata = MetaData() teacher = Table("teachers", metadata, Column("tid", Intege ...

  5. 百度开放平台连接MySQL数据库

    在百度开放平台创建了MySQL数据库后只知道数据库名称,可以通过下面的方法进行连接: public function connect(){ $_server = getenv('HTTP_BAE_EN ...

  6. 用Lucene4.5对中文文本建立索引

    这里需要完成一个能对txt文本建立索引,并能完成检索查询.完成这个功能,使用的是Lucene4.5,同时使用其自带的中文分析器. 准备工作是在一个文件夹里面建一些txt文件,这是我的文件结构: 首先要 ...

  7. hdu1215-七夕节-(埃氏筛+唯一分解定理)

    七夕节 Time Limit: 2000/1000 MS (Java/Others)    Memory Limit: 65536/32768 K (Java/Others)Total Submiss ...

  8. SPSS-聚类分析

    聚类分析(层次聚类分析(Q型聚类和R型聚类).快速聚类分析) 聚类分析的实质:是建立一种分类方法,它能够将一批样本数据按照他们在性质上的亲密程度在没有先验知识的情况下自动进行分类.这里所说的类就是一个 ...

  9. 学习-HTML5

    @@ 学习HTML5发现对我们开发工作者来说要方便很多,它现在还在发展阶段,在未来肯定会是主流. 我们知道HTML5目的是取代HTML4.01和XHTML1.0标准,他希望能够减少互联网富应用(RIA ...

  10. JS----事件3

    一 事件对象(event):与特定事件相关且包含有关该事件详细信息的对象通过事件可以触发event对象的元素,鼠标的位置及状态,按下的键等等event对象只在事件发生的过程中才有效非IE浏览器里的ev ...