2023年Android OkHttp完整教程：从入门到精通的实战指南

3 年 ago
新, 韵
4 minutes

OkHttp Android 示例教程 – 第1部分（共3部分）

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

OkHttp 是 Android 上的一个网络库

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

OkHttp在Android上的优势

OkHttp带给我们的一些优势有：

  • 连接池
  • Gzip压缩
  • 缓存
  • 从网络问题中恢复
  • 重定向
  • 重试
  • 支持同步和异步调用

同步调用 vs 异步调用

  • 同步调用需要在它周围包装一个AsyncTask。这意味着它不支持取消请求。此外，AsyncTasks通常会泄露Activity的上下文，这是不推荐的。
  • 异步调用是推荐的方式，因为它支持原生取消、标记多个请求并通过单个方法调用取消所有请求（通过在onPause或onDestroy方法内调用Activity实例的cancel方法）。

在我们深入研究OkHttp Android实现之前，请添加以下依赖项。

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

在AndroidManifest.xml文件中添加互联网权限。

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

OkHttp Android 示例代码

这是文章《OkHttp Android 示例教程》的第2部分（共3部分）。

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

package com.Olivia.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.Olivia.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.scdev.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响应

这是文章《OkHttp Android 示例教程》的第3部分（共3部分）。

我们可以解析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 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安卓示例项目

bannerAds