OkHttp Android 示例教程

教程
Android

OkHttp是由Square于2013年推出的第三方库，用于发送和接收基于HTTP的网络请求。

OkHttp Android

最初，Android只有两个HTTP客户端：HttpURLConnection和Apache HTTP Client，用于从网络发送和接收数据。这两个客户端都需要在AsyncTask或后台线程方法中编写大量样板代码。此外，在取消HTTP请求或连接池方面，这些客户端都有自己的一系列限制。OkHttp Android通过直接在Java Socket的顶部工作，而不使用任何额外的依赖项，提供了对HttpURLConnection和Apache Client接口的实现。

OkHttp Android优势

OkHttp带来的一些优势包括：

  1. 连接池
  2. Gzip压缩
  3. 缓存
  4. 从网络问题中恢复
  5. 重定向
  6. 重试
  7. 支持同步和异步调用

同步 vs 异步调用

  • 同步调用需要在其周围包装一个AsyncTask。这意味着它不支持取消请求。此外，AsyncTasks通常会泄漏Activity的上下文，这是不推荐的。
  • 异步调用是推荐的方式，因为它支持本地取消，标记多个请求并通过单个方法调用取消它们所有（通过在暂停或销毁方法中调用Activity实例上的取消）。

在我们查看OkHttp android的实现之前，添加以下依赖项

compile 'com.squareup.okhttp3:okhttps:3.4.1'

在AndroidManifest.xml文件中添加Internet权限。

<uses-permission android:name="android.permission.INTERNET"/>

OkHttp Android示例代码

给出了用于同步调用的MainActivity.java。

package com.journaldev.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.journaldev.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.journaldev.com");
urlBuilder.addQueryParameter("tutorials", "android");
String url = urlBuilder.build().toString();

Request request = new Request.Builder()
                     .url(url)
                     .build();

上面的URL是从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":"2017-01-03T17:26:05.158Z"}。OkHttp是Retrofit网络库内部使用的推荐HttpClient。我们将在下一个教程中详细介绍这一点。我们在布局中添加了三个按钮，分别调用每个方法，postRequest()、run()和AsyncTask包装类。您可以从以下链接下载最终的Android OkHttp项目。

下载OkHttp Android示例项目

Source:
https://www.digitalocean.com/community/tutorials/okhttp-android-example-tutorial