Android高级开发之【OkHttp】详解（附项目源码）

文章大纲

1、OkHttp简介
2、OkHttp简单使用
3、OkHttp封装
4、项目源码下载

1、OkHttp简介

1. 什么是OkHttp

通常在Java平台上，咱们会使用Apache HttpClient做为Http客户端，用于发送 HTTP 请求，并对响应进行处理。好比可使用http客户端与第三方服务(如SSO服务)进行集成，固然还能够爬取网上的数据等。OKHttp与HttpClient相似，也是一个Http客户端，提供了对 HTTP/2 和 SPDY 的支持，并提供了链接池，GZIP 压缩和 HTTP 响应缓存功能。

2. OkHttp优势

（1）支持HTTP2/SPDY（SPDY是Google开发的基于TCP的传输层协议，用以最小化网络延迟，提高网络速度，优化用户的网络使用体验）
（2）socket自动选择最好路线，并支持自动重连，拥有自动维护的socket链接池，减小握手次数，减小了请求延迟，共享Socket,减小对服务器的请求次数
（3）基于Headers的缓存策略减小重复的网络请求
（4）拥有Interceptors轻松处理请求与响应（自动处理GZip压缩）

3. OkHttp功能

(1)通常的get请求
(2)通常的post请求
(3)基于Http的文件上传
(4)文件下载
(5)上传下载的进度回调
(6)加载图片
(7)支持请求回调，直接返回对象、对象集合
(8)支持session的保持
(9)支持自签名网站https的访问，提供方法设置下证书就行
(10)支持取消某个请求

复制代码

3. OkHttp使用步骤

(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()
(5)看到这，你可能会奇怪，居然还能拿到返回的inputStream，看到这个最起码能意识到一点，这里支持大文件下载，有inputStream咱们就能够经过IO的方式写文件。不过也说明一个问题，这个onResponse执行的线程并非UI线程。的确是的，若是你但愿操做控件，仍是须要使用handler等
(6)okHttp还支持GJson的处理方式
(7)okhttp支持同步请求和异步请求，Call call = client.newCall(request);为同步请求，发送请求后，就会进入阻塞状态，知道收到响应call.enqueue(new Callback()为异步请求
(8)在okhttp3.Callback的回调方法里面有个参数是Call 这个call能够单独取消相应的请求，随便在onFailure或者onResponse方法内部执行call.cancel()均可以。若是想取消全部的请求，则能够okhttpclient.dispatcher().cancelAll();

2、OkHttp简单使用

1. 进行get请求

/** * 原始的get请求 * * @author 吴晓畅 * */
public class OkHttpGet {

    public void get() {

         //1.okhttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient.Builder().
                //在这里，还能够设置数据缓存等
                //设置超时时间
                connectTimeout(15, TimeUnit.SECONDS).
                readTimeout(20, TimeUnit.SECONDS).
                writeTimeout(20,  TimeUnit.SECONDS).
                //错误重连 
                retryOnConnectionFailure(true).
                build();

        //2构造Request,
        //builder.get()表明的是get请求，url方法里面放的参数是一个网络地址
        Request.Builder builder = new Request.Builder();

        Request request = builder.get().url("http://www.baidu.com/").build();

        //3将Request封装成call
        Call call = okHttpClient.newCall(request);

        //4，执行call，这个方法是异步请求数据
        call.enqueue(new Callback() {

            @Override
            public void onFailure(Call arg0, IOException arg1) {

                //失败调用
            }

            @Override
            //因为OkHttp在解析response的时候依靠的是response头信息当中的Content-Type字段来判断解码方式
            //OkHttp会使用默认的UTF-8编码方式来解码
            //这里使用的是异步加载，若是须要使用控件，则在主线程中调用
            public void onResponse(Call arg0, Response arg1) throws IOException {

                 //成功调用

            }
        });

    }
}

复制代码

2. 进行post请求

/** * 使用okhttp进行post请求 * * @author 吴晓畅 * */
public class OkHttpPost {

    public void initPost() {

        //1.okhttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient.Builder().
                //在这里，还能够设置数据缓存等
                //设置超时时间
                connectTimeout(15, TimeUnit.SECONDS).
                readTimeout(20, TimeUnit.SECONDS).
                writeTimeout(20,  TimeUnit.SECONDS).
                //错误重连 
                retryOnConnectionFailure(true).
                build();

         RequestBody requestBodyPost = new FormBody.Builder()
         .add("page", "1")
         .add("code", "news")
         .add("pageSize", "20")
         .add("parentid", "0")
         .add("type", "1")
         .build();

         Request requestPost = new Request.Builder()
         .url("www.baidu.com")
         .post(requestBodyPost)
         .build();

         okHttpClient.newCall(requestPost).enqueue(new Callback() {

            @Override
            public void onFailure(Call arg0, IOException arg1) {
                // TODO Auto-generated method stub

            }

            @Override
            public void onResponse(Call arg0, Response arg1) throws IOException {

                //okHttp还支持GJson的处理方式
                //在这里能够进行List<bean>和bean处理

            }

         });

 }

}

复制代码

3. 进行图片上传和下载

/** * 使用OkHttp进行图片上传和下载 * * @author 吴晓畅 * */
public class OkHttpPicture {

    public void getPicture() {

         //1.建立一个okhttpclient对象 
         OkHttpClient okHttpClient = new OkHttpClient();  

         //2.建立Request.Builder对象，设置参数，请求方式若是是Get，就不用设置，默认就是Get 
         Request request = new Request.Builder()  
                .url("www.baidu.com")  
                .build();  

         //3.建立一个Call对象，参数是request对象，发送请求 
         Call call = okHttpClient.newCall(request);  

         //4.异步请求，请求加入调度 
         call.enqueue(new Callback() {

            @Override
            public void onFailure(Call arg0, IOException arg1) {
                // TODO Auto-generated method stub

            }

            @Override
            public void onResponse(Call arg0, Response arg1) throws IOException {

// //获得从网上获取资源，转换成咱们想要的类型 
// byte[] Picture_bt = response.body().bytes(); 
// //经过handler更新UI 
// Message message = handler.obtainMessage(); 
// message.obj = Picture_bt; 
// message.what = SUCCESS; 
// handler.sendMessage(message); 

            } 

        });  

    }

    public void shangChuanPicture() {

        OkHttpClient mOkHttpClent = new OkHttpClient();

        //获取sd卡中的文件
        File file = new File(Environment.getExternalStorageDirectory()+"/HeadPortrait.jpg");

        MultipartBody.Builder builder = new MultipartBody.Builder()
                //设置类型
                .setType(MultipartBody.FORM)
                //设置正文内容
                .addFormDataPart("img", "HeadPortrait.jpg",
                        RequestBody.create(MediaType.parse("image/png"), file));

        RequestBody requestBody = builder.build();

        Request request = new Request.Builder()
                .url("www.baidu.com")
                .post(requestBody)
                .build();

        Call call = mOkHttpClent.newCall(request);

    }
}

复制代码

3. 拦截器使用

什么是拦截器
  首先咱们须要了解什么事拦截器。打个比方，镖局押着一箱元宝在行走在一个山间小路上，忽然从山上下来一群山贼拦住了镖局的去路，将镖局身上值钱的东西搜刮干净后将其放行。其中山贼至关于拦截器，镖局至关于一个正在执行任务的网络请求，请求中的参数就是镖局携带的元宝。拦截器能够将网络请求携带的参数进行修改验证，而后放行。这里面其实设计了AOP编程的思想（面向切面编程）。
  在介绍拦截器的做用和好处以前，咱们仍是要回到山贼这个角色上，若是让你作一次山贼，你会在什么地方埋伏？确定是在镖局必经之路上埋伏。也就是说，拦截器就是在全部的网络请求的必经之地上进行拦截。
（1）拦截器能够一次性对全部的请求和返回值进行修改。
（2）拦截器能够一次性对请求的参数和返回的结果进行编码，好比统一设置为UTF-8.
（3）拦截器能够对全部的请求作统一的日志记录，不须要在每一个请求开始或者结束的位置都添加一个日志操做。
（4）其余须要对请求和返回进行统一处理的需求….

OkHttp中拦截器分类
OkHttp中的拦截器分2个：APP层面的拦截器（Application Interception）、网络请求层面的拦截器(Network Interception)
（1）Application Interceptor是在请求执行刚开始，尚未执行OkHttp的核心代码前进行拦截，Application拦截器的做用：
1）不须要担忧是否影响OKHttp的请求策略和请求速度。
2）即便是从缓存中取数据，也会执行Application拦截器。
3）容许重试，即Chain.proceed()能够执行屡次。（固然请不要盲目执行屡次，须要加入你的逻辑判断）
（2）Network Interception是在链接网络以前
1）能够修改OkHttp框架自动添加的一些属性（固然最好不要修改）。
2）能够观察最终完整的请求参数（也就是最终服务器接收到的请求数据和熟悉）

使用注意点
若是对拦截器不是很熟的同窗，开发过程当中，建议使用Application Interception。这样避免对OkHttp请求策略的破坏。

常见实际场景
（1）对请求参数进行统一加密处理。
（2）拦截不符合规则的URL。
（3）对请求或者返回参数设置统一的编码方式
（4）其它…。

代码实操

public class OkHttpLanJieQi {

    /** * 应用拦截器 */
    Interceptor appInterceptor = new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {

            Request request = chain.request();

            //———请求以前要作的事情————
            HttpUrl url = request.url();
            String s = url.url().toString();

            Response response = chain.proceed(request);

            //———请求以后要作事情————
            Log.d("aa","app interceptor:begin");

            return response;

        }

    };

    /** * 网络拦截器 */
    Interceptor networkInterceptor = new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {
            Request request = chain.request();

            //———请求以前要作的事情————

            Response  response = chain.proceed(request);

          //———请求以后要作事情————

            return response;
        }
    };

    /** * 进行get请求，并配置拦截器 */
    public void initGet() {

        OkHttpClient okHttpClient = new OkHttpClient
                .Builder()
                .addInterceptor(appInterceptor)//Application拦截器
                .addNetworkInterceptor(networkInterceptor)//Network拦截器
                .build();

        //2构造Request,
        //builder.get()表明的是get请求，url方法里面放的参数是一个网络地址
        Request.Builder builder = new Request.Builder();

        Request request = builder.get().url("http://www.baidu.com/").build();

        //3将Request封装成call
        Call call = okHttpClient.newCall(request);

        //4，执行call，这个方法是异步请求数据
        call.enqueue(new Callback() {

            @Override
            public void onFailure(Call arg0, IOException arg1) {

                //失败调用
            }

            @Override
            //因为OkHttp在解析response的时候依靠的是response头信息当中的Content-Type字段来判断解码方式
            //OkHttp会使用默认的UTF-8编码方式来解码
            //这里使用的是异步加载，若是须要使用控件，则在主线程中调用
            public void onResponse(Call arg0, Response arg1) throws IOException {

                 //成功调用

            }
        });

    }

}

复制代码

3、OkHttp封装

1. 自行简单封装

/** * okhttp操做进行封装 * * @author 吴晓畅 * */
public class OkHttp {

    public void get(String url, Callback callback) {

        //1.okhttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient.Builder().
                //在这里，还能够设置数据缓存等
                //设置超时时间
                connectTimeout(15, TimeUnit.SECONDS).
                readTimeout(20, TimeUnit.SECONDS).
                writeTimeout(20,  TimeUnit.SECONDS).
                addInterceptor(appInterceptor).//Application拦截器
                //错误重连 
                retryOnConnectionFailure(true).
                build();

        //2构造Request,
        //builder.get()表明的是get请求，url方法里面放的参数是一个网络地址
        Request.Builder builder = new Request.Builder();

        Request request = builder.get().url(url).build();

        //3将Request封装成call
        Call call = okHttpClient.newCall(request);

        //4，执行call，这个方法是异步请求数据
        call.enqueue(callback);

    }

    public void post(String url, List<String> list, Callback callback, RequestBody requestBody) {

        //1.okhttpClient对象
        OkHttpClient okHttpClient = new OkHttpClient.Builder().
                //在这里，还能够设置数据缓存等
                //设置超时时间
                connectTimeout(15, TimeUnit.SECONDS).
                addInterceptor(appInterceptor).//Application拦截器
                readTimeout(20, TimeUnit.SECONDS).
                writeTimeout(20,  TimeUnit.SECONDS).
                //错误重连 
                retryOnConnectionFailure(true).
                build();

         RequestBody requestBodyPost = requestBody;

         Request requestPost = new Request.Builder()
         .url(url)
         .post(requestBodyPost)
         .build();

         okHttpClient.newCall(requestPost).enqueue(callback);

    }

    /** * 应用拦截器 */
    Interceptor appInterceptor = new Interceptor() {
        @Override
        public Response intercept(Chain chain) throws IOException {

            Request request = chain.request();

            //———请求以前要作的事情————

            Response response = chain.proceed(request);

            //———请求以后要作事情————

            return response;

        }

    };
}

复制代码

2. Android--OKHttpUtils框架封装

简介
  OKHttpUtils:一个专一于让网络请求更简单的网络请求框架，对于任何形式的网络请求只须要一行代码。它是OKHttp的一次二次封装，封装的目的是让网络请求更加方便。

OKHttpUtils优点
（1）性能高，使用主流的okhttp的进行封装
  OKHttp咱们知道它支持http2和socket的重连。自动选择最好的路线，拥有本身维护socket维护的链接池。能够减小TCP的握手次数，同时它拥有队列线程池能够轻松的并发请求。
（2）特有的网络缓存模式
  OKHttpUtils是大多数网络框架不具有的，好比咱们公司的网络老板要求不只在有网的状况下，进行展现网络数据，在无网的状况下使用缓存数据。这时候咱们使用普通网络请求，就须要大量的判断。当前是否有网和无网状态，根据不一样的状态保存不一样的数据。而后再决定是否使用缓存。可是这是一个通用的写法。因而OKHttpUtils使用自动网络缓存模式。让用户只关注数据处理。
（3）方便易用的扩展接口
  能够添加全局的公共参数、全局的拦截器、全局的超时时间，更能够对单个请求定制拦截器。请求参数修改等等。
（4）强大的Cookie的保存策略
  在客户端对Cookie的获取不是一个特别简单的事情，Cookie全程自动管理，而且提供了额外的Cookie管理方法，引入额外的自动管理中，添加任何你想建立的Cookie。

依赖包导入

compile 'com.zhy:okhttputils:2.0.0'

复制代码

进行get请求

private String get(String url) throws IOException {

      Request request = new Request.Builder()

          .url(url)//传url

          .build();//建立

      //把request传进client
      //execute()执行线程
      Response response = client.newCall(request).execute();

      return response.body().string();
    }

复制代码

进行post请求

private 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();
        return response.body().string();
    }

复制代码

使用okhttp-utils请求单张图片

public void getImage() {
         tv_result.setText("");
            String url = "http://images.csdn.net/20150817/1.jpg";
            OkHttpUtils
                    .get()//
                    .url(url)//
                    .tag(this)//
                    .build()//
                    .connTimeOut(20000)//连接超时
                    .readTimeOut(20000)//读取超时
                    .writeTimeOut(20000)//写入超时
                    .execute(new BitmapCallback()
                    {
                        @Override
                        public void onError(Call call, Exception e, int id) {
                            tv_result.setText("onError:" + e.getMessage());
                        }

                        @Override
                        public void onResponse(Bitmap bitmap, int id) {
                            Log.e("TAG", "onResponse：complete");
                            iv_icon.setImageBitmap(bitmap);
                        }
                    });
        }

复制代码

使用okhttp-utils上传多个或者单个文件

/** * 使用okhttp-utils上传多个或者单个文件 */     
     public void multiFileUpload() {

         //FileUploadServlet
         String mBaseUrl = "http://192.168.3.27:8080/FileUpload/FileUploadServlet";

            File file = new File(Environment.getExternalStorageDirectory(), "tupian.jpg");
            File file2 = new File(Environment.getExternalStorageDirectory(), "zanghao.jpg");
            if (!file.exists())
            {
                Toast.makeText(OKHttpActivity.this, "文件不存在，请修改文件路径", Toast.LENGTH_SHORT).show();
                return;
            }
// Map<String, String> params = new HashMap<String, String>();
// params.put("username", "黄敏莹");
// params.put("password", "123");

            String url = mBaseUrl;
            OkHttpUtils.post()//
                    .addFile("mFile", "server_tupian.jpg", file)//
                    .addFile("mFile", "server_zanghao.jpg", file2)//两个addFile就是多文件上传，注释掉一个就是单文件上传
                    .url(url)
// .params(params)//
                    .build()//
                    .execute(new MyStringCallBack());//回调
        }

复制代码

回调处理

/** * 用于回调 * @author Mloong * */
    private class MyStringCallBack extends StringCallback{

        @Override
        public void onBefore(Request request, int id) {
            // TODO Auto-generated method stub
            super.onBefore(request, id);

            setTitle("loading...");
        }

        @Override
        public void onAfter(int id) {
            // TODO Auto-generated method stub
            super.onAfter(id);

            setTitle("sample-okhttp");
        }

        //出错
        @Override
        public void onError(Call arg0, Exception e, int arg2) {

            e.printStackTrace();

            tv_result.setText("onError:"+e.getMessage());

        }

        //成功后回调
        @Override
        public void onResponse(String response, int id) {

            //显示文本信息
            tv_result.setText("onResponse:"+ response);

            switch (id) {
            case 100:

                Toast.makeText(OKHttpActivity.this, "http", Toast.LENGTH_LONG).show();

                break;

            case 101:

                Toast.makeText(OKHttpActivity.this, "https", Toast.LENGTH_LONG).show();

                break;

            default:
                break;
            }

        }

        @Override
        public void inProgress(float progress, long total, int id) {

            Log.e(TAG, "inProgress:"+progress);

            mProgressBar.setProgress((int) (100*progress));

        }

    }

复制代码

4、项目源码下载

连接:pan.baidu.com/s/1f3eZhmfK…
密码:cv4b

关于okhttp的所有学习内容，咱们这边都有系统的知识体系以及进阶视频资料，有须要的朋友能够加群免费领取安卓进阶视频教程，源码，面试资料，群内有大牛一块儿交流讨论技术；点击连接加入群聊【腾讯@Android高级架构】：
（包括自定义控件、NDK、架构设计、混合式开发工程师(React native，Weex)、性能优化、完整商业项目开发等）

Android高级进阶视频教程