OKHttp使用详解

导入

compile ‘com.squareup.okhttp3:okhttp:3.4.1’

compile 'com.squareup.okio:okio:1.11.0'

OkHttp的GitHub地址是：OkHttp
OkIo的GitHub地址是：OkIo

OKHttp几个比较核心的类：

1. OkHttpClient：客户端对象
2. Request：访问请求，Post请求中需要包含RequestBody
3. RequestBody：请求数据，在Post请求中用到
4. Response：即网络请求的响应结果
5. MediaType：数据类型，用来表明数据是json，image，pdf等一系列格式
6. client.newCall(request).execute()：同步的请求方法 所以要开一个线程运行，更新ui和异步方法一样
7. client.newCall(request).enqueue(Callback callBack)：异步的请求方法，但Callback是执行在子线程中的，因此不能在此进行UI更新操作

 runOnUiThread(new Runnable() {
         @Override
       public void run() {}
   }

 

如果希望获得返回的是字符串，则可以使用

response.body().string()

如果需要的是字节数组，则使用

response.body().bytes()

如果需要的是输入流，则使用

response.body().byteStream()

注意事项： 
1，response.body().string()本质是输入流的读操作，所以它还是网络请求的一部分，所以这行代码必须放在子线程。 
2，response.body().string()只能调用一次，在第一次时有返回值，第二次再调用时将会返回null。原因是：response.body().string()的本质是输入流的读操作，必须有服务器的输出流的写操作时客户端的读操作才能得到数据。而服务器的写操作只执行一次，所以客户端的读操作也只能执行一次，第二次将返回null。

get请求

1，get的同步请求

对于同步请求在请求时需要开启子线程，请求成功后需要跳转到UI线程修改UI。

 new Thread(new Runnable() {
        @Override
        public void run() {
            try {
                OkHttpClient client = new 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()) {
                  //response.body().string();只能执行一次
                //此时的代码执行在子线程，修改UI的操作请使用handler跳转到UI线程。
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }).start();

2，get的异步请求

这种方式不用再次开启子线程，但回调方法是执行在子线程中，所以在更新UI时还要跳转到UI线程中。异步请求与同步请求不同点就是异步请求不需要开启子线程，enqueue方法会自动将网络请求部分放入子线程中执行。
 

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());
        }
    }
});
}

 

post请求 

POST请求传递参数

在Request.Builder对象创建最初默认是get请求，post方法接收的参数是RequestBody 对象，所以只要是RequestBody 类以及子类对象都可以当作参数进行传递。FormBody就是RequestBody 的一个子类对象

public Builder post(RequestBody body)

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

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

private void postDataWithParame() {
    OkHttpClient client = new 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对象

 

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() {。。。});

 

设置请求头

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

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

可以用上面三种方式传递headers.

如果传递中文。会报错。因为源码的checkNameAndValue(String name, String value)对中文进行处理。所以如果传递中文

需要用下面这个方法进行处理

    private static String getUserAgent(   String userAgent) {
        StringBuffer sb = new StringBuffer();
        for (int i = 0, length = userAgent.length(); i < length; i++) {
            char c = userAgent.charAt(i);
            if (c <= '\u001f' || c >= '\u007f') {
                sb.append(String.format("\\u%04x", (int) c));
            } else {
                sb.append(c);
            }
        }
        return sb.toString();
    }

下载文件

在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[1024*8];
int len = 0;
while ((len = is.read(buf)) != -1){
    fos.write(buf, 0, len);
}
fos.flush();
return file;

 }

七，对于OKHttp的使用封装

 

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

https://www.jianshu.com/p/2663ce3da0db