其他分享
首页 > 其他分享> > okhttp使用

okhttp使用

作者：互联网

一、OKHttp介绍

okhttp是安卓端最火热的轻量级框架,由移动支付Square公司贡献(该公司还贡献了Picasso和LeakCanary) 。用于替代HttpUrlConnection和Apache HttpClient(android API23 里已移除HttpClient)。okhttp有自己的官网，源码可以在github上下载。

二、优势

三、功能

四、使用步骤

1.添加网络权限

<uses-permission android:name="android.permission.INTERNET"/>

2.引入okhttp

implementation 'com.squareup.okhttp3:okhttp:4.10.0'

五、get请求

get请求支持两种方式，一种是同步请求，一种是异步请求。

1.同步请求

同步请求时，需要开启子线程，使用示例如下：

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.xxxxxx.com")//请求接口。如果需要传参拼接到接口后面。
                        .build();//创建Request 对象
                Response response = null;
                response = client.newCall(request).execute();//得到Response 对象
                if (response.isSuccessful()) {
                Log.d("rain","response.code()=="+response.code());
                Log.d("rain","response.message()=="+response.message());
                Log.d("rain","res=="+response.body().string());
                //此时的代码执行在子线程，修改UI的操作需使用handler跳转到UI线程。
                }
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    }).start();
}

备注：

1.response.body().string()是输入流的读操作，还是网络请求的一部分，所以这行代码必须放在子线程。

2.response.body().string()只能调用一次，在第一次时有返回值，第二次再调用时将会返回null。因为这是输入流的读操作，必须有服务器输出流的写操作时客户端的读操作才能得到数据。而服务器的写操作只执行一次，所以客户端的读操作也只能执行一次，第二次将返回null。

2.异步请求

异步请求不用开启子线程，但回调方法是执行在子线程中，所以在更新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("rain","success");
                Log.d("rain","response.code()=="+response.code());
                Log.d("rain","response.body().string()=="+response.body().string());
            }
        }
    });
}

备注：

1.enqueue方法会自动将网络请求部分放入子线程中执行，异步请求不需要开启子线程。

2.onFailure和onResponse执行在子线程。

3.response.body().string()必须放在子线程中,当执行这行代码得到结果后,再跳转到UI线程修改UI。

六、post请求

1.同步请求

同步请求时，需要开启子线程，使用示例如下：

public void postDataSync(){
    new Thread(new Runnable() {
        @Override
        public void run() {
            try {
            String url = "http://www.xxx.com/api/test";
            OkHttpClient client = new OkHttpClient();
            MediaType mediaType = MediaType.parse("application/json;charset=UTF-8");
            String post = "{\"test\":123}";
            RequestBody requestBody = RequestBody.create(mediaType, post);
            Request request = new Request.Builder()
                    .post(requestBody)
                    .url(url)
                    .build();
            Response response = client.newCall(request).execute();
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
    }).start();
}

2.异步请求

异步请求不用开启子线程，但回调方法是执行在子线程中，所以在更新UI时还要跳转到UI线程中。 使用示例如下：

    private void postDataAsync() {
        String url = "http://www.xxx.com/api/test";
        OkHttpClient client = new OkHttpClient();
        MediaType mediaType = MediaType.parse("application/json;charset=UTF-8");
        String post = "{\"test\":123}";
        RequestBody requestBody = RequestBody.create(mediaType, post);
        Request request = new Request.Builder()
                .post(requestBody)
                .url(url)
                .build();

        client.newCall(request).enqueue(new Callback() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });
    }

七、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() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });
}

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() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });

上传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() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });

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() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });

4.自定义RequestBody实现流的上传
只要是RequestBody类以及子类都可以作为post方法的参数，可以自定义一个类，继承RequestBody，实现流的上传。
使用示例如下：

//首先创建一个RequestBody类的子类对象
RequestBody body = new RequestBody() {
    @Override
    public MediaType contentType() {
        return null;
    }
  
    @Override
    public void writeTo(BufferedSink sink) throws IOException {//重写writeTo方法
        FileInputStream fio= new FileInputStream(new File("fileName"));
        byte[] buffer = new byte[1024*8];
        if(fio.read(buffer) != -1){
             sink.write(buffer);
        }
    }
};

//使用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() {
            @Override
            public void onFailure(@NonNull Call call, @NonNull IOException e) {

            }

            @Override
            public void onResponse(@NonNull Call call, @NonNull Response response) throws IOException {

            }
        });

以上代码的与众不同就是body对象，这个body对象重写了write方法，里面有个sink对象。这个是okio包中的输出流，有write方法。使用这个方法我们可以实现上传流的功能。使用RequestBody上传文件时，并没有实现断点续传的功能。可以使用这种方法结合RandomAccessFile类实现断点续传的功能。

八.设置请求头

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

标签：NonNull,Request,OkHttpClient,RequestBody,使用,okhttp,new,response
来源： https://www.cnblogs.com/allen12/p/16522264.html