OkHttp使用（二）：用法进阶
一、Get请求
1.get的同步请求
对于同步请求在请求时需要开启子线程，请求成功后需要跳转到UI线程修改UI。
使用示例如下：
public void getDataSync() {
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();
Response response = null;
response = client.newCall(request).execute();//得到Response 对象
if (response.isSuccessful()) {
StringBuilder builder = new StringBuilder();
builder.append("response.code():" + response.code() + "\n");
builder.append("response.message():" + response.message() + "\n");
builder.append("response.body():" + response.body().string() + "\n");
//此时的代码执行在子线程，修改UI的操作请使用 handler 跳转到UI线程，或直接使用 runOnUiThread()
showResponse(builder.toString());
}
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
2.get的异步请求
这种方式不用再次开启子线程，但回调方法是执行在子线程中，所以在更新UI时还要跳转到UI线程中。
使用示例如下：
private void getDataAsync() {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("http://www.baidu.com")
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
}
@Override
public void onResponse(Call call, Response response) throws IOException {
if (response.isSuccessful()) {
StringBuilder builder = new StringBuilder();
builder.append("Get Data Successful!\n");
builder.append("response.code():" + response.code() + "\n");
builder.append("response.body():" + response.body().string() + "\n");
//此时的代码执行在子线程，修改UI的操作请使用 handler 跳转到UI线程，或直接使用 runOnUiThread()
showResponse(builder.toString());
}
}
});
}
异步请求的打印结果与注意事项与同步请求时相同。最大的不同点就是异步请求不需要开启子线程，enqueue方法会自动将网络请求部分放入子线程中执行。
注意事项：
(1)回调接口的onFailure方法和onResponse执行在子线程。
(2)response.body().string()方法也必须放在子线程中。当执行这行代码得到结果后，再跳转到UI线程修改UI。
3.下载图片
public void downImage() {
OkHttpClient client = new OkHttpClient();
final Request request = new Request
.Builder()
.get()
.url("https://localhost/path/image.png")
.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(DownloadActivity.this, "下载图片失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
InputStream inputStream = response.body().byteStream();
//将图片显示到ImageView中
final Bitmap bitmap = BitmapFactory.decodeStream(inputStream);
runOnUiThread(new Runnable() {
@Override
public void run() {
image.setImageBitmap(bitmap);
}
});
//将图片保存到本地存储卡中
File file = new File(Environment.getExternalStorageDirectory(), "image.png");
FileOutputStream fileOutputStream = new FileOutputStream(file);
byte[] temp = new byte[128];
int length;
while ((length = inputStream.read(temp)) != -1) {
fileOutputStream.write(temp, 0, length);
}
fileOutputStream.flush();
fileOutputStream.close();
inputStream.close();
}
});
}
二、post请求的使用方法
1.请求方式
Post请求也分同步和异步两种方式，同步与异步的区别和get方法类似，所以此时只讲解post异步请求的使用方法。
使用示例如下：
private void postDataWithParame() {
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();
//回调方法的使用与get异步请求相同，可参考上文 GET 方法
client.newCall(request).enqueue(new Callback() {
... ...
});
}
看完代码我们会发现：post请求中并没有设置请求方式为POST，回忆在get请求中也没有设置请求方式为GET，那么是怎么区分请求方式的呢？重点是Request.Builder类的post方法，在Request.Builder对象创建最初默认是get请求，所以在get请求中不需要设置请求方式，当调用post方法时把请求方式修改为POST。所以此时为POST请求。
2.POST请求传递参数的方法总结
在post请求使用方法中讲了一种传递参数的方法，就是创建表单请求体对象，然后把表单请求体对象作为post方法的参数。post请求传递参数的方法还有很多种，但都是通过post方法传递的。下面我们看一下Request.Builder类的post方法的声明：
public Builder post(RequestBody body)
从方法的声明可以看出，post方法接收的参数是RequestBody 对象，所以只要是RequestBody 类以及子类对象都可以当作参数进行传递。FormBody就是RequestBody 的一个子类对象。
(1)传递键值对参数
使用 FormBody 来上传String类型的键值对，示例如下：
private void postDataWithParame() {
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();
//回调方法的使用与get异步请求相同，可参考上文 GET 方法
client.newCall(request).enqueue(new Callback() {
... ...
});
}
(2)传递字符串
使用RequestBody是抽象类，故不能直接使用，但是他有静态方法create，使用这个方法可以得到RequestBody对象。
public void postString(View view) {
OkHttpClient client = new OkHttpClient();
//RequestBody中的MediaType指定为纯文本，编码方式是utf-8
RequestBody requestBody = RequestBody.create(MediaType.parse("text/plain;charset=utf-8"),
"{username:admin;password:admin}");
final Request request = new Request.Builder()
.url("http://www.jianshu.com/")
.post(requestBody)
.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(DownloadActivity.this, "Post String 失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String responseStr = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
tv_result.setText(responseStr);
}
});
}
});
}
如果是JSON字符串，构造 RequestBody 需要调整一下数据格式即可，如下：
MediaType JSON = MediaType.parse("application/json; charset=utf-8");//数据类型为json格式，
String jsonStr = "{\"username\":\"lisi\",\"nickname\":\"李四\"}";//json数据.
RequestBody body = RequestBody.create(JSON, josnStr);
(3)表单
通过查看网站登录页的Html源代码，通常都可以查看到如下格式的登录表单
<form id="fm1" action="" method="post">
<input id="username" name="username" type="text"/>
<input id="password" name="password" type="password"/>
</form>
这里使用到 MuiltipartBody 来构建一个RequestBody，这是 RequestBody 的一个子类，提交表单数据就是利用这个类来实现的
public void postForm(View view) {
OkHttpClient client = new OkHttpClient();
RequestBody requestBody = new MultipartBody.Builder()
.setType(MultipartBody.FORM)
.addFormDataPart("username", "username")
.addFormDataPart("password", "password")
.build();
final Request request = new Request.Builder()
.url("http://localhost/login.do")
.post(requestBody)
.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(DownloadActivity.this, "Post Form 失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String responseStr = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
tv_result.setText(responseStr);
}
});
}
});
}
(4) 流
在上面的分析中我们知道，只要是RequestBody类以及子类都可以作为post方法的参数，下面我们就自定义一个类，继承RequestBody，实现流的上传。
使用示例如下：
首先创建一个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 类实现断点续传的功能。
public void postStreaming(View view) {
final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");
OkHttpClient client = new OkHttpClient();
RequestBody requestBody = new RequestBody() {
@Override
public MediaType contentType() {
return MEDIA_TYPE_MARKDOWN;
}
@Override
public void writeTo(BufferedSink sink) throws IOException {
sink.writeUtf8("Numbers\n");
sink.writeUtf8("-------\n");
for (int i = 2; i <= 997; i++) {
sink.writeUtf8(String.format(" * %s = %s\n", i, factor(i)));
}
}
private String factor(int n) {
for (int i = 2; i < n; i++) {
int x = n / i;
if (x * i == n) return factor(x) + " × " + i;
}
return Integer.toString(n);
}
};
Request request = new Request.Builder()
.url("https://localhost/raw")
.post(requestBody)
.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(DownloadActivity.this, "Post Streaming 失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String responseStr = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
tv_result.setText(responseStr);
}
});
}
});
}
(5)上传File对象
public void postFile() {
OkHttpClient client = new OkHttpClient();
final MediaType MEDIA_TYPE_MARKDOWN = MediaType.parse("text/x-markdown; charset=utf-8");
File file = new File("README.md");
Request request = new Request.Builder()
.url("https://localhost/raw")
.post(RequestBody.create(MEDIA_TYPE_MARKDOWN, file))
.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(DownloadActivity.this, "Post File 失败", Toast.LENGTH_SHORT).show();
}
});
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String responseStr = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
tv_result.setText(responseStr);
}
});
}
});
}
OkHttpClient client = new OkHttpClient();//创建OkHttpClient对象。
MediaType fileType = MediaType.parse("File/*");
File file = new File("path");//file对象.
RequestBody body = RequestBody.create(fileType , file );
Request request = new Request.Builder()
.url("http://localhost")
.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)下载文件
在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;
}
(8)设置请求头
OKHttp中设置请求头特别简单，在创建request对象时调用一个方法即可。
使用示例如下：
Request request = new Request.Builder()
.url("http://www.baidu.com")
.header("User-Agent", "OkHttp Headers.java")
.addHeader("token", "myToken")
.build();
其他部分代码略。