http://www.idtkm.com/
Okhttp基本使用
1、导入添加依赖:
compile "com.squareup.okhttp:okhttp:3.2.0"
清单文件中添加网络访问权限:
<uses-permission android:name="android.permission.INTERNET"/>
2、get请求和post请求的区别
对于get方式,服务器端用Request.QueryString获取变量的值,对于post方式,服务器端用Request.Form获取提交的数据
get传送的数据量较小,不能大于2KB。post传送的数据量较大,一般被默认为不受限制。但理论上,IIS4中最大量为80KB,IIS5中为100KB
get安全性非常低,post安全性较高。但是执行效率却比Post方法好
get可以被浏览器缓存,post不可以
项目开发中,当涉及到参数的安全问题或者参数比较大的时候,应该使用Post请求方式(例如:登录,注册,上传,支付,下单);如果是相对简单的查询类接口可以使用Get请求方式(例如:获取图片,获取文章详情)
3、同步/异步发送get请求
1) 创建OkHttpClient对象:
OkHttpClient okHttpClient = new OkHttpClient();
2)使用Request.Builder构建请求对象
Request类封装了请求报文信息:请求的Url地址、请求的方法(如GET、POST等)、各种请求头(如Content-Type、Cookie)以及可选的请求体
Request request = new Request.Builder()
.url(URL)
.build();
3)创建一个call对象,对象是response,发送请求
Call call = okHttpClient.newCall(request);
- 执行Call对象的execute()方法,会阻塞当前线程去获取数据,该方法返回一个Response对象。
//调用execute()发送同步请求
try {
Response response = call.execute();
//判断请求是否成功
if(response.isSuccessful()) {
Log.i("TAG",response.body().string());
response.body().close();
}
//关闭body
response.body().close();
} catch (IOException e) {
e.printStackTrace();
}
- 执行Call对象的enqueue()方法,不会阻塞当前线程,该方法接收一个Callback对象,当异步获取到数据之后,会回调执行Callback对象的相应方法。如果请求成功,则执行Callback对象的onResponse方法,并将Response对象传入该方法中;如果请求失败,则执行Callback对象的onFailure方法。
//通过调用enqueue()发送异步请求,异步请求开启了新的线程执行网络请求
call.enqueue(new Callback() {
@Override
public void onFailure(Request request, IOException e) {
//请求失败的回调方法
}
@Override
public void onResponse(Response response) throws IOException {
//请求成功的回调方法
String result = response.body().string();
Log.i("TAG",result);
//关闭body
response.body().close();
}
});
4)同步/异步发送post请求:
public static final MediaType JSON = MediaType
.parse("application/json; charset=utf-8");
public static final String json = "{android: hello world!}";
/**
* 同步发送post请求提交json数据
*/
OkHttpClient okhttpClient = new OkHttpClient();
//创建一个RequestBody对象(参数1:参数类型,参数2:传输的json串)
RequestBody requestBody = RequestBody.create(JSON,json);
//创建一个请求对象
Request request = new Request.Builder()
.url(URL)
.post(requestBody)
.build();
//发送同步请求,获取响应对象
Call call = okhttpClient.newCall(request);
try {
Response response = call.execute();
//判断请求是否成功
if(response.isSuccessful()) {
Log.i("TAG",response.body().string());
response.body().close();
}
} catch (IOException e) {
e.printStackTrace();
}
/**
* 异步发送post请求提交键值对
*/
OkHttpClient okHttpClient = new OkHttpClient();
//创建一个请求体
RequestBody requestBody = new FormEncodingBuilder()
.add("name","张三")
.add("age","24")
.add("sex","男")
.build();
//创建一个请求对象
Request request = new Request.Builder()
.url(URL)
.post(requestBody)
.build();
//发送异步请求,获取响应对象
Call call = okHttpClient.newCall(request);
call.enqueue(new Callback() {
@Override
public void onFailure(Request request, IOException e) {
}
@Override
public void onResponse(Response response) throws IOException {
//判断请求是否成功
if(response.isSuccessful()) {
Log.i("TAG",response.body().string());
response.body().close();
}
}
});
5)简单的封装
public class OkHttpManager {
public static OkHttpManager instence;
private OkHttpClient mOkHttpClient;
private Handler okHandler;
private OkHttpManager() {
//声明Handler对指定为主线程looper,确保执行线程在主线程中。
okHandler = new Handler(Looper.getMainLooper());
//指定超时时间等参数
OkHttpClient.Builder builder = new OkHttpClient.Builder()
.connectTimeout(15, TimeUnit.SECONDS)
.readTimeout(20, TimeUnit.SECONDS)
.writeTimeout(20, TimeUnit.SECONDS);
mOkHttpClient = builder.build();
}
/**
* 获取当前的实例对象,确保唯一性
*/
public static OkHttpManager getInstence() {
if (instence == null) {
synchronized (OkHttpManager.class) {
if (instence == null) {
instence = new OkHttpManager();
}
}
}
return instence;
}
/**
* 发送get请求
*
* @param url
* @param resultCallback
*/
public void getNet(String url, ResultCallback resultCallback) {
Request request = new Request.Builder()
.url(url) //接口地址
.method("GET", null) //默认的也是GET,可以不设置
.build();
dealNet(request,resultCallback);
}
/**
* 发送post请求
*
* @param url
* @param resultCallback
* @param param 传入数量不定的参数
*/
public void postNet(String url, ResultCallback resultCallback, Param... param) {
if (param == null) {
param = new Param[0];
}
FormBody.Builder frombody = new FormBody.Builder();
for (Param p : param) {
frombody.add(p.key, p.value);
}
RequestBody requestBody = frombody.build();
Request request = new Request.Builder()
.url(url)
.post(requestBody) //传入构建好的参数
.build();
dealNet(request,resultCallback);
}
/**
* 网络请求
*
* @param request 请求
* @param resultCallback 自定义的监听回调
*/
public void dealNet(final Request request, final ResultCallback resultCallback) {
mOkHttpClient.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, final IOException e) {
okHandler.post(new Runnable() {
@Override
public void run() {
//请求失败的时候执行的方法
resultCallback.onFailed(request, e);
}
});
}
@Override
public void onResponse(Call call, final Response response) throws IOException {
String str = "";
try {
str = response.body().string();
} catch (IOException e) {
e.printStackTrace();
}
final String finalStr = str;
Log.i("OkHttpManager", "onResponse" + finalStr);
okHandler.post(new Runnable() {
@Override
public void run() {
//请求成功的时候执行的方法
resultCallback.onSuccess(finalStr);
}
});
}
});
}
/**
* 自定义监听回调
*/
public static abstract class ResultCallback {
public abstract void onFailed(Request request, IOException e);
public abstract void onSuccess(String response);
}
/**
* 参数封装类
*/
public static class Param {
String key;
String value;
public Param() {
}
public Param(String key, String value) {
this.key = key;
this.value = value;
}
}
}
OkHttpClient.Builder
public Builder() {
dispatcher = new Dispatcher();
protocols = DEFAULT_PROTOCOLS;
connectionSpecs = DEFAULT_CONNECTION_SPECS;
proxySelector = ProxySelector.getDefault();
cookieJar = CookieJar.NO_COOKIES;
socketFactory = SocketFactory.getDefault();
hostnameVerifier = OkHostnameVerifier.INSTANCE;
certificatePinner = CertificatePinner.DEFAULT;
proxyAuthenticator = Authenticator.NONE;
authenticator = Authenticator.NONE;
connectionPool = new ConnectionPool();
dns = Dns.SYSTEM;
followSslRedirects = true;
followRedirects = true;
retryOnConnectionFailure = true;
connectTimeout = 10_000;
readTimeout = 10_000;
writeTimeout = 10_000;
}