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. 壓縮
  3. 緩存
  4. 從網絡問題中恢復
  5. 重定向
  6. 重試
  7. 同步和異步調用的支援

同步 vs 異步調用

  • 同步調用需要在其周圍包裹一個AsyncTask。這意味著它不支援取消請求。而且，AsyncTasks通常會洩漏Activity的上下文，這不是首選。
  • 異步調用是推薦的方式，因為它支援本地取消，標記多個請求並通過一個方法調用全部取消它們（通過在onPause或onDestroy方法中調用Activity實例上的取消）。

在我們查看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.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