详解 Android okhttp 网络请求get，post传输数据的基本用法
官网网址：http://square.github.io/okhttp/
github地址：https://github.com/square/okhttp
OKHttp优点
1、支持HTTP2/SPDY（SPDY是Google开发的基于TCP的传输层协议，用以最小化网络延迟，提升网络速度，优化用户的网络使用体验。）
2、socket自动选择最好路线，并支持自动重连，拥有自动维护的socket连接池，减少握手次数，减少了请求延迟，共享Socket,减少对服务器的请求次数。
3、基于Headers的缓存策略减少重复的网络请求。
4、拥有Interceptors轻松处理请求与响应（自动处理GZip压缩）。
OKHttp的功能
1、PUT，DELETE，POST，GET等请求
2、文件的上传下载
3、加载图片(内部会图片大小自动压缩)
4、支持请求回调，直接返回对象、对象集合
5、支持session的保持
流程图
核心的类：
OkHttpClient：客户端对象
Request：访问请求，Post请求中需要包含RequestBody
RequestBody：请求数据，在Post请求中用到
Response：即网络请求的响应结果
MediaType：数据类型，用来表明数据是json，image，pdf等一系列格式
client.newCall(request).execute()：同步的请求方法
client.newCall(request).enqueue(Callback callBack)：异步的请求方法，但Callback是执行在子线程中的，因此不能在此进行UI更新操作
实现步骤
一、在app/build.gradle中添加引用
dependencies {
implementation "com.squareup.okhttp3:okhttp:3.12.1"
implementation 'com.squareup.okio:okio:2.1.0' //依赖库
}二、在manifest.xml中添加网络权限
三、使用方法
使用OKHttp进行网络请求支持两种方式，一种是同步请求，一种是异步请求。
1、get的同步请求
对于同步请求在请求时需要开启子线程，请求成功后需要跳转到UI线程修改UI。
public void getData(){
new Thread(new Runnable() {
@Override
public void run() {
try {
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象
Request request = new Request.Builder()
.url("http://www.baidu.com")//请求接口。如果需要传参拼接到接口后面。
.build();//创建Request 对象
Response response = null;
response = client.newCall(request).execute();//得到Response 对象
if (response.isSuccessful()) {
Log.d("kwwl","response.code()=="+response.code());
Log.d("kwwl","response.message()=="+response.message());
Log.d("kwwl","res=="+response.body().string());
//此时的代码执行在子线程，修改UI的操作请使用handler跳转到UI线程。
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
此时打印结果如下：
response.code()==200；
response.message()==OK；
res=={“code”:200,”message”:success};
注意事项：
1，Response.code是http响应行中的code，如果访问成功则返回200.这个不是服务器设置的，而是http协议中自带的。res中的code才是服务器设置的。注意二者的区别。
2，response.body().string()本质是输入流的读操作，所以它还是网络请求的一部分，所以这行代码必须放在子线程。
3，response.body().string()只能调用一次，在第一次时有返回值，第二次再调用时将会返回null。原因是：response.body().string()的本质是输入流的读操作，必须有服务器的输出流的写操作时客户端的读操作才能得到数据。而服务器的写操作只执行一次，所以客户端的读操作也只能执行一次，第二次将返回null。
2、get的异步请求
这种方式不用再次开启子线程，但回调方法是执行在子线程中，所以在更新UI时还要跳转到UI线程中。
private void getData() {
String url = Urls.INFO + "?guestId=" + guestId;
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder().url(url).get().build();
Call call = client.newCall(request);
//异步调用并设置回调函数
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
runOnUiThread(new Runnable() {
@Override
public void run() {
Toast.makeText(MemberInfoActivity.this, "获取数据失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String responseStr = response.body().string();
if (response.code() == 200) {//请求和获取数据成功
runOnUiThread(new Runnable() {
@Override
public void run() {
try {
JSONObject jb = new JSONObject(responseStr);
mUserInfoVO = JsonUtil.getModelFromJSON(jb.optString("data"),UserInfoVO.class);
updateView();
} catch (JSONException e) {
e.printStackTrace();
}
}
});
} else {
runOnUiThread(new Runnable() {
@Override
public void run() {
try {
JSONObject jsonObject = new JSONObject(responseStr);
Toast.makeText(MemberInfoActivity.this, jsonObject.optString("message"), Toast.LENGTH_SHORT).show();
} catch (JSONException e) {
e.printStackTrace();
}
}
});
}
}
});
}异步请求的打印结果与注意事项与同步请求时相同。最大的不同点就是异步请求不需要开启子线程，enqueue方法会自动将网络请求部分放入子线程中执行。
注意事项：
1，回调接口的onFailure方法和onResponse执行在子线程。
2，response.body().string()方法也必须放在子线程中。当执行这行代码得到结果后，再跳转到UI线程修改UI。
3、post请求的使用方法
Post请求也分同步和异步两种方式，同步与异步的区别和get方法类似，所以此时只讲解post异步请求的使用方法
private void postData() {
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
FormBody.Builder formBody = new FormBody.Builder();//创建表单请求体
formBody.add("username","zhangsan");//传递键值对参数
Request request = new Request.Builder()//创建Request 对象。
.url("http://www.baidu.com")
.post(formBody.build())//传递请求体
.build();
client.newCall(request).enqueue(new Callback() {。。。});//回调方法的使用与get异步请求相同，此处省略
}4、Post 字符串
OkHttpClient client = new OkHttpClient();
StringBuffer sb = new StringBuffer();
sb.append("{\"clientid\":\"" + PreferencesUtil.getUserPreferences(Constants.CLIENTID) + "\",");
sb.append("\"password\":\"" + password + "\",");
sb.append("\"phone\":\"" + phone + "\"}");
String url = Urls.LOGIN;
RequestBody updateDataBody = RequestBody.create(MediaType.parse("application/json; charset=utf-8"), sb.toString());
Request request = new Request.Builder().url(url).post(updateDataBody).build();
Call call = client.newCall(request);
//异步调用并设置回调函数
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
TUtil.showToast(LoginActivity.this, "请检查网络");
}
@Override
public void onResponse(Call call, Response response) throws IOException {
try {
String responseStr = response.body().string();
final JSONObject jb = new JSONObject(responseStr);
if (response.code() == 200) {
runOnUiThread(new Runnable() {
@Override
public void run() {
String uniqueId = jb.optString("data");
PreferencesUtil.saveUserPreferences(Constants.UNIQUE_ID, uniqueId);
startActivity(new Intent(LoginActivity.this, MainActivity.class));
}
});
} else {
String messages = jb.optString("messages");
TUtil.showToast(LoginActivity.this, messages);
}
} catch (JSONException e) {
e.printStackTrace();
}
}
});
TUtil.java
public class TUtil {
public static void showToast(final Activity activity, final String message) {
if ("main".equals(Thread.currentThread().getName())) {
Log.e("TUtil", "在主线程");
Toast.makeText(activity, message, Toast.LENGTH_SHORT).show();
} else {
activity.runOnUiThread(new Runnable() {
@Override
public void run() {
Log.e("TUtil", "不在主线程");
Toast.makeText(activity, message, Toast.LENGTH_SHORT).show();
}
});
}
}
}
5、使用RequestBody传递Json或File对象
RequestBody是抽象类，故不能直接使用，但是他有静态方法create，使用这个方法可以得到RequestBody对象。
这种方式可以上传Json对象或File对象。
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
MediaType JSON = MediaType.parse("application/json; charset=utf-8");//数据类型为json格式，
String jsonStr = "{\"username\":\"lisi\",\"nickname\":\"李四\"}";//json数据.
RequestBody body = RequestBody.create(JSON, josnStr);
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {。。。});//此处省略回调方法。上传File对象使用示例如下：
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
MediaType fileType = MediaType.parse("File/*");//数据类型为json格式，
File file = new File("path");//file对象.
RequestBody body = RequestBody.create(fileType , file );
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {。。。});//此处省略回调方法。6、使用MultipartBody同时传递键值对参数和File对象
这个字面意思是多重的body。我们知道FromBody传递的是字符串型的键值对，RequestBody传递的是多媒体，那么如果我们想二者都传递怎么办？此时就需要使用MultipartBody类。
OkHttpClient client = new OkHttpClient();
MultipartBody multipartBody =new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("groupId",""+groupId)//添加键值对参数
.addFormDataPart("title","title")
.addFormDataPart("file",file.getName(),RequestBody.create(MediaType.parse("file/*"), file))//添加文件
.build();
final Request request = new Request.Builder()
.url(URLContant.CHAT_ROOM_SUBJECT_IMAGE)
.post(multipartBody)
.build();
client.newCall(request).enqueue(new Callback() {。。。});7、自定义RequestBody实现流的上传
在上面的分析中我们知道，只要是RequestBody类以及子类都可以作为post方法的参数，下面我们就自定义一个类，继承RequestBody，实现流的上传。
RequestBody body = new RequestBody() {
@Override
public MediaType contentType() {
return null;
}
@Override
public void writeTo(BufferedSink sink) throws IOException {//重写writeTo方法
FileInputStream fio= new FileInputStream(new File("fileName"));
byte[] buffer = new byte[1024*8];
if(fio.read(buffer) != -1){
sink.write(buffer);
}
}
};然后使用body对象：
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {。。。});以上代码的与众不同就是body对象，这个body对象重写了write方法，里面有个sink对象。这个是OKio包中的输出流，有write方法。使用这个方法我们可以实现上传流的功能。
使用RequestBody上传文件时，并没有实现断点续传的功能。我可以使用这种方法结合RandomAccessFile类实现断点续传的功能。
8、设置请求头
OKHttp中设置请求头特别简单，在创建request对象时调用一个方法即可。
Request request = new Request.Builder()
.url("http://www.baidu.com")
.header("User-Agent", "OkHttp Headers.java")
.addHeader("token", "myToken")
.build();
9、下载文件
在OKHttp中并没有提供下载文件的功能，但是在Response中可以获取流对象，有了流对象我们就可以自己实现文件的下载。代码如下：
这段代码写在回调接口CallBack的onResponse方法中：
try{
InputStream is = response.body().byteStream();//从服务器得到输入流对象
long sum = 0;
File dir = new File(mDestFileDir);
if (!dir.exists()){
dir.mkdirs();
}
File file = new File(dir, mdestFileName);//根据目录和文件名得到file对象
FileOutputStream fos = new FileOutputStream(file);
byte[] buf = new byte[1024*8];
int len = 0;
while ((len = is.read(buf)) != -1){
fos.write(buf, 0, len);
}
fos.flush();
return file;
}10、对于OKHttp的使用封装
由于okhttp是偏底层的网络请求类库，返回结果的回调方法仍然执行在子线程中，需要自己跳转到UI线程，使用麻烦。为了使用方便需要对OKHttp进行再次封装。对于OKHttp的封装首推的就是hongyang大神的OKHttpUtils
github的地址是：https://github.com/guozhengXia/OkHttpUtils
学习文章地址：https://www.jianshu.com/p/e6e0de569d38