OkHttp基础用法
OkHttp基础用法
OkHttp是一款优秀的HTTP框架，它支持get请求和post请求，支持基于Http的文件上传和下载，支持加载图片，支持下载文件透明的GZIP压缩，支持响应缓存避免重复的网络请求，支持使用连接池来降低响应延迟问题。
配置OkHttp
AndroidStudio可以通过从Maven下载jar包。在build.gradle(app)中构建，
dependencies {
compile fileTree(include: ['*.jar'], dir: 'libs')
testCompile 'junit:junit:4.12'
compile 'com.android.support:appcompat-v7:23.4.0'
compile 'com.nostra13.universalimageloader:universal-image-loader:1.9.5'
compile 'com.squareup.okhttp3:okhttp:3.4.1'
compile 'com.squareup.okio:okio:1.11.0'
}
由于okhttp内部依赖okio，所以同时导入okio。
关键类
OkHttpClient，Request，RequestBody，Call，Callback，Response，ResponseBody
Http Get
//创建okHttpClient对象
OkHttpClient mOkHttpClient = new OkHttpClient();
//创建一个Request
final Request request = new Request.Builder()
.url("https://github.com/hongyangAndroid")
.build();
//new call
Call call = mOkHttpClient.newCall(request);
//请求加入调度
call.enqueue(new Callback()
{
@Override
public void onFailure(Request request, IOException e)
{
}
@Override
public void onResponse(final Response response) throws IOException
{
//String htmlStr = response.body().string();
}
});
代码分析:
1.首先实例化一个OkHttpClient对象，OkHttp官方文档并不建议我们创建多个OkHttpClient，因此全局使用一个。
2.创建一个请求(Request)，可以通过RequestBuilder来设置参数，例如header，method。但是至少有一个URL
3.通过request的对象去构造得到一个Call对象，类似于将你的请求封装成了任务，既然是任务，就会有execute()和cancel()等方法。
4.以异步的方式去执行请求，所以我们调用的是call.enqueue，将call加入调度队列，然后等待任务执行完成，我们在Callback中即可得到结果。
当整个GET成功，我们就回调在onResponse()方法中的方法处理ResponseBody包含的数据。通过response.body()方法得到ResponseBody对象。ResponseBody有几种方式转换返回的数据，
- string()，获得返回的字符串，方法对于小文档来说十分方便、高效。但是如果响应体太大（超过1MB），应避免适应 string()方法 ，因为他会将把整个文档加载到内存中。
- btyes()，返回二进制字节数组。
- byteStream()，返回InputStream。
Call有一个线程阻塞方法，execute()。可以直接调用这个方法返回一个Response。
注意当我们使用Call.execute()方法返回的Response，首先要进行判断是否成功。调用Response.isSuccessful()（Returns true if the code is in [200..300),这里的code指的是Http响应消息的状态码）方法来判断。
Http Post
关键类
MediaType，FormEncodingBuilder
POST提交Json数据
public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
OkHttpClient client = new OkHttpClient();
String post(String url, String json) throws IOException {
RequestBody body = RequestBody.create(JSON, json);
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
Response response = client.newCall(request).execute();
if (response.isSuccessful()) {
return response.body().string();
} else {
throw new IOException("Unexpected code " + response);
}
}
使用Request的post方法来提交请求体RequestBody
POST提交键值对
很多时候我们会需要通过POST方式把键值对数据传送到服务器。 OkHttp提供了很方便的方式来做这件事情。
kHttpClient client = new OkHttpClient();
String post(String url, String json) throws IOException {
RequestBody formBody = new FormEncodingBuilder()
.add("platform", "android")
.add("name", "bug")
.add("subject", "XXXXXXXXXXXXXXX")
.build();
Request request = new Request.Builder()
.url(url)
.post(body)
.build();
Response response = client.newCall(request).execute();
if (response.isSuccessful()) {
return response.body().string();
} else {
throw new IOException("Unexpected code " + response);
}
}
实践
图片的下载
封装OkHttp的GET访问
public static void get(String url, Callback callback) {
URL requestURL = null;
try {
requestURL = new URL(Constant.BASE_URL + url);
} catch (MalformedURLException e) {
e.printStackTrace();
}
Request request = new Request.Builder()
.url(requestURL)
.build();
Call call = mClient.newCall(request);
call.enqueue(callback);
}
public static void getImage(String url, Callback callback) {
Request request = new Request.Builder()
.url(url)
.build();
Call call = mClient.newCall(request);
call.enqueue(callback);
}
调用封装的访问方法
HttpUtil.get(imageUrl, new Callback() {
@Override
public void onFailure(Call call, IOException e) {
e.printStackTrace();
startActivity();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
try {
//获取到真正图片下载URL
JSONObject jsonObject = new JSONObject(response.body().string());
String imageUrl = jsonObject.getString("img");
loadImage(imageUrl, imageFile);
} catch (JSONException e) {
e.printStackTrace();
}
}
});
