27
2017
09

Day6 快速学习OkHttp3的九大用法

效果图:

点此进入目录:[干货] 十天 教你从创意到上线APP

一、OkHttp3的基本用法

OkHttp3是Java和Android都能用,Android还有一个著名网络库叫Volley,那个只有Android能用。

导入OkHttp3

在gradle中添加依赖:

    compile 'com.squareup.okhttp3:okhttp:3.4.2'
    compile 'com.squareup.okhttp3:okio-1.8.0.jar'

1、发送Get请求

String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();
Request request = new Request.Builder()
    .url(url)
    .build();
Call call = okHttpClient.newCall(request);
try {
    Response response = call.execute();
    System.out.println(response.body().string());
} catch (IOException e) {
    e.printStackTrace();
}

如果你需要在request的的header添加参数。例如Cookie,User-Agent什么的,这样:

Request request = new Request.Builder()
    .url(url)
    .header("键", "值")
    .header("键", "值")
    ...
    .build();

response的body有很多种输出方法,string()只是其中之一,注意是string()不是toString()。如果是下载文件就是response.body().bytes()。另外可以根据response.code()获取返回的状态码。

2、发送Post请求

String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();

RequestBody body = new FormBody.Builder()
    .add("键", "值")
    .add("键", "值")
    ...
    .build();

Request request = new Request.Builder()
    .url(url)
    .post(body)
    .build();

Call call = okHttpClient.newCall(request);
try {
    Response response = call.execute();
    System.out.println(response.body().string());
} catch (IOException e) {
    e.printStackTrace();
}

post请求创建request和get是一样的,只是post请求需要提交一个表单,就是RequestBody。表单的格式有好多种,普通的表单是:

RequestBody body = new FormBody.Builder()
    .add("键", "值")
    .add("键", "值")
    ...
    .build();

RequestBody的数据格式都要指定Content-Type,常见的有三种:
- application/x-www-form-urlencoded 数据是个普通表单
- multipart/form-data 数据里有文件
- application/json 数据是个json

但是以上的普通表单并没有指定Content-Type,这是因为FormBody继承了RequestBody,它已经指定了数据类型为application/x-www-form-urlencoded。

private static final MediaType CONTENT_TYPE = MediaType.parse("application/x-www-form-urlencoded");
再看看数据为其它类型的RequestBody的创建方式:
  • 如果表单是个json:
MediaType JSON = MediaType.parse("application/json; charset=utf-8");
RequestBody body = RequestBody.create(JSON, "你的json");
  • 如果数据包含文件:
RequestBody requestBody = new MultipartBody.Builder()
    .setType(MultipartBody.FORM)
    .addFormDataPart("file", file.getName(), RequestBody.create(MediaType.parse("image/png"), file))
    .build();

上面的MultipartBody也是继承了RequestBody,看下源码可知它适用于这五种Content-Type:

public static final MediaType MIXED = MediaType.parse("multipart/mixed");
public static final MediaType ALTERNATIVE = MediaType.parse("multipart/alternative");
public static final MediaType DIGEST = MediaType.parse("multipart/digest");
public static final MediaType PARALLEL = MediaType.parse("multipart/parallel");
public static final MediaType FORM = MediaType.parse("multipart/form-data");

如果你上传一个文件不是一张图片,但是MediaType.parse(“image/png”)里的”image/png”不知道该填什么,可以参考:这里

3、同步与异步请求

从上文已经能知道call.execute()就是在执行http请求了,但是这是个同步操作,是在主线程运行的,如果你在android的UI线程直接执行这句话就出异常了。

OkHttp3帮我们实现了异步:
String url = "https://www.baidu.com/";
OkHttpClient okHttpClient = new OkHttpClient();
Request request = new Request.Builder()
        .url(url)
        .build();
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
    @Override
    public void onFailure(Call call, IOException e) {
        e.printStackTrace();
    }

    @Override
    public void onResponse(Call call, Response response) throws IOException {
        System.out.println("我是异步线程,线程Id为:" + Thread.currentThread().getId());
    }
});
for (int i = 0; i < 10; i++) {
    System.out.println("我是主线程,线程Id为:" + Thread.currentThread().getId());
    try {
        Thread.currentThread().sleep(100);
    } catch (InterruptedException e) {
        e.printStackTrace();
    }
}
执行结果是:
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是主线程,线程Id:1
我是异步线程,线程Id:11
我是主线程,线程Id:1
我是主线程,线程Id:1

以上就是发送一个get请求的步骤,首先构造一个Request对象,参数最起码有个url,当然你可以通过Request.Builder设置更多的参数比如:header、method等。然后通过request的对象去构造得到一个Call对象,类似于将你的请求封装成了任务,既然是任务,就会有execute()和cancel()等方法。最后,我们希望以异步的方式去执行请求,所以我们调用的是call.enqueue,将call加入调度队列,然后等待任务执行完成,我们在Callback中即可得到结果。

显然onFailure()和onResponse()分别是在请求失败和成功时会调用的方法。这里有个要注意的地方,onFailure()和onResponse()是在异步线程里执行的,所以如果你在Android把更新UI的操作写在这两个方法里面是会报错的,这个时候可以用runOnUiThread这个方法。

@Override
public void onResponse(final Response response) throws IOException {
      final String res = response.body().string();
      runOnUiThread(new Runnable() {
          @Override
          public void run() {
            mTv.setText(res);
          }
      });
}

4、基于Http的文件上传

接下来我们在介绍一个可以构造RequestBody的Builder,叫做MultipartBuilder。当我们需要做类似于表单上传的时候,就可以使用它来构造我们的requestBody。

File file = new File(Environment.getExternalStorageDirectory(), "balabala.mp4");

RequestBody fileBody = RequestBody.create(MediaType.parse("application/octet-stream"), file);

RequestBody requestBody = new MultipartBuilder()
     .type(MultipartBuilder.FORM)
     .addPart(Headers.of("Content-Disposition",  "form-data; name=\"username\""), RequestBody.create(null, "wgh"))
     .addPart(Headers.of("Content-Disposition",  "form-data; name=\"mFile\"; filename=\"wjd.mp4\""), fileBody)
     .build();

Request request = new Request.Builder()
    .url("http://192.168.1.103:8080/okHttpServer/fileUpload")
    .post(requestBody)
    .build();

Call call = mOkHttpClient.newCall(request);
call.enqueue(new Callback() {
    //...
});

5、自动管理Cookie

Request经常都要携带Cookie,上面说过request创建时可以通过header设置参数,Cookie也是参数之一,就像下面这样:

Request request = new Request.Builder()
    .url(url)
    .header("Cookie", "xxx")
    .build();

然后可以从返回的response里得到新的Cookie,你可能得想办法把Cookie保存起来。
但是OkHttp可以不用我们管理Cookie而是自动携带、保存和更新Cookie。

在创建OkHttpClient设置管理Cookie的CookieJar:
private final HashMap<String, List<Cookie>> cookieStore = new HashMap<>();
OkHttpClient okHttpClient = new OkHttpClient.Builder().cookieJar(new CookieJar() {
        @Override
        public void saveFromResponse(HttpUrl httpUrl, List<Cookie> list) {
            cookieStore.put(httpUrl.host(), list);
        }

        @Override
        public List<Cookie> loadForRequest(HttpUrl httpUrl) {
            List<Cookie> cookies = cookieStore.get(httpUrl.host());
            return cookies != null ? cookies : new ArrayList<Cookie>();
        }
    })
    .build();

这样以后发送Request都不用管Cookie这个参数也不用去response获取新Cookie什么的了,还能通过cookieStore获取当前保存的Cookie。

另外,new OkHttpClient()只是一种快速创建OkHttpClient的方式,更标准的是使用OkHttpClient.Builder()。后者可以设置一堆参数,例如超时时间什么的。

二、OKHttp的封装

由于按照上述的代码,写多个请求肯定包含大量的重复代码,所以我希望封装后的代码调用是这样的:

1、一般的get请求

OkHttpClientManager.getAsyn("https://github.com/hongyangAndroid", new OkHttpClientManager.StringCallback() {
            @Override
            public void onFailure(Request request, IOException e) {
                e.printStackTrace();
            }

            @Override
            public void onResponse(String bytes) {
                mTv.setText(bytes);//注意这里是UI线程回调,可以直接操作控件
            }
        });

对于一般的请求,我们希望给个url,然后CallBack里面直接操作控件。

2、文件上传且携带参数

我们希望提供一个方法,传入url、params、file、callback即可。

  OkHttpClientManager.postAsyn("http://192.168.1.111:8080/okHttpServer/fileUpload",//
    new OkHttpClientManager.StringCallback() {
        @Override
        public void onFailure(Request request, IOException e) {
            e.printStackTrace();
        }

        @Override
        public void onResponse(String result) {

        }
    }, file, "mFile",
    new OkHttpClientManager.Param[] {
            new OkHttpClientManager.Param("username", "wgh"),
            new OkHttpClientManager.Param("password", "12321")}
        );

键值对没什么说的,参数3为file,参数4为file对应的name,这个name不是文件的名字;
对应于http中的<input type="file" name="mFile" >对应的是name后面的值,即mFile。

3、文件下载

OkHttpClientManager.downloadAsyn(
    "http://192.168.1.111:8080/okHttpServer/files/messenger_01.png",    
    Environment.getExternalStorageDirectory().getAbsolutePath(), 
new OkHttpClientManager.StringCallback() {
        @Override
        public void onFailure(Request request, IOException e) {

        }

        @Override
        public void onResponse(String response) {
            // 文件下载成功,这里回调的reponse为文件的absolutePath
        }
});

4、展示图片

展示图片,我们希望提供一个url和一个imageview,如果下载成功,直接帮我们设置上即可。

OkHttpClientManager.displayImage(mImageView, "http://images.willflow.net/20170817/0.png");

内部会自动根据Imageview的大小自动对图片进行合适的压缩。虽然,这里可能不适合一次性加载大量图片的场景,但是对于App中偶尔有几个图片的加载,还是可用的。不过我们后面会详细介绍一款更为流行的图片加载框架 —— Glide,你会知道它不可思议的强大之处。

联系方式:

简书:WillFlow
CSDN:WillFlow
微信公众号:WillFlow

微信公众号:WillFlow

上一篇:Day2 当前最火爆的APP架构及其实现 下一篇:Day7 Glide的三级数据结构缓存设计