OkHttp的初步使用(get、post之{RequestBody、FormBody、MultipartBody})

前言

Android网络技术

• android原生的使用http访问网络【HttpUrlConnection、HttpClient】
  官方推荐使用：HttpUrlConnection
  而对于HttpClient，6.0已经废除：HttpClient,api过多，扩展困难，难以维护
• android-async-http。与volley一样是异步网络库，但volley是封装的httpUrlConnection，它是封装的httpClient，而android平台不推荐用HttpClient了，所以这个库已经不适合android平台了。
• volley 非常适合去进行数据量不大，但通信频繁的网络操作。不适合下载问价一类（之前写的关于新闻资讯的demo 用的就是volley网络请求。请求频繁，像流星）
• 但是在开元盛行的今天，有许多出色的网络通信库都可以代替原生的HttpUrlConnection
• okthttp应该是最出色的一个，由square公司开发，在接口封装上做的简单易用，底层实现也是自成一派，现在已经成了广大android开发者首选的网络通信库。从Android4.4开始HttpURLConnection的底层实现采用的是okHttp。
• Retrofit也是square公司的， 速度快、传输层默认使用okhttp、如果程序中集成了okhttp、Retrofit默认会使用OKHttp处理其他网络层请求。Retrofit官网地址

---

这篇文章主要讲okhttp的基础使用

官网okhttp找到最新版本，gradle中引入依赖

compile 'com.squareup.okhttp3:okhttp:3.9.0'

okhttp内部依赖okio,所以在okio-github地址找到最新版本

compile 'com.squareup.okio:okio:1.13.0'

最后记得加入网络权限

---

大纲

• GET请求

• POST请求

  • RequestBody--json数据提交

  • FormBody--表单数据提交

  • MultipartBody--文件上传

---

一、Get请求

一个最简单的使用okhttp进行网络请求的例子，get获取访问网页的内容，返回的即是这个网页的html，将内容显示出来

//主要代码
    private void sendGetRuquestWithOkHttp() {
        //创建okHttpClient对象
        OkHttpClient okHttpClient=new OkHttpClient();
        //创建request,首先要有一个url
        Request request=new Request.Builder().url(netUrl).build();
        //通过request的对象去构造得到一个Call对象，
        // 类似于将你的请求封装成了任务，既然是任务，就会有execute()和cancel()等方法。
        Call call=okHttpClient.newCall(request);
        //以异步的方式去执行请求,调用的是call.enqueue，将call加入调度队列，
        // 然后等待任务执行完成，我们在Callback中即可得到结果。
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                //请求失败的处理
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
                //请求成功返回结果
                //如果希望返回的是字符串
                 final String responseData=response.body().string();
                //如果希望返回的是二进制字节数组
                byte[] responseBytes=response.body().bytes();
                //如果希望返回的是inputStream,有inputStream我们就可以通过IO的方式写文件.
                InputStream responseStream=response.body().byteStream();
                //注意，此时的线程不是ui线程，
                // 如果此时我们要用返回的数据进行ui更新，操作控件，就要使用相关方法
                runOnUiThread(new Runnable() {
                    @Override
                    public void run() {
                        // 更新UI的操作
                            textView.setText(responseData);
                    }
                });

            }
        });
        //上面用到的enqueue是异步的方式，当然也可以同步，
        //同步--Call有一个execute()方法，你也可以直接调用call.execute()通过返回一个Response。
/*    try {
    Response response = call.execute();
    if(response.isSuccessful()){
    //同步方式下得到返回结果
    String responseByExecute=response.body().string();
    }
     } catch (IOException e) {
          e.printStackTrace();
      }*/
    }

在上面的代码中：sendRuquestWithOkHttp()方法为网络请求的主要代码

• 创建okHttpClient对象
• 创建Request对象
• 把请求封装成任务，得到Call对象
• 以同步或异步的方法去执行请求，将call加入调度队列，任务执行完成，在CallBack中得到回调(异步)。同步通过call.execute().body().string();得到返回结果

关于同步和异步

• 同步调用，在发起一个函数或方法调用时，没有得到结果之前，该调用就不返回，直到返回结果；同步就是发出一个请求后什么事都不做，一直等待请求返回后才会继续做事；
• 异步调用的概念和同步相对，在一个异步调用发起后，被调用者立即返回给调用者，但调用者不能立刻得到结果，被调用者在实际处理这个调用的请求完成后，通过状态、通知或回调等方式来通知调用者请求处理的结果。异步就是发出请求后继续去做其他事，这个请求处理完成后会通知你，这时候就可以处理这个回应了

用一个例子来形容：

• 在同步环境下，客户端叫服务端去吃饭，服务端没听见或是没有回答客户端，客户端就一直叫，直到服务端说听到了，它们才一起去吃饭。
• 在异步环境下，客户端叫服务端去吃饭，客户端也不等服务端，自己就先去吃了，因为客户端也很忙，有自己的事情，不能一直等着他啥也不做，服务端知道了之后，可能马上就去吃饭，也可能忙完手头的事情才去吃饭。

二、POST请求

post和get的不同在于对Request请求的构造不同(因为post需要携带参数)，post方式中的Request需要传递一个RequestBody作为post的参数。RequestBody有两个子类：FormBody和MultipartBody

• RequestBody--json数据提交

public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
OkHttpClient client = new OkHttpClient();
String post(String url, String json) throws IOException {
     RequestBody body = RequestBody.create(JSON, json);
      Request request = new Request.Builder()
      .url(url)
      .post(body)
      .build();
//同步
      Response response = client.newCall(request).execute();
    f (response.isSuccessful()) {
        return response.body().string();
    } else {
        throw new IOException("Unexpected code " + response);
    }
}

• FromBody---表单提交 这种能满足大部分的需求

FromBody用于提交表单键值对,key-value,其作用类似于HTML中的

标记。比如username="LHX",age="21"等类似的键值对

我们可以使用HashMap这样的数据结构来存储接口所需参数的键值对，它的查找速度为O(1),很快，但是对于API接口参数来说，数据不会太多，查找快体现不出优势来，并且HashMap比较耗费内存。以下是使用hashmap的例子：

private void fetchDataByPost() {
     //把参数传进Map中
        HashMap paramsMap=new HashMap<>();
        paramsMap.put("name","哈哈");
        paramsMap.put("client","Android");
        paramsMap.put("id","3243598");
        FormBody.Builder builder = new FormBody.Builder();
        for (String key : paramsMap.keySet()) {
            //追加表单信息
            builder.add(key, paramsMap.get(key));
        }
   OkHttpClient okHttpClient=new OkHttpClient();
        RequestBody formBody=builder.build();
      Request request=new   Request.Builder().url(netUrl).post(formBody).build();
        Call call=okHttpClient.newCall(request);
       call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                //请求失败的处理
            }
            @Override
            public void onResponse(Call call, Response response) throws IOException {  
            }
        });

}

所以我们还有一种方式可以装取键值对，通过ArrayList这样的数据结构。

//首先要有一个RequestParameter类
public class RequestParameter implements Serializable {

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

    private  String name;
    private  String value;
    public RequestParameter(String name,String value){
        this.name=name;
        this.value=value;
    }
}

        List parameter=new ArrayList<>();
        RequestParameter rp1=new RequestParameter("name","哈哈");
        parameter.add(rp1);
        RequestParameter rp2=new RequestParameter("client","Android");
        parameter.add(rp2);

        //创建一个FormBody.Builder
        FormBody.Builder builder=new FormBody.Builder();
        if (parameter!=null&¶meter.size()>0){
            for (final RequestParameter p : parameter) {
                builder.add(p.getName(),p.getValue());
            }
        }
        RequestBody formBody=builder.build();
   OkHttpClient okHttpClient=new OkHttpClient();
        Request request=new   Request.Builder().url(netUrl).post(formBody).build();
        Call call=okHttpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                //请求失败的处理
            }
            @Override
            public void onResponse(Call call, Response response) throws IOException {  
            }
        });

• MultipartBody---文件上传

MultipartBody可以构建与HTML文件上传格式兼容的复杂请求体。

   File file=new File(Environment.getExternalStorageDirectory(), "balabala.png");
        MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");
        RequestBody filebody = MultipartBody.create(MEDIA_TYPE_PNG, file);
        MultipartBody.Builder multiBuilder=new MultipartBody.Builder();
        //这里是 封装上传图片参数
        multiBuilder.addFormDataPart("file", file.getName(), filebody);
        //参数以添加header方式将参数封装，否则上传参数为空
        // 设置请求体
        multiBuilder.setType(MultipartBody.FORM);
//这里是 封装上传图片参数
        multiBuilder.addFormDataPart("file", file.getName(), filebody);
        // 封装请求参数,这里最重要
        HashMap params = new HashMap<>();
        params.put("client","Android");
        params.put("uid","1061");
        params.put("token","1911173227afe098143caf4d315a436d");
        params.put("uuid","A000005566DA77");
        //参数以添加header方式将参数封装，否则上传参数为空
        if (params != null && !params.isEmpty()) {
            for (String key : params.keySet()) {
                multiBuilder.addPart(
                        Headers.of("Content-Disposition", "form-data; name=\"" + key + "\""),
                        RequestBody.create(null, params.get(key)));
            }
        }
 RequestBody multiBody=multiBuilder.build();
   OkHttpClient okHttpClient=new OkHttpClient();
        Request request=new   Request.Builder().url(netUrl).post(multiBody).build();
        Call call=okHttpClient.newCall(request);
        call.enqueue(new Callback() {
            @Override
            public void onFailure(Call call, IOException e) {
                //请求失败的处理
            }
            @Override
            public void onResponse(Call call, Response response) throws IOException {  
            }
        });

图片下载，文件下载

图片下载是通过回调的Response拿到byte[]然后decode成图片；
文件下载，就是拿到inputStream做写文件操作；