2018/4/16 15:07:57当前位置推荐好文程序员浏览文章
image.png

一,OKHttp详情

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

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

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

假如想理解原码能在github上下载,地址是: square/okhttp

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

下面对以OKHttp3来详细详情OKHttp的使消耗方法。

二,get请求的使消耗方法

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

1,get的同步请求

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

public void getDatasync(){new Thread(new Runnable() {    @Override    public void run() {        try {            OkHttpClient client = new OkHttpClient();//创立OkHttpClient对象            Request request = new Request.Builder()                    .url("http://www.baidu.com")//请求接口。假如需要传参拼接到接口后面。                    .build();//创立Request 对象            Response response = null;            response = client.newCall(request).execute();//得到Response 对象            if (response.isSuccessful()) {            Log.d("kwwl","response.code()=="+response.code());            Log.d("kwwl","response.message()=="+response.message());            Log.d("kwwl","res=="+response.body().string());            //此时的代码执行在子线程,修改UI的操作请使消耗handler跳转到UI线程。            }        } catch (Exception e) {            e.printStackTrace();        }    }}).start();}

此时打印结果如下:

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线程中。
使消耗示例如下:

private void getDataAsync() {OkHttpClient client = new OkHttpClient();Request request = new Request.Builder()        .url("http://www.baidu.com")        .build();client.newCall(request).enqueue(new Callback() {    @Override    public void onFailure(Call call, IOException e) {    }    @Override    public void onResponse(Call call, Response response) throws IOException {        if(response.isSuccessful()){//回调的方法执行在子线程。            Log.d("kwwl","获取数据成功了");            Log.d("kwwl","response.code()=="+response.code());            Log.d("kwwl","response.body().string()=="+response.body().string());        }    }});}

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

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

三,post请求的使消耗方法

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

private void postDataWithParame() {OkHttpClient client = new OkHttpClient();//创立OkHttpClient对象。FormBody.Builder formBody = new FormBody.Builder();//创立表单请求体formBody.add("username","zhangsan");//传递键值对参数Request request = new Request.Builder()//创立Request 对象。        .url("http://www.baidu.com")        .post(formBody.build())//传递请求体        .build();client.newCall(request).enqueue(new Callback() {。。。});//回调方法的使消耗与get异步请求相同,此时略。}

看完代码我们会发现: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)

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

1,使消耗FormBody传递键值对参数

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

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

2,使消耗RequestBody传递Json或者File对象

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

这种方式能上传Json对象或者File对象。
上传json对象使消耗示例如下:

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

上传File对象使消耗示例如下:

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

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

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

OkHttpClient client = new OkHttpClient();MultipartBody multipartBody =new MultipartBody.Builder()    .setType(MultipartBody.FORM)    .addFormDataPart("groupId",""+groupId)//增加键值对参数    .addFormDataPart("title","title")    .addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/"), file))//增加文件    .build();final Request request = new Request.Builder()    .url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)    .post(multipartBody)    .build();client.newCall(request).enqueue(new Callback() {。。。});

4,自己设置RequestBody实现流的上传

在上面的分析中我们知道,只需是RequestBody类以及子类都能作为post方法的参数,下面我们就自己设置一个类,继承RequestBody,实现流的上传。
使消耗示例如下:
首先创立一个RequestBody类的子类对象:

RequestBody body = new RequestBody() {@Overridepublic MediaType contentType() {    return null;}@Overridepublic void writeTo(BufferedSink sink) throws IOException {//重写writeTo方法    FileInputStream fio= new FileInputStream(new File("fileName"));    byte[] buffer = new byte[10248];    if(fio.read(buffer) != -1){         sink.write(buffer);    }}};
image.png

好了 休息一下 继续看

而后使消耗body对象:

OkHttpClient client = new OkHttpClient();//创立OkHttpClient对象。Request request = new Request.Builder()    .url("http://www.baidu.com")    .post(body)    .build();client.newCall(request).enqueue(new Callback() {。。。});

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

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

五,设置请求头

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

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

其余部分代码略。

六,下载文件

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

try{InputStream  is = response.body().byteStream();//从服务器得到输入流对象long sum = 0;File dir = new File(mDestFileDir); if (!dir.exists()){    dir.mkdirs();}File file = new File(dir, mdestFileName);//根据目录和文件名得到file对象FileOutputStream  fos = new FileOutputStream(file);byte[] buf = new byte[10248];int len = 0;while ((len = is.read(buf)) != -1){    fos.write(buf, 0, len);}fos.flush();return file; }

七,对于OKHttp的使消耗封装

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

github的地址是: guozhengXia/OkHttpUtils

封装的功可以有:

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

请大家多多支持,多多提出宝贵意见,谢谢!

网友评论