OkHttp 3基本用法
2017-05-23 本文已影响0人
Cris_Ma
Android Studio 添加依赖:
compile 'com.squareup.okhttp3:okhttp:3.8.0'
新的版本中已经内置了okio,不需要额外添加了
Get请求
OkHttp执行网络请求有两种方式,同步(execute)和异步(enqueue),他们的使用方法是基本一样的。下面是同步和异步的方式分别请求百度:
//同步方式
@OnClick(R.id.okhttp_get)
void getBaidu(){
//构建Client对象
OkHttpClient okHttpClient = new OkHttpClient();
//设置请求
Request request = new Request.Builder().url("https://www.baidu.com").method("GET",null).build();
final Call call = okHttpClient.newCall(request);
new Thread(new Runnable() {
@Override
public void run() {
try {
//同步的方式建立连接
final Response response = call.execute();
final String result = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
mTextView.setText(result);
}
});
} catch (IOException e) {
e.printStackTrace();
Log.d("okhttp3", "lianjie shibai ");
}
}
}).start();
}
//异步方式
@OnClick(R.id.okhttp_get_async)
void geBaiduAsync(){
//构建Client对象
OkHttpClient okHttpClient = new OkHttpClient();
//设置请求
Request request = new Request.Builder().url("https://www.baidu.com").method("GET",null).build();
final Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
Log.d("okhttp3", "connection established fail ");
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String result = response.body().string();
runOnUiThread(new Runnable() {
@Override
public void run() {
mTextView.setText(result);
}
});
}
});
}
同步方式调用的是execute,运行在当前线程,所以要分配子线程给它。异步的方式会自动分配子线程,执行完毕之后回调CallBack。
onResponse回调的参数是response,一般情况下,比如我们希望获得返回的字符串,可以通过response.body().string()
获取;如果希望获得返回的二进制字节数组,则调用response.body().bytes();
如果你想拿到返回的inputStream,则调用response.body().byteStream()
,获取返回状态码使用response.code()
添加请求头:
Request request = new Request.Builder()
.url("https://www.baidu.com")
.method("GET",null)
.header("name","value")//添加的参数具有唯一性,会移除之前设置的name值
.addHeader("name","value")//可以对同样的name设置多个值,不会移除之前的值
.build();
获取响应内容也是类似的,调用Response的header,headers方法。另外,Client里还有设置超时的方法:
okHttpClient.connectTimeoutMillis();
okHttpClient.readTimeoutMillis();
Post请求
OkHttp使用RequestBody来装载Post请求中的body(包括content-type和内容),使用方法如下:
//提交字符串
@OnClick(R.id.okhttp_post)
void postString(){
//设置content-type
MediaType MEDIA_TYPE_TEXT = MediaType.parse("text/plain");
//要提交的内容
String postBody = "Hello World";
//构建Client对象
OkHttpClient okHttpClient = new OkHttpClient();
//设置请求
Request request = new Request.Builder()
.url("https://www.baidu.com")
.method("GET",null)
//post内容添加到Request中
.post(RequestBody.create(MEDIA_TYPE_TEXT,postBody))
.build();
}
//提交键值对,3.0以后使用FormBody,也可以直接接收两个存储key和value的List<String>,作为参数
void postKeyValue(){
RequestBody formBody = new FormBody.Builder()
.add("platform", "android")
.add("name", "bug")
.add("subject", "XXXXXXXXXXXXXXX")
.build();
//构建Client对象
OkHttpClient okHttpClient = new OkHttpClient();
//设置请求
Request request = new Request.Builder()
.url("https://www.baidu.com")
.method("GET",null)
.post(formBody)
.build();
}
//提交Json
void postJson(){
final MediaType MEDIA_TYPE_JSON = MediaType.parse("application/json; charset=utf-8");
String json = "";
//构建Client对象
OkHttpClient okHttpClient = new OkHttpClient();
//设置请求
Request request = new Request.Builder()
.url("https://www.baidu.com")
.method("GET",null)
.post(RequestBody.create(MEDIA_TYPE_JSON,json))
.build();
}
拦截器
Okhttp 中内置了拦截器功能,它可以在网络请求中进行更多操作。
class MyInterceptor implements Interceptor{
@Override
public Response intercept(Chain chain) throws IOException {
Request request = chain.request();
Response response = chain.proceed(request);
return response;
}
}
OkHttpClient okHttpClient = new OkHttpClient().newBuilder().addInterceptor(new MyInterceptor() ).build();
chain.proceed(request)是每个拦截器实现的关键部分。这个方法是所有HTTP 工作发生的地方, 在这里产生一个响应应答请求。
这里添加拦截器使用的是addInterceptor方法,除此之外还有addNetworkInterceptor方法用来添加网络拦截器。