网络框架okHttp之基本使用

引言

开发一个app，我们首先想到的肯定是搭建网络框架和图片框架，图片框架我们之前已经详细介绍了Universal-Image-Loader，对于它的使用以及实现原理我们都做出了详细的讲解，还有不理解的就去，这两篇博客中去看看：安卓面试系列–Universal-Image-Loader图片加载框架和安卓面试系列–OOM异常（二），这里我们还是带大家简单过一下，首先我们需要导包，然后加上权限，然后配置图片下载前的参数ImageLoaderConfiguration，主要配置一下硬盘缓存以及内存缓存的大小，以及线程池的大小，还有一些加密信息等等，然后就是配置图片显示参数DisplayImageOptions，这个主要配置一些占位图片，解码类型以及缩放类型等等。这些都配置好后我们就使用displayImage()方法来加载图片，最简单的方法就是传入一个url和一个ImageView控件，参数最多的方法还可以传入，自定义配置，下载情况监听，下载进度监听等等。

然后在displayImage()这个方法的源码中我们还讲解了这个框架的三级缓存原理，先是内存缓存，如果有，则直接显示，没有的话就提交一个displayTask,一般为异步加载，这个任务最终会被提交到LoadAndDisplayImage这个类中，这个类是一个Runnable实现，在它的run方法中有两个重要的方法用来下载并加载我们的图片，一个叫做tryLoadBitmap()，另一个叫做DisplayBitmapTask(),我们需要重点关注的是tryLoadBitmap这个方法，在这个方法中，我们就能看到我们熟悉的diskCache，也就是硬盘缓存，如果缓存中有我们需要的图片，那么我们就拿到图片的绝对地址，并通过decodeImage()这个方法加载图片，如果没有，那么我们就使用图片的远程uri路径，还是通过decodeImage()方法，但是这一次我们是通过网络来加载。通过这个框架已经封装好的下载类BaseImageDownloader类，在这个类中有一个叫做getStream()这个方法，这个方法中就定义了我们图片的所有来源，比如http、https、file、content、assets等等，然后通过流的方式来加载每一种图片，这样我们的图片就加载完成了。

然后我们还讲解了几种强弱引用，最著名的就是LruCache，这是一个强引用，叫做最近最少使用算法，我们还讲解了它在内存缓存中的具体实现原理，我们也来简单回顾一下。首先，LruCache是一个接口，里面定义了一些增删改查的方法，它有一个具体实现类，叫做LruMemoryCache。在这个类中，我们首先能看到它的内部使用的是LinkedHashMap这个数据结构，通过键值对的方式来存储图片，当我们把一张图片存入内存中的时候，我们首先需要判断一下，这个键值对是否为空，如果为空，就报出异常，在两者都不为空的情况下，我们再计算一下这张的大小，并把它加入到内存中，更新一下内存。如果这个时候，缓存中已经存在这张图片，就把之前的图片移除，同时更新一下内存。如果这张图片特别大，加入内存中以后超过了我们设定的缓存大小，我们就要开始尝试删除图片的工作，通过trimToSize(maxSize)这个方法来删除图片。在这个方法中有一个while循环，在这个循环中，我们先取出这个链表结构的第一个数据项，这个数据项就是我们最近最少使用的那一项，为什么是，因为在get()和put()方法中，我们取到图片后会把图片加入到链表结构的末尾，所以，这个链表结构的第一项就是我们最近最少使用的那一项。拿到它以后，我们就把它删除，同时更新一下内存，和我们设定的最大缓存maxSize做比较，如果还是大于，则继续删除，直到小于maxSize为止。这样我们就实现了缓存图片的目的，同时还删除了最近最少使用的那些数据项。

然后还简单说了一下FIFO算法，叫做先进先出算法。在这个算法中，我们会使用一个队列来存储图片，存的时候我们是存在队列的末尾，删除的时候，是删除的队列的第一项，这样就实现了先进先出的原理。

今天，我们就来看下okHttp网络框架。

功能

首先我们来了解一下okHttp可以实现的功能，然后再针对功能一一了解。

• get请求；
• post请求；
• 基于http的文件上传；
• 文件下载；
• 加载图片；
• 支持请求回调，直接返回对象、对象集合；
• 支持session的保持。

基本使用

导包

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

初始化

使用CookieManager让服务器的sessionId保持不变

CookieManager cookieManager = new CookieManager(null,CookiePolicy.ACCEPT_ALL);      //使用CookieManager注意导包    //compile 'com.squareup.okhttp3:okhttp-urlconnection:3.2.0' //  自定义创建okHttpClient对象client = new OkHttpClient.Builder()        .connectTimeout(30, TimeUnit.SECONDS)        .readTimeout(30,TimeUnit.SECONDS)        .writeTimeout(30,TimeUnit.SECONDS)        .cache(new Cache(new File(Environment.getExternalStorageDirectory(),"aaa"),1024*1024*50))        .cookieJar(new JavaNetCookieJar(cookieManager))        .build();

• 这里，我们通过构建者模式自定义了一个client对象，当然也可以通过 new OkHttpClient() 创建一个默认的client对象

get请求

对于网络加载框架，最常见的肯定就是get请求了：

流程如下：

• 1、创建okHttpClient对象
• 2、创建一个get类型的request请求
• 3、新建一个call对象；
• 4、把call对象加入调度队列

/*2 创建一个请求Request*/        Request request = new Request.Builder()                .get()                .url("www.baidu.com")                .build();        /*3 new call*/        Call call = client.newCall(request);        /*4-1 请求加入调度队列（异步方式去执行）*/        call.enqueue(new Callback() {            /*请求失败的回调方法*/            @Override            public void onFailure(Call call, IOException e) {                Log.e("TAG", "onFailure: ");            }            /*请求成功的回调方法 子线程中执行*/            @Override            public void onResponse(Call call, Response response) throws IOException {                /*获取返回的字符串*/                final String htmlStr = response.body().string();                /*获取返回的字节数组*///                byte[] bytes = response.body().bytes();                /*获取返回的输入流 支持大文件下载，通过IO流写文件*///                InputStream inputStream = response.body().byteStream();                /*onResponse在子线程中执行，刷新UI需要*/                runOnUiThread(new Runnable() {                    @Override                    public void run() {                        textView.setText(htmlStr);                    }                });                Log.e("TAG", "onResponse: "+htmlStr);            }        });

get请求总结

1. 以上就是发送一个get请求的步骤，首先需要创建一个client对象，其次我们需要创建一个request对象，参数至少需要一个url信息，当然也可以设置更多信息，比如请求头header等等，根据需要。
2. 然后我们通过client对象去新建一个call对象，将request作为参数传递进去，这样做类似于将你的请求封装成了任务，既然是任务，那么就有execute()和cancle()等方法。
3. 最后，我们使用异步的方式去执行请求，调用了call.enqueue，将call加入调度队列，等任务执行完成后，我们在Callback中即可得到结果。

注意：

1. 在onResponse这个成功回调当中，返回的参数是response，这个一个已经封装好的响应体，里面包含了很多我们想要的信息类型，如果想要得到字符串，就使用response.body().string()获取；如果想得到二进制字节数组，就使用response.body().bytes()来获取；如果想要的是输入流，就使用response.body.byteStream()获取。
2. onResponse()回调是在子线程中执行的，所以如果需要操作控件，则需要使用把信息返回到主线程，可以使用Handler或者直接使用runOnUiThread(new Runnable(){})
3. 这里我们使用的是异步的方式，把call加入队列当中，当然你也可以使用同步的方式。刚才说了call就像一个任务一样，是任务就可以直接运行，所以也可以使用call.execute()直接返回一个response。
   代码如下：

    try {           Response response = call.execute();           textView.setText(response.body().string());        } catch (IOException e) {            e.printStackTrace();        }

一般不使用此种方式，推荐使用异步的方式。

post请求

接下来我们再看看post请求。

流程如下：

• 1、创建client对象；
• 2、通过构建者模式创建FormBody对象；
• 3、创建request对象，把FormBody对象作为参数传递到post()当中；
• 4、通过client对象创建call对象，并且把request作为参数传递进去；
• 5、使用异步的方式，把call对象加入队列，通过传入Callback回调。

//构建POST请求参数FormBody body = new FormBody.Builder()        .add("username","xiaoming")        .add("password","123456")        .build();//构建请求Request request = new Request.Builder()        .url(url)        .post(body)        .build();Call call = client.newCall(request);//call加入请求队列call.enqueue(new Callback() {    @Override    public void onFailure(Call call, IOException e) {        Log.e("TAG", "onFailure: ");    }    @Override    public void onResponse(Call call, Response response) throws IOException {        final String result = response.body().string();        Log.e("TAG", "onResponse: "+result);        runOnUiThread(new Runnable() {            @Override            public void run() {                textView.setText(result);            }        });    }});

post总结

post请求和get请求最大的不同就是request对象的不同，get请求的request对象只需要传入一个url就行了，但是post请求的request对象需要在构建者模式的post()中传入一个FormBody对象，FormBody对象中封装了用户信息。

基于Http的文件上传

流程如下：

1. 创建client对象；
2. 把需要上传的文件包装成File对象；
3. 创建requestBody对象，并把File对象作为参数传递进去；
4. 创建request对象，并且把requestBody对象作为参数传递到构建者模式的post()中；
5. 通过client对象创建一个call对象，把request对象作为我参数传递进去；
6. 使用异步的方式，把call加入队列，同时传入一个Callback回调。

//创建client对象OkHttpClient okHttpClient = new OkHttpClient();//构建POST请求参数File file = new File(Environment.getExternalStorageDirectory(),"a.png");if (!file.exists()){    return;}RequestBody requestBody = RequestBody.create(        MediaType.parse("application/octet-stream"), file);//构建请求Request request = new Request.Builder()        .url(url)        .post(requestBody)        .build();Call call = okHttpClient.newCall(request);//call加入请求队列call.enqueue(new Callback() {    @Override    public void onFailure(Call call, IOException e) {        Log.e("TAG", "onFailure2: ");    }    @Override    public void onResponse(Call call, Response response) throws IOException {        final String result = response.body().string();        Log.e("TAG", "onResponse: "+result);    }});

文件上传总结

想要上传文件，我们首先需要拿到这个文件，并把它包装成File对象。其次，我们通过RequestBody这个类的create()方法，把File对象作为参数传递进去，得到RequestBody对象。然后，我们创建request对象，把RequestBody对象作为参数传递到构建者模式的post()方法中，这样就得到了request对象。然后我们通过client对象得到call对象，并且把它加入队列。

多文件上传

流程如下：

1. 创建client对象；
2. 把需要上传的文件包装成File对象；
3. 创建requestBody对象，并把File对象作为参数传递进去；
4. 创建MultipartBody对象，并添加要上传的对象；
5. 创建CountingRequestBody对象，在这里我们设定了一个进度监听；
6. 创建request对象，并把CountingRequestBody作为参数传递到构建者模式的post()方法中；
7. 用client对象创建一个call对象，并把request对象作为参数传递进去；
8. 使用异步的方法，把call加入队列，同时设定一个callback回调。

//创建client对象OkHttpClient okHttpClient = new OkHttpClient();//构建POST请求参数File file = new File(Environment.getExternalStorageDirectory(),"meinv.png");if (!file.exists()){    return;}RequestBody fileBody = RequestBody.create(        MediaType.parse("application/octet-stream"), file);MultipartBody multipartBody = new MultipartBody.Builder()        .setType(MultipartBody.FORM)        .addFormDataPart("username","xiaoming")        .addFormDataPart("password","111111")        .addFormDataPart("mPhoto","wang.png",fileBody)        .build();//上传进度回调CountingRequestBody countingRequestBody = new CountingRequestBody(multipartBody, new CountingRequestBody.Listener() {    @Override    public void onRequestProgress(long byteWrited, long contentLength) {        Log.e("TAG", "onResponse: "+byteWrited+"/"+contentLength);    }});//构建请求Request request = new Request.Builder()        .url("http://192.168.0.128:8080/OkHttp/uploadInfo")        .post(countingRequestBody)        .build();Call call = okHttpClient.newCall(request);//call加入请求队列call.enqueue(new Callback() {    @Override    public void onFailure(Call call, IOException e) {        Log.e("TAG", "onFailure2: ");    }    @Override    public void onResponse(Call call, Response response) throws IOException {        final String result = response.body().string();        Log.e("TAG", "onResponse: "+result);    }});

多文件上传总结

多文件上传相比单文件上传在原有的requestBody基础上多了两个body对象，一个是MutilpartBody，一个是CountingRequestBody。MutilpartBody负责封装我们想要上传的文件，其中包括我们的requestBody，CountingRequestBody负责文件上传的进度监听，得到了CountingRequestBody对象以后，我们就可以创建request对象了，之后的步骤就和上面的一样了，创建call，加入队列等。

总结

到这里，关于okHttp的基本使用基本上就结束了，简单总结一下吧。

不管什么请求，都需要一下几个对象，第一个是客户端对象client，第二个是请求对象request，第三个是call对象。

• 对于get请求，这个最简单的，先拿到client对象，然后是request对象，然后是call对象，最后把call对象加入队列。
• 对于post请求，相比get请求，在创建request对象之前多了一个FormBody对象，然后把FormBody对象作为参数传递给request对象的构建者，有了request对象以后，后面就和get请求一样的了。
• 对于单文件上传，相比post请求又多了一个requestBody。我们首先需要将要上传的文件包装为File对象，用File对象创建创建requestBody，然后把requestBody对象作为参数传递给request对象的构建者，这样就得到了request对象。
• 对于多文件上传，相比单文件上传，又多了两个对象，在有了requestBody对象后，我们通过requestBody对象创建MutilpartBody对象，然后在通过MutilpartBody对象创建CountingRequestBody对象，最后再把CountingRequestBody对象作为参数传递给request对象的构建者，这样也得到了request对象。

所以，重中之重就是各种请求的request对象的封装，有了request对象，我们就可以做对应的操作了。

举个栗子，这是一个从服务器下载图片的小栗子，其中，服务器是自己搭建的：

OkHttpClient okHttpClient = new OkHttpClient();//构建请求Request request = new Request.Builder()        .get()        .url("http://192.168.0.128:8080/OkHttp/files/wang.png")        .build();Call call = okHttpClient.newCall(request);//call加入请求队列call.enqueue(new Callback() {    @Override    public void onFailure(Call call, IOException e) {        Log.e("TAG", "onFailure2: ");    }    @Override    public void onResponse(Call call, Response response) throws IOException {        final InputStream is = response.body().byteStream();        final Bitmap bitmap = BitmapFactory.decodeStream(is);        runOnUiThread(new Runnable() {            @Override            public void run() {                imageView.setImageBitmap(bitmap);            }        });        Log.e("TAG", "onResponse: 下载成功");    }});

关于okHttp的使用，到这里就结束了，在下一篇博客中我们会从源码的角度讲解一下okHttp异步请求的实现原理。