摘自《第一行代码——Android(第二版)》
9.2.2 使用OkHttp
当然我们并不是只能使用HttpURLConnection,完全没有任何其他选择,事实上在开源盛行的今天,有许多出色的网络通信库都可以替代原生的HttpURLConnection,而其中OkHttp无疑是做得最出色的一个。
OkHttp是由鼎鼎大名的Square公司开发的,这个公司在开源事业上面贡献良多,除了OkHttp之外,还开发了像Picasso、Retrofit等著名的开源项目。OkHttp不仅在接口封装上面做得简单易用,就连在底层实现上也是自成一派,比起原生的HttpURLConnection,可以说是有过之而无不及,现在已经成了广大Android开发者首选的网络通信库。那么本小节我们就来学习一下OkHttp的用法,OkHttp的项目主页地址是:https://github.com/square/okhttp 。
在使用OkHttp之前,我们需要先在项目中添加OkHttp库的依赖。编辑app/build.gradle文件,在dependencies闭包中添加如下内容:
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])
compile 'com.android.support:appcompat-v7:24.2.1'
testCompile 'junit:junit:4.12'
compile 'com.squareup.okhttp3:okhttp:3.4.1'
}
——ps: Android Studio3.1版本以上将 compile 'com.squareup.okhttp3:okhttp:3.4.1'
改为 :
implementation 'com.squareup.okhttp3:okhttp:3.4.1'
添加上述依赖会自动下载两个库,一个是OkHttp库,一个是Okio库,后者是前者的通信基础。其中3.4.1是我写本书时OkHttp的最新版本,你可以访问OkHttp的项目主页来查看当前最新的版本是多少。
下面我们来看一下OkHttp的具体用法,首先需要创建一个OkHttpClient的实例,如下所示:
OkHttpClient client = new OkHttpClient();
接下来如果想要发起一条HTTP请求,就需要创建一个Request 对象:
Request request = new Request.Builder().build();
当然,上述代码只是创建了一个空的Request 对象,并没有什么实际作用,我们可以在最终的build() 方法之前连缀很多其他方法来丰富这个Request 对象。比如可以通过url() 方法来设置目标的网络地址,如下所示:
Request request = new Request.Builder()
.url("http://www.baidu.com")
.build();
之后调用OkHttpClient的newCall() 方法来创建一个Call 对象,并调用它的execute() 方法来发送请求并获取服务器返回的数据,写法如下:
Response response = client.newCall(request).execute();
其中Response 对象就是服务器返回的数据了,我们可以使用如下写法来得到返回的具体内容:
String responseData = response.body().string();
---------------------------------------@@@@@@@@@@@@@@@@@@@@@@@@-------------------------------------------------------
如果是发起一条POST 请求会比GET 请求稍微复杂一点,我们需要先构建出一个Request Body 对象来存放待提交的参数,如下所示:
RequestBody requestBody = new FormBody.Builder()
.add("username", "admin")
.add("password", "123456")
.build();
然后在Request.Builder中调用一下post() 方法,并将RequestBody 对象传入:
Request request = new Request.Builder()
.url("http://www.baidu.com")
.post(requestBody)
.build();
接下来的操作就和GET 请求一样了,调用execute() 方法来发送请求并获取服务器返回的数据即可。
好了,OkHttp的基本用法就先学到这里。
举例基本使用:
public class MainActivity extends AppCompatActivity implements View.OnClickListener {
...
@Override
public void onClick(View v) {
if (v.getId() == R.id.send_request) {
sendRequestWithOkHttp();//按钮的点击事件里去调用 sendRequestWithOkHttp()这个方法
}
}
private void sendRequestWithOkHttp() {
new Thread(new Runnable() {//在这个方法中同样还是先开启了一个子线程
@Override
public void run() {
try {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("http://www.baidu.com")
.build(); //然后在子线程里使用OkHttp发出一条HTTP请求,请求的目标地址还是百度的首页的一样。
Response response = client.newCall(request).execute();//接收服务器返回的数据
String responseData = response.body().string();//得到具体数据
showResponse(responseData);//调用了showResponse() 方法来将服务器返回的数据显示到界面上
} catch (Exception e) {
e.printStackTrace();
}
}
}).start();
}
private void showResponse() {
//显示到主线程
}
...
}
这里我们并没有做太多的改动,只是添加了一个sendRequestWithOkHttp() 方法,并在Send Request按钮的点击事件里去调用这个方法。在这个方法中同样还是先开启了一个子线程,然后在子线程里使用OkHttp发出一条HTTP请求,请求的目标地址还是百度的首页,OkHttp的用法也正如前面所介绍的一样。最后仍然还是调用了showResponse() 方法来将服务器返回的数据显示到界面上。
仅仅是改了这么多代码,现在我们就可以重新运行一下程序了。点击Send Request按钮后,你会看到和上一小节中同样的运行结果,由此证明,使用OkHttp来发送HTTP请求的功能也已经成功实现了。
这样的话,相信你就已经把HttpURLConnection和OkHttp的基本用法都掌握得差不多了。