Android 网络请求（二）OKHttp网络通信

学习笔记
OkHttp 是一个非常强大且流行的 HTTP 客户端库，广泛用于 Android 开辟中进行网络请求。与 HttpURLConnection 相比，OkHttp 提供了更简单、更高效的 API，特殊是在处理复杂的 HTTP 请求时。
如何使用 OkHttp 进行网络请求
以下是使用 OkHttp 发送一个简单的 GET 请求 和 POST 请求 的示例。
1. 在 build.gradle 中添加 OkHttp 依赖，以及网络权限

起首，你必要在项目标 build.gradle 文件中添加 OkHttp 的依赖。

1. dependencies {
2.     implementation 'com.squareup.okhttp3:okhttp:4.9.3'
3. }

复制代码

确保在 Gradle 同步后，可以或许乐成引入 OkHttp 库。
添加网络权限

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

复制代码

 

1. <application
2.         ...
3.         android:usesCleartextTraffic="true"
4.         .....
5.     </application>

复制代码

2. 使用 OkHttp 发送 GET 请求

下面的示例展示了如何使用 OkHttp 发送一个 GET 请求并获取返回数据。

1. import okhttp3.OkHttpClient;
2. import okhttp3.Request;
3. import okhttp3.Response;
4. import java.io.IOException;
6. public class OkHttpExample {
8.     public String getDataFromServer() {
9.         OkHttpClient client = new OkHttpClient(); // 创建 OkHttpClient 实例
10.         
11.         // 创建一个 GET 请求对象
12.         Request request = new Request.Builder()
13.                 .url("https://jsonplaceholder.typicode.com/posts") // 设置目标 URL
14.                 .build();
15.         
16.         // 用于保存响应内容
17.         String result = "";
18.         
19.         try {
20.             // 执行请求，返回一个 Response 对象
21.             Response response = client.newCall(request).execute();
22.             
23.             // 检查响应是否成功
24.             if (response.isSuccessful()) {
25.                 // 获取响应的内容（如 JSON）
26.                 result = response.body().string(); // 读取响应体的内容
27.             } else {
28.                 result = "Request failed with code: " + response.code(); // 请求失败
29.             }
30.         } catch (IOException e) {
31.             e.printStackTrace();
32.             result = "Error: " + e.getMessage(); // 捕获异常并返回错误信息
33.         }
34.         
35.         return result; // 返回请求结果
36.     }
37. }

复制代码

代码解释：

• OkHttpClient client = new OkHttpClient();：创建一个 OkHttpClient 实例，这个实例用于执行网络请求。
  
• Request request = new Request.Builder().url(...).build();：构建请求对象，通过 Request.Builder 设置 URL 和其他请求参数。
  
• Response response = client.newCall(request).execute();：使用 newCall(request).execute() 执行请求并获取响应。
  
• response.body().string()：获取响应体的内容，通常是 JSON 格式的字符串。
  
• response.code()：获取响应的 HTTP 状态码，用于判断请求是否乐成。
  

3. 使用 OkHttp 发送 POST 请求

下面是如何使用 OkHttp 发送 POST 请求，并传递一些请求体（例如 JSON 数据）。

1. import okhttp3.MediaType;
2. import okhttp3.OkHttpClient;
3. import okhttp3.Request;
4. import okhttp3.RequestBody;
5. import okhttp3.Response;
7. public class OkHttpExample {
9.     public String postDataToServer() {
10.         OkHttpClient client = new OkHttpClient(); // 创建 OkHttpClient 实例
12.         // 创建请求的 JSON 数据体
13.         String json = "{"title":"foo", "body":"bar", "userId":1}";
15.         // 设置请求体类型为 JSON
16.         MediaType JSON = MediaType.get("application/json; charset=utf-8");
17.         
18.         // 创建一个 POST 请求对象，包含请求体
19.         RequestBody body = RequestBody.create(json, JSON);
20.         Request request = new Request.Builder()
21.                 .url("https://jsonplaceholder.typicode.com/posts") // 设置目标 URL
22.                 .post(body) // 设置 POST 请求体
23.                 .build();
24.         
25.         // 用于保存响应内容
26.         String result = "";
27.         
28.         try {
29.             // 执行请求并获取响应
30.             Response response = client.newCall(request).execute();
31.             
32.             // 检查响应是否成功
33.             if (response.isSuccessful()) {
34.                 result = response.body().string(); // 获取响应体的内容
35.             } else {
36.                 result = "Request failed with code: " + response.code(); // 请求失败
37.             }
38.         } catch (IOException e) {
39.             e.printStackTrace();
40.             result = "Error: " + e.getMessage(); // 捕获异常并返回错误信息
41.         }
42.         
43.         return result; // 返回请求结果
44.     }
45. }

复制代码

代码解释：

• String json = "{\"title\":\"foo\", \"body\":\"bar\", \"userId\":1}";：这里创建了一个 JSON 字符串，表示要发送的请求体。
  
• MediaType JSON = MediaType.get("application/json; charset=utf-8");：指定请求体的类型为 application/json，告诉服务器发送的是 JSON 格式的数据。
  
• RequestBody body = RequestBody.create(json, JSON);：将 JSON 字符串转换为 RequestBody 对象，这个对象会作为请求体发送给服务器。
  
• request.post(body)：将请求体添加到请求对象中，指定该请求是一个 POST 请求。
  

4. 异步请求

在 Android 中，网络请求必要在背景线程中进行，避免阻塞主线程。如果你不盼望使用同步请求，可以使用 OkHttp 的 异步请求，通过 enqueue() 方法进行请求。

1. import okhttp3.Call;
2. import okhttp3.Callback;
3. import okhttp3.OkHttpClient;
4. import okhttp3.Request;
5. import okhttp3.Response;
6. import java.io.IOException;
8. public class OkHttpExample {
10.     public void getDataFromServerAsync() {
11.         OkHttpClient client = new OkHttpClient(); // 创建 OkHttpClient 实例
12.         
13.         // 创建 GET 请求对象
14.         Request request = new Request.Builder()
15.                 .url("https://jsonplaceholder.typicode.com/posts")
16.                 .build();
17.         
18.         // 异步请求
19.         client.newCall(request).enqueue(new Callback() {
20.             @Override
21.             public void onFailure(Call call, IOException e) {
22.                 // 请求失败时的处理
23.                 e.printStackTrace();
24.             }
26.             @Override
27.             public void onResponse(Call call, Response response) throws IOException {
28.                 if (response.isSuccessful()) {
29.                     // 请求成功时，处理响应数据
30.                     String result = response.body().string();
31.                     // 在此处处理返回的结果，更新 UI（需要在主线程中进行）
32.                 } else {
33.                     // 请求失败时，处理失败的情况
34.                     System.out.println("Request failed with code: " + response.code());
35.                 }
36.             }
37.         });
38.     }
39. }

复制代码

异步请求的关键点：

• client.newCall(request).enqueue(new Callback() {...})：异步请求的方法。
  
• onFailure()：请求失败时的回调方法。
  
• onResponse()：请求乐成时的回调方法，响应数据会传递到此。
  

   注意： 由于 onResponse() 方法是在背景线程中执行的，任何 UI 更新操作必要通过 runOnUiThread() 或其他线程间通信机制来确保在主线程中执行。
  5. 处理请求头

如果你必要在请求中设置请求头（例如设置身份验证的 Token），可以通过 Request.Builder 设置请求头。

1. Request request = new Request.Builder()
2.         .url("https://jsonplaceholder.typicode.com/posts")
3.         .header("Authorization", "Bearer your_token_here")  // 设置请求头
4.         .build();

复制代码

6. 连接池与缓存

OkHttp 默认提供了连接池和缓存机制，可以有效地提高网络请求的效率。你可以通过自界说 OkHttpClient 来配置连接池、缓存和其他高级功能。
示例：配置缓存

1. import okhttp3.Cache;
2. import okhttp3.OkHttpClient;
3. import java.io.File;
5. File cacheDir = new File(getCacheDir(), "http_cache");
6. Cache cache = new Cache(cacheDir, 10 * 1024 * 1024); // 10MB 的缓存
8. OkHttpClient client = new OkHttpClient.Builder()
9.         .cache(cache)
10.         .build();

复制代码

总结

• 同步请求：使用 client.newCall(request).execute()，可以直接获取响应内容，但它会阻塞当前线程，不适合在 UI 线程中执行。
  
• 异步请求：使用 client.newCall(request).enqueue(callback)，通过回调来处理响应数据，适合在 UI 线程中执行，避免阻塞 UI。
  
• POST 请求：可以通过 RequestBody 创建请求体，并通过 request.post(body) 来发送。
  
• 请求头：可以通过 Request.Builder().header() 设置自界说请求头。
  

OkHttp 是一个功能强大且易于使用的 HTTP 客户端，适用于大多数 Android 项目标网络请求。对于复杂的请求场景，保举使用 OkHttp。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。