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

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. @Override
  7. public void writeTo(BufferedSink sink) throws IOException {//重写writeTo方法
  8. FileInputStream fio= new FileInputStream(new File("fileName"));
  9. byte[] buffer = new byte[1024*8];
  10. if(fio.read(buffer) != -1){
  11. sink.write(buffer);
  12. }
  13. }
  14. };
  • 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. }
  • 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集合文件 
* 文件下载(包含进度) 
* 图片下载(实现了图片的压缩)

转载于:https://www.cnblogs.com/zhumengdexiaobai/p/10306186.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/364117.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

变量与递归函数

变量与递归函数一、变量 变量分为全局变量和局部变量。 python中全局变量和局部变量的最大区别在于局部变量只能通过函数去访问,而全局变量可以直接访问。 举个例子: name linxu #全局变量 def change_name():namepython #局部变量print(name) …

使用MOXy 2.5.1快速且有点脏的JSON模式生成

因此,这些天我正在为即将推出的Oracle云服务开发新的REST API,因此我需要做的一件事情就是能够为模型中的bean自动生成JSON模式。 我正在使用MOXy从POJO生成JSON,从EclipseLink 2.5.1版本开始,它现在具有从bean模型生成JSON模式的…

手机端input[type=date]的placeholder不起作用

<div class"input clearfix"><label class"fl">起始日期</label><input class"fl text_date" type"date" name"" value"" placeholder"年/月/日" /></div><div cla…

Python中的TCP编程,实现客户端与服务器的聊天(socket)

参考大神blog:自己再写一个 https://blog.csdn.net/qq_31187881/article/details/79067644转载于:https://www.cnblogs.com/studybrother/p/10306903.html

利用ASP.NET向服务器上传文件[转]

文件上传技术是一个很实用的技术&#xff0c;有着很广泛的应用&#xff0c;在ASP.NET自身的前一个版本ASP里实现这个功能&#xff0c;就必须使用第三方的组件或者自己开发组件了&#xff0c;现在&#xff0c;用ASP.NET实现起来就简单得多了&#xff0c;我们不需要使用任何组件就…

JavaSE:如何设置/获取您自己的文件和目录属性

在上一篇文章“确定特定文件系统支持的视图”中 &#xff0c;了解如何询问文件系统存储&#xff0c;并了解特定文件属性视图的可支持性。 简而言之&#xff0c;我们将探索最高级和重要的文件属性视图之一&#xff0c;即用户定义的文件属性视图 。 特别是&#xff0c;在系统之…

java中HashMap详解

HashMap 和 HashSet 是 Java Collection Framework 的两个重要成员&#xff0c;其中 HashMap 是 Map 接口的常用实现类&#xff0c;HashSet 是 Set 接口的常用实现类。虽然 HashMap 和 HashSet 实现的接口规范不同&#xff0c;但它们底层的 Hash 存储机制完全一样&#xff0c;甚…

java代码编写的文本特征提取_Test1 java语言写的特征提取源代码,有搞文字识别的可以下载一看,简单易学 Develop 274万源代码下载- www.pudn.com...

文件名称: Test1下载 收藏√ [5 4 3 2 1 ]开发工具: Java文件大小: 35 KB上传时间: 2015-03-02下载次数: 46提 供 者: 常杰详细说明&#xff1a;java语言写的特征提取源代码&#xff0c;有搞文字识别的可以下载一看&#xff0c;简单易学-Feature extraction of the Java …

Iframe父页面与子页面之间的相互调用

父页面&#xff1a; <!DOCTYPE html> <html> <head><title>parents</title><meta charset"UTF-8"> </head> <body> <div id"default">div内容</div> <iframe src"child.html" i…

c# HashTable (哈希表)

HashTable 哈希表 也是System.Collections集合下的数据结构类 它储存的也是Object类型的对象 但是它在内存中是散列排布的 因为这个特性&#xff0c;非常适合存储大量的数据 在HashTable中一个键只能对应一个值&#xff0c;一个值可以对应多个键&#xff08;多对一&#xff09;…

Winform DataGridView数据绑定问题

DataGridView 绑定的数据源如果是DataTable、DataSet &#xff0c;在绑定后添加删除DataTable中的数据&#xff0c; DataGridView控件中的数据会自动改变&#xff0c;然而绑定的对象若是List<>之类的&#xff0c;修改List<>集合中的数据后&#xff0c;DataGridView…

盒模型应用

盒模型应用 改变宽高范围 默认情况下&#xff0c;width 和 height 设置的是内容盒宽高。 页面重构师&#xff1a;将psd文件&#xff08;设计稿&#xff09;制作为静态页面 衡量设计稿尺寸的时候&#xff0c;往往使用的是边框盒&#xff0c;但设置width和height&#xff0c;则设…

Spring集成–配置Web服务客户端超时

介绍 在Spring Integration的支持下&#xff0c;您的应用程序可以使用出站Web服务网关来调用Web服务。 调用由该网关处理&#xff0c;因此您只需要担心构建请求消息和处理响应。 但是&#xff0c;使用这种方法并不明显&#xff0c;如何配置其他选项&#xff0c;例如设置超时或操…

Number()、parseInt()、parseFloat()的区别

Number()&#xff1a; Number()的强制类型转换与parseInt()和parseFloat()方法的处理方式相似&#xff0c;只是它转换的是整个值&#xff0c;而不是部分值&#xff0c;如果有无效字符&#xff0c;该方法将返回NaN。 例如如果要把字符串 "12.34 "转换成整数&#xf…

将一幅图像取平均值缩小N倍实现方法

/// <summary>/// 将图像缩小N倍/// </summary>/// <param name"source">原图数据</param>/// <param name"height">原图高度</param>/// <param name"width">原图宽度</param>/// <param n…

将txt文件和excel文件导入SQL2000数据库

在做一些web数据库管理系统的时候经常要实现将帐户批量注册的功能&#xff0c;今天就来讲讲如何在C#-web项目中将txt文件和excel文件导入SQL2000数据库。1.数据库准备在SQL2000数据库的实例数据库pubs中建立一个数据表txtInsert&#xff0c;字段很简单&#xff1a;id&#xff0…

Linux ifconfig 配置网络接口

Linux ifconfig 可以用来配置网络接口的IP地址、掩码、网关、物理地址等&#xff1b;值得一说的是用Linux ifconfig 为网卡指定IP地址&#xff0c;这只是用来调试网络用的&#xff0c;并不会更改系统关于网卡的配置文件。 如果您想把网络接口的IP地址固定下来&#xff0c;目前有…

Java 8 Friday:Java 8将彻底改变数据库访问

在Data Geekery &#xff0c;我们喜欢Java。 而且&#xff0c;由于我们真的很喜欢jOOQ的流畅的API和查询DSL &#xff0c;我们对Java 8将为我们的生态系统带来什么感到非常兴奋。 对于Java 8系列 &#xff0c;我们很荣幸主持Iu Ming-Yee Iu博士发表的非常相关的嘉宾帖子。 Iu …

WebUploader点击上传文件选择框会延迟几秒才会显示

1 accept: { 2 title: Images, 3 extensions: jpg,jpeg,png, 4 mimeTypes: image/* 5 } 改为 1 accept: { 2 title: Images, 3 extensions: jpg,jpeg,png, 4 mimeTypes: image/jpg,image/jpeg,image/png //修改这行 5 } 更多专业前端知识&#xff0c;请…

Linux文件权限管理

权限管理 1、权限解读 权限&#xff1a;用户针对文件是否有读、写、执行的权利。 权限划分&#xff1a;读&#xff08;Read&#xff09;、写&#xff08;Write&#xff09;、执行&#xff08;eXecute&#xff09; 权限针对用户的划分&#xff1a;主人&#xff08;User&#xff…