美文网首页
OkHttp3使用

OkHttp3使用

作者: 毕丙伟 | 来源:发表于2017-08-29 17:19 被阅读0次

    OkHttp:是一款优秀的HTTP框架,

    1. 支持get请求和post请求,
    2. 支持基于Http的文件上传和下载,
    3. 支持加载图片,
    4. 支持下载文件透明的GZIP压缩,
    5. 支持响应缓存避免重复的网络请求,
    6. 支持使用连接池来降低响应延迟问题
    下载和添加网络访问权限
    下载OkHttp.png 添加网络权限.png
    基本要求
    Request:每一个HTTP请求中都应该包含一个URL,一个GET或POST方法以及Header或其他参数,当然还可以含特定内容类型的数据流。
    Response:响应则包含一个回复代码(200代表成功,404代表未找到),Header和定制可选的body。
    
    基本使用

    在日常开发中最常使用的网络请求就是GET和POST两种方式
    Http Get请求

    //创建okHttpClient对象
    OkHttpClient mOkHttpClient = new OkHttpClient();
    //创建一个Request
    final Request request = new Request.Builder()
                    .url("https://github.com/hongyangAndroid")
                    .build();
    //new call
    Call call = mOkHttpClient.newCall(request); 
    //请求加入调度
    call.enqueue(new Callback()
            {
                @Override
                public void onFailure(Request request, IOException e)
                {
                }
    
                @Override
                public void onResponse(final Response response) throws IOException
                {
                        //String htmlStr =  response.body().string();
                }
            });         
    
    1. 以上就是发送一个get请求的步骤,首先构造一个Request对象,参数最少有一个url,当然还可以通过Request.Builder设置更多的参数比如:header、method等
    2. 然后通过request的对象去构造得到一个Call对象,类似于将你的请求封装成了任务,既然是任务,那就会有execute()和cancel()方法
    3. 最后,通过异步的方式去执行请求,所以我们调用的是call.enqueue,将call加入调度队列,然后等待任务执行完成,最后在Callback中即可得到结果。
      整体的写法就是这样,但是实际运用过程中还需要进行封装。
      注意
    4. onResponse回调的参数是response,一般情况下,比如我们希望获得返回的字符串,可以通过response.body().string()获得;如果希望获得返回的二进制字节数组,则调用response.body().bytes();如果你想拿到返回的inputStream,则调用response.body().byteStream()

    此时onResponse执行的线程并不是UI线程,所以当你希望操作控件的时候,还需要使用handle等,例如:

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

    Http Post携带参数
    post基本用法和get基本相同,比如post携带参数,也仅仅是Request的构造不同。

    Request request = buildMultipartFormRequest(
            url, new File[]{file}, new String[]{fileKey}, null);
    FormEncodingBuilder builder = new FormEncodingBuilder();   
    builder.add("username","###");
    
    Request request = new Request.Builder()
                      .url(url)
                      .post(builder.build())
                      .build();
     mOkHttpClient.newCall(request).enqueue(new Callback(){});
    

    post的时候,参数是包含在请求体中的,所以我们通过FormEncodingBuilder。添加多个string键值对,然后去构造RequestBody,最后完成Request的构造。

    封装

    上面的代码包含太多重复的代码,所以我们应该使用封装之后的代码:

    1. 一般的get请求
    OkHttpClientManager.getAsyn("https://www.baidu.com", new OkHttpClientManager.ResultCallback<String>()
            {
                @Override
                public void onError(Request request, Exception e)
                {
                    e.printStackTrace();
                }
    
                @Override
                public void onResponse(String u)
                {
                    mTv.setText(u);//注意这里是UI线程
                }
            });
    

    对于一般的请求,我们给出一个url,然后再CallBack中直接进行操作.

    1. 展示图片
      当展示图片的时候,我们只需要提供一个url和imageView,如果下载成功,直接设置就行了
    OkHttpClientManager.displayImage(mImageView, 
         "http://images.csdn.net/20150817/1.jpg");
    

    整合Gson

    当服务端返回json字符串时,希望客户端回调可以直接拿到对象,于是整合了Gson.

    1. 直接回调对象
      现在有一个User实体类:
    package com.zhy.utils.http.okhttp;
    
    public class User {
    
        public String username ; 
        public String password  ;
    
        public User() {
            // TODO Auto-generated constructor stub
        }
    
        public User(String username, String password) {
            this.username = username;
            this.password = password;
        }
    
        @Override
        public String toString()
        {
            return "User{" +
                    "username='" + username + '\'' +
                    ", password='" + password + '\'' +
                    '}';
        }
    }
    

    服务端返回:

    {"username":"zhy","password":"123"}
    

    客户端按以下方式调用:

     OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUser",
    new OkHttpClientManager.ResultCallback<User>()
    {
        @Override
        public void onError(Request request, Exception e)
        {
            e.printStackTrace();
        }
    
        @Override
        public void onResponse(User user)
        {
            mTv.setText(u.toString());//UI线程
        }
    });
    

    我们传入泛型User,在onResponse里面直接回调User对象。
    注意:如果在json字符串转变为实例对象过程中出现错误,程序不会崩溃,onError方法会被回调。
    注意:接口命名从StringCallback修改为ResultCallback.接口中的onFailure方法修改为onError.

    1. 回调对象集合
      服务端返回:
    [{"username":"zhy","password":"123"},{"username":"lmj","password":"12345"}]
    

    客户端可以如下调用:

    OkHttpClientManager.getAsyn("http://192.168.56.1:8080/okHttpServer/user!getUsers",
    new OkHttpClientManager.ResultCallback<List<User>>()
    {
        @Override
        public void onError(Request request, Exception e)
        {
            e.printStackTrace();
        }
        @Override
        public void onResponse(List<User> us)
        {
            Log.e("TAG", us.size() + "");
            mTv.setText(us.get(1).toString());
        }
    });
    

    唯一的区别,就是泛型变为List<User>.

    参考:http://blog.csdn.net/mynameishuangshuai/article/details/51303446
    http://blog.csdn.net/lmj623565791/article/details/47911083

    相关文章

      网友评论

          本文标题:OkHttp3使用

          本文链接:https://www.haomeiwen.com/subject/uxxadxtx.html