OkHttp Android示例教程
时间：2020-02-23 14:29:29 来源:igfitidea点击:
OkHttp是Square在2013年引入的第三方库，用于发送和接收基于HTTP的网络请求。
OkHttp Android
最初，Android只有两个HTTP客户端：HttpURLConnection和Apache HTTP Client。
用于从网络发送和接收数据。
这些客户端中的每个客户端都需要在AsyncTask或者后台线程方法中编写大量样板代码。
而且，这些客户端在取消HTTP请求或者连接池方面有其自身的限制。
OkHttp android通过直接在Java Socket的顶部工作而无需使用任何其他依赖项，从而提供HttpURLConnection和Apache Client接口的实现。
OkHttp Android的优势
OkHttp给我们带来的一些好处是：
- 连接池
- 压缩
- 快取
- 从网络问题中恢复
- 重新导向
- 重试
- 支持同步和异步调用
同步与异步调用
同步调用需要围绕它的AsyncTask包装器。
这意味着它不支持取消请求。
另外，AsyncTasks通常会泄漏Activity的上下文，因此不推荐使用。推荐使用异步调用，因为它支持本机取消，标记多个请求并通过单个方法调用将它们全部取消(通过在onPause或者onDestroy方法内在Acitivty实例上调用cancel)。
在我们研究OkHttp android的实现之前，请添加以下依赖项
compile 'com.squareup.okhttp3:okhttps:3.4.1'
在AndroidManifest.xml文件内添加互联网许可。
<uses-permission android:name="android.permission.INTERNET"
OkHttp Android示例代码
下面给出了用于同步调用的MainActivity.java。
package com.theitroad.okhttp;
import android.os.AsyncTask;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.IOException;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
public class MainActivity extends AppCompatActivity {
OkHttpClient client = new OkHttpClient();
TextView txtString;
public String url= "https://reqres.in/api/users/2";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
txtString= (TextView)findViewById(R.id.txtString);
OkHttpHandler okHttpHandler= new OkHttpHandler();
okHttpHandler.execute(url);
}
public class OkHttpHandler extends AsyncTask {
OkHttpClient client = new OkHttpClient();
@Override
protected String doInBackground(String...params) {
Request.Builder builder = new Request.Builder();
builder.url(params[0]);
Request request = builder.build();
try {
Response response = client.newCall(request).execute();
return response.body().string();
}catch (Exception e){
e.printStackTrace();
}
return null;
}
@Override
protected void onPostExecute(String s) {
super.onPostExecute(s);
txtString.setText(s);
}
}
}
对于异步调用，MainActivity.java应该定义为：
package com.theitroad.okhttp;
import android.os.AsyncTask;
import android.support.v7.app.AppCompatActivity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.widget.Button;
import android.widget.TextView;
import org.json.JSONException;
import org.json.JSONObject;
import java.io.IOException;
import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
public class MainActivity extends AppCompatActivity {
TextView txtString;
public String url= "https://reqres.in/api/users/2";
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
txtString= (TextView)findViewById(R.id.txtString);
try {
run();
} catch (IOException e) {
e.printStackTrace();
}
}
void run() throws IOException {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url(url)
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
call.cancel();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String myResponse = response.body().string();
MainActivity.this.runOnUiThread(new Runnable() {
@Override
public void run() {
txtString.setText(myResponse);
}
});
}
});
}
}
我们从这里开始使用了测试API。
返回的响应字符串为JSON格式，并在屏幕上打印出来。
您可以尝试其他开源API，例如Github API，Stackoverflow等。
OkHttp查询参数示例
如果有任何查询参数，我们可以使用HttpUrl.Builder类轻松地传递它们。
HttpUrl.Builder urlBuilder = HttpUrl.parse("https://httpbin.org/get).newBuilder();
urlBuilder.addQueryParameter("website", "www.theitroad.local");
urlBuilder.addQueryParameter("tutorials", "android");
String url = urlBuilder.build().toString();
Request request = new Request.Builder()
.url(url)
.build();
以上网址是从https://resttesttest.com/获得的。
OkHttp Android标头示例
如果有任何经过身份验证的查询参数，则可以按标题形式添加它们，如下所示：
Request request = new Request.Builder()
.header("Authorization", "replace this text with your token")
.url("your api url")
.build();
处理JSON响应
我们可以解析JSON数据以获取相关的参数，并将其显示在TextView中，如下代码所示。
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
call.cancel();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
final String myResponse = response.body().string();
MainActivity.this.runOnUiThread(new Runnable() {
@Override
public void run() {
try {
JSONObject json = new JSONObject(myResponse);
txtString.setText(json.getJSONObject("data").getString("first_name")+ " "+json.getJSONObject("data").getString("last_name"));
} catch (JSONException e) {
e.printStackTrace();
}
}
});
}
});
OkHttp Android POST示例
到目前为止，我们一直在通过调用一些API来获得响应。
要将数据发布到服务器，我们需要通过以下方式构建请求。
public class MainActivity extends AppCompatActivity {
public String postUrl= "https://reqres.in/api/users/";
public String postBody="{\n" +
" \"name\": \"morpheus\",\n" +
" \"job\": \"leader\"\n" +
"}";
public static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
try {
postRequest(postUrl,postBody);
} catch (IOException e) {
e.printStackTrace();
}
}
void postRequest(String postUrl,String postBody) throws IOException {
OkHttpClient client = new OkHttpClient();
RequestBody body = RequestBody.create(JSON, postBody);
Request request = new Request.Builder()
.url(postUrl)
.post(body)
.build();
client.newCall(request).enqueue(new Callback() {
@Override
public void onFailure(Call call, IOException e) {
call.cancel();
}
@Override
public void onResponse(Call call, Response response) throws IOException {
Log.d("TAG",response.body().string());
}
});
}
}
在上面的代码中，我们使用了OkHttp一部分的MediaType类来定义要传递的数据类型。
我们使用了https://reqres.in/中的测试API URL。
在带有相关值的RequestBuilder上调用post(RequestBody body)方法。
日志显示以下响应。
{" name"：" morpheus"，" job"：" leader"，" id"：" 731"，" createdAt"："" 2016-01-03T17：26：05.158Z"}。
OkHttp是在改造网络库中使用的推荐HttpClient。
