我刚开始接触 okhttp3 的时候，就想要发个请求而已，网络文章大多介绍原理、细节，对于入门者，还不能或者不想接触这些，只想发送网络请求感受一番。下面步骤是满足 restful 风格的 get/post/delete/put 请求的异步请求封装，开箱即用。

1. 添加网络访问权限

修改 AndroidManifest.xml 文件，添加网络访问权限。

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

2. 添加 okhttp 依赖

修改 build.gradle 文件，添加 okhttp 的依赖。

  1. implementation 'com.squareup.okhttp3:okhttp:3.12.0'

3. 新建 HttpUtil.java 类

restful 风格的 get/post/delete/put 请求封装。还不完善，不过对于 Py-novel 项目来说是够用了。请求 http 请求一直失败，请求 https 就能成功返回，不知道是不是内部限制。

如果有变量报红线，请注意看该类所属的包是否为 okhttp3，下面文件最上方列出了我用到的类所属的包。

  1. package top.dkvirus.novel.okhttptest;
  3. import android.util.Log;
  5. import org.json.JSONException;
  6. import org.json.JSONObject;
  8. import java.util.Map;
  10. import okhttp3.Call;
  11. import okhttp3.Callback;
  12. import okhttp3.MediaType;
  13. import okhttp3.OkHttpClient;
  14. import okhttp3.Request;
  15. import okhttp3.RequestBody;
  17. public class HttpUtil {
  19.     private static final String TAG = "HttpUtil";
  21.     /**
  22.      * get 请求
  23.      */
  24.     public static void get (String url, Callback callback) {
  25.         OkHttpClient client = new OkHttpClient();
  27.         Request request = new Request.Builder()
  28.                 .url(url)
  29.                 .build();
  31.         client.newCall(request).enqueue(callback);
  32.     }
  34.     /**
  35.      * post 请求
  36.      */
  37.     public static void post (String url, Map<String, Object> map, Callback callback) {
  38.         OkHttpClient client = new OkHttpClient();
  40.         MediaType JSON = MediaType.parse("application/json; charset=utf-8");
  41.         JSONObject jsonObject = new JSONObject();
  43.         try {
  44.             for (String key : map.keySet()) {
  45.                 jsonObject.put(key, map.get(key));
  46.             }
  47.         } catch (JSONException e) {
  48.             Log.d(TAG, "POST 请求 json 格式参数解析错误");
  49.             e.printStackTrace();
  50.         }
  52.         Log.d(TAG, "POST 请求参数：" + jsonObject.toString());
  54.         RequestBody body = RequestBody.create(JSON, jsonObject.toString());
  55.         Request request = new Request.Builder()
  56.                 .url(url)
  57.                 .post(body)
  58.                 .build();
  60.         client.newCall(request).enqueue(callback);
  61.     }
  63.     /**
  64.      * delete 请求
  65.      */
  66.     public static void delete (String url, Callback callback) {
  67.         OkHttpClient client = new OkHttpClient();
  69.         Request request = new Request.Builder()
  70.                 .url(url)
  71.                 .delete()
  72.                 .build();
  74.         client.newCall(request).enqueue(callback);
  75.     }
  77.     /**
  78.      * put 请求
  79.      */
  80.     public static void put (String url, Map<String, Object> map, Callback callback) {
  81.         OkHttpClient client = new OkHttpClient();
  83.         MediaType JSON = MediaType.parse("application/json; charset=utf-8");
  84.         JSONObject jsonObject = new JSONObject();
  86.         try {
  87.             for (String key : map.keySet()) {
  88.                 jsonObject.put(key, map.get(key));
  89.             }
  90.         } catch (JSONException e) {
  91.             Log.d(TAG, "PUT 请求 json 格式参数解析错误");
  92.             e.printStackTrace();
  93.         }
  95.         RequestBody body = RequestBody.create(JSON, jsonObject.toString());
  96.         Request request = new Request.Builder()
  97.                 .url(url)
  98.                 .put(body)
  99.                 .build();
  101.         client.newCall(request).enqueue(callback);
  102.     }
  104. }

4. 使用示例

  1. package top.dkvirus.novel.okhttptest;
  3. import android.support.v7.app.AppCompatActivity;
  4. import android.os.Bundle;
  5. import android.util.Log;
  6. import android.widget.TextView;
  8. import java.io.IOException;
  9. import java.util.HashMap;
  10. import java.util.Map;
  12. import okhttp3.Call;
  13. import okhttp3.Callback;
  14. import okhttp3.Response;
  16. public class MainActivity extends AppCompatActivity {
  18.     private static final String TAG = "MainActivity";
  20.     TextView resp_text;
  22.     @Override
  23.     protected void onCreate(Bundle savedInstanceState) {
  24.         super.onCreate(savedInstanceState);
  25.         setContentView(R.layout.activity_main);
  27.         resp_text = findViewById(R.id.resp_text);
  29.         // Get 请求示例代码
  30. //        HttpUtil.get("https://novel.dkvirus.top/api/test/gysw/novel/classify", new Callback() {
  31. //            @Override
  32. //            public void onFailure(Call call, IOException e) {
  33. //                Log.d(TAG, "onFailure: 失败了");
  34. //            }
  35. //
  36. //            @Override
  37. //            public void onResponse(Call call, Response response) throws IOException {
  38. //                Log.d(TAG, "onResponse: 成功了");
  39. //                Log.d(TAG, "onResponse: " + response.body().string());
  40. //            }
  41. //        });
  43.         // Post 请求示例代码
  44. //        Map<String, Object> map = new HashMap<String, Object>();
  45. //        map.put("username", "18056891356");
  46. //        map.put("password", "123456");
  47. //        map.put("client_type", "MOBILE");
  48. //        HttpUtil.post("https://novel.dkvirus.top/api/test/gysw/user/info", map, new Callback() {
  49. //            @Override
  50. //            public void onFailure(Call call, IOException e) {
  51. //                Log.d(TAG, "onFailure: 新增数据失败");
  52. //            }
  53. //
  54. //            @Override
  55. //            public void onResponse(Call call, Response response) throws IOException {
  56. //                Log.d(TAG, "onResponse: 新增数据成功");
  57. //                Log.d(TAG, "onResponse: " + response);
  58. //            }
  59. //        });
  61.         // Delete 请求示例代码
  62. //        HttpUtil.delete("https://novel.dkvirus.top/api/test/gysw/shelf/29", new Callback() {
  63. //            @Override
  64. //            public void onFailure(Call call, IOException e) {
  65. //                Log.d(TAG, "onFailure: 删除数据失败");
  66. //            }
  67. //
  68. //            @Override
  69. //            public void onResponse(Call call, Response response) throws IOException {
  70. //                Log.d(TAG, "onResponse: 删除数据成功");
  71. //                Log.d(TAG, "onResponse: " + response);
  72. //            }
  73. //        });
  75.         // Post 请求示例代码
  76.         Map<String, Object> map = new HashMap<>();
  77.         map.put("recent_chapter_url", "https://www.biquge5200.cc/0_7/2046.html");
  78.         HttpUtil.put("https://novel.dkvirus.top/api/test/gysw/shelf/30", map, new Callback() {
  79.             @Override
  80.             public void onFailure(Call call, IOException e) {
  81.                 Log.d(TAG, "onFailure: 修改数据失败");
  82.             }
  84.             @Override
  85.             public void onResponse(Call call, Response response) throws IOException {
  86.                 Log.d(TAG, "onResponse: 修改数据成功");
  87.                 Log.d(TAG, "onResponse: " + response);
  88.             }
  89.         });
  91.     }
  93. }

5. 解析数据

okhttp3 默认返回数据为字符串类型，想要转换为 json 格式的数据需要怎么做？

这里使用 gson 方式解析响应，第一步在 build.gradle 中加入 gson 依赖。

  1. implementation 'com.google.code.gson:gson:2.7'

在上面的 HttpUtil.java 中添加一个方法。

  1. public static <T> T parseJSONWithGSON (String jsonData, TypeToken<T> typeToken) {
  2.         Gson gson = new Gson();
  3.         T t = gson.fromJson(jsonData, typeToken.getType());
  4.         return t;
  5. }

响应的数据结构如下：

  1. {
  2.     code: "0000",
  3.     message: "操作成功",
  4.     data: {
  5.         userId: 1,
  6.         username: "dkvirus",
  7.     }
  8. }

定义实体类，实体类结构要与返回的数据结构一一对应。

  1. public class DetailResult {
  3.     private String code;
  5.     private String message;
  7.     private Detail data;
  9.     // get/set 方法自己补充
  10. }
  12. // 另外一个 Java 类
  13. public class Detail {
  15.     private int userId;
  17.     private String username;
  19.     // get/set 方法自己补充
  21. }

解析

  1. String responseData =  response.body().string();
  2. DetailResult detailResult = HttpUtil.parseJSONWithGSON(responseData, new TypeToken<DetailResult>(){});