okhttp3学习笔记

    面试使人能够更正确的认识自己，通过这一轮的面试，我发现自己的基础知识还是有欠缺的。而且我的记性是真不好，很多写过的代码，通过很长时间的思考和摸索才做出来的效果，过不了多久都忘了，因此我决定把平时常用的，我写项目的过程中遇到的困难，解决的方法都一一记录下来，同时，也把平时学习新知识的笔记写在这里。

这是简书第一篇，上一个项目我都写在了博客园的个人主页。

这一篇记录我学习okhttp3 分以下几个内容：

1.okhttp3的使用

2.http协议详解

3.okhttp3的简单封装

---

1.okhttp3的快速使用：

1.使用前准备：

Android Studio配置：

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

compile'com.squareup.okio:okio:1.7.0'

添加网络权限：

uses-permission android:name="android.permission.INTERNET"

2.get请求：

private void getAsynHttp() {

mOkHttpClient=new OkHttpClient();

Request.Builder requestBuilder = new Request.Builder()

.url("http://www.baidu.com"); //可以省略，默认是GET请求

requestBuilder.method("GET",null);

Request request = requestBuilder.build();

Call mcall= mOkHttpClient.newCall(request);

mcall.enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) { }

@Override

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

if (null != response.cacheResponse()) {

String str = response.cacheResponse().toString();

Log.i("kimliu", "cache---" + str);

} else {

response.body().string();

String str = response.networkResponse().toString();

Log.i("kimliu", "network---" + str); }

runOnUiThread(new Runnable() {

@Override

public void run() {

Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_SHORT).show(); } }); } }); }

2.异步POST请求

private void postAsynHttp() {

mOkHttpClient=new OkHttpClient();

RequestBody formBody = new FormBody.Builder()

.add("size", "10")

.build();

Request request = new Request.Builder()

.url("http://api.1-blog.com/biz/bizserver/article/list.do")

.post(formBody)

.build();

Call call = mOkHttpClient.newCall(request);

call.enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) { }

@Override

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

String str = response.body().string();

Log.i("kimliu", str);

runOnUiThread(new Runnable() {

@Override

public void run() {

Toast.makeText(getApplicationContext(), "请求成功", Toast.LENGTH_SHORT).show(); } }); } }); }

3.异步上传文件

上传文件本身也是一个POST请求，首先定义上传文件类型：

public static final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");

将sdcard根目录的test.txt文件上传到服务器上：

private void postAsynFile() {

mOkHttpClient=new OkHttpClient();

File file = new File("/sdcard/test.txt");

Request request = new Request.Builder()

.url("https://api.github.com/markdown/raw") .post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))

.build();

mOkHttpClient.newCall(request).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) { }

@Override

public void onResponse(Call call, Response response) throws IOException { Log.i("kimliu",response.body().string()); } }); }

当然如果想要改为同步的上传文件只要调用 mOkHttpClient.newCall(request).execute()就可以了。

当然不要忘了添加如下权限：

uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"

uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"

4.异步下载文件

private void downAsynFile() {

mOkHttpClient = new OkHttpClient();

String url = "https://img-my.csdn.net/uploads/201603/26/1458988468_5804.jpg";

Request request = new Request.Builder().url(url).build(); mOkHttpClient.newCall(request).enqueue(new Callback() {

@Override

public void onFailure(Call call, IOException e) { }

@Override

public void onResponse(Call call, Response response) {

InputStream inputStream = response.body().byteStream();

FileOutputStream fileOutputStream = null;

try {

fileOutputStream = new FileOutputStream(new File("/sdcard/wangshu.jpg"));

byte[] buffer = new byte[2048];

int len = 0;

while ((len = inputStream.read(buffer)) != -1) {

fileOutputStream.write(buffer, 0, len);

}

fileOutputStream.flush();

} catch (IOException e) {

Log.i("wangshu", "IOException"); e.printStackTrace();

}

Log.d("kimliu", "文件下载成功"); } }); }

5.异步上传Multipart文件

这种场景很常用，我们有时会上传文件同时还需要传其他类型的字段，OkHttp3实现起来很简单，需要注意的是没有服务器接收我这个Multipart文件，所以这里只是举个例子，具体的应用还要结合实际工作中对应的服务器。

首先定义上传文件类型：

private static final MediaType MEDIA_TYPE_PNG = MediaType.parse("image/png");

private void sendMultipart(){

mOkHttpClient = new OkHttpClient();RequestBody requestBody = new MultipartBody.Builder().setType(MultipartBody.FORM).addFormDataPart("title","wangshu").addFormDataPart("image","wangshu.jpg",

RequestBody.create(MEDIA_TYPE_PNG, new File("/sdcard/wangshu.jpg"))).build();Request request = new Request.Builder().header("Authorization","Client-ID "+"...").url("https://api.imgur.com/3/image").post(requestBody).build();mOkHttpClient.newCall(request).enqueue(new Callback() {

@Override

public void onFailure(Callcall, IOException e) {

}

@Override

public void onResponse(Callcall, Response response) throws IOException {

Log.i("wangshu", response.body().string());}

});}

6.设置超时时间和缓存

和OkHttp2.x有区别的是不能通过OkHttpClient直接设置超时时间和缓存了，而是通过OkHttpClient.Builder来设置，通过builder配置好OkHttpClient后用builder.build()来返回OkHttpClient，所以我们通常不会调用new OkHttpClient()来得到OkHttpClient，而是通过builder.build()：

File sdcache = getExternalCacheDir();

int cacheSize =10*1024*1024;

OkHttpClient.Builderbuilder = new OkHttpClient.Builder()

.connectTimeout(15, TimeUnit.SECONDS)

.writeTimeout(20, TimeUnit.SECONDS)

.readTimeout(20, TimeUnit.SECONDS)

.cache(new Cache(sdcache.getAbsoluteFile(), cacheSize));

OkHttpClient mOkHttpClient=builder.build();

---

2.http协议详解

http协议中通信的两方称作Client和Server，Client向Server端经过http协议发送一个request，server端收到Request后经过一系列的处理返回client一个Response。

Http:

超文本传输协议

作用：设计之初是为了将超文本标记语言（html）文档从Web服务器传送到客户端的浏览器。现在http的作用已不局限于html的传输。

URL:

Schema:指定底层使用的协议：http/https/ftp

Host：http服务器的IP地址或者域名www.baidu.com

port:http服务器默认端口是80，这种情况下端口号可以省略。如果用了别的端口，必须指明

path:访问的资源路径:/st/test

query-string:发送给http服务器的数据 name=user&pwd=123456

http是无状态的，同一个客户端的这次请求和上次请求是没有对应关系的，对http服务器来说，它并不知道这两个请求来自同一个客户端，这时候就需要cookie机制来维护状态。

Request:请求

由三部分组成：

Request line (请求行)， http header ，body

请求行：包括http请求的种类，请求资源的路径，http协议版本

http header:http头部信息

body:发送给服务器的query信息（当使用GET时，body是空的，GET只能读取服务器上的信息，post能写入）

Response:响应 三部分

Request line :协议版本

Requeset header :request头信息

Body：返回的请求资源主体，就是服务器返回的内容

GET 和 POST的区别

http协议定义了许多与服务器交互的方法，最基本的有4种，分别是GET,POST,PUT,DELETE.一个URL地址用于描述一个网络上的资源，而HTTP中的GET POST PUT DELETE对应着查，改，增，删4个操作。最常见的GET和POST.GET一般用于获取/查询信息，POST一般用于更新资源信息。

1. GET提交的数据会放在URL之后，以？分割URL和传输数据，参数之间以&相连。POST是吧提交的数据放在HTTP包的Body中。

2. GET提交的数据大小有限制（因为浏览器对于URL的长度有限制）而POST方法提交的数据没有限制。

3. GET方式提交数据，会带来安全问题，比如一个登录页面，通过GET方式提交数据时，用户名和密码将出现在URL上，如果页面可以被缓存或者其他人可以访问这台机器，就可以从历史记录获取该账号密码

状态码：

HTTP1.1中定义了5类状态码，状态码又三位数字组成，第一个数字定义了响应的类别。

1xx：指示信息 表示请求已接受，继续处理

2xx：成功 表示请求已被成功接收，理解，接受。

3xx：重定向 要完成请求必须进行进一步的操作

4xx：客户端错误 请求有语法错误或请求无法实现

5xx：服务器端错误，服务器未能实现合法的请求

常见：

200 OK

400 Bad Request 客户端请求有语法错误，不能被服务器理解。

401 请求未经授权，这个状态码必须和www-authenticate报头域一起使用

403 服务器收到请求，但是拒绝提供服务

404 请求资源不存在 可能是输入了错误的URL

500 服务器发生不可预期的错误

505 服务器当前不能出了客户端的请求，一段时间后可能恢复

http headers