OkHttp使用和源码分析学习(一)

使用

介绍

OkHttp 是一个高效的 HTTP 客户端，适用于 Android 和 Java 应用程序。它由 Square 公司开发，旨在简化网络请求的处理，并提供强大的功能，如连接池、GZIP 压缩、缓存、HTTP/2 支持等。
github地址：https://github.com/square/okhttp

核心特性

• HTTP/2 支持：允许同一主机的请求共享一个 socket。
• 连接池：减少请求延迟（如果 HTTP/2 不可用）。
• 透明的 GZIP 压缩：自动压缩请求体，减少传输数据量。
• 响应缓存：避免重复请求网络。
• 同步和异步调用：支持同步阻塞调用和异步回调调用。
• WebSocket 支持：支持全双工通信。

核心组件

• OkHttpClient：HTTP 客户端，用于发送请求和接收响应。通常设计为单例。
• Request：表示 HTTP 请求，包含 URL、方法、请求头、请求体等信息。
• Response：表示 HTTP 响应，包含状态码、响应头、响应体等信息。
• Call：表示一个已准备好执行的请求，可以同步或异步执行。
• Interceptor：拦截器，用于在请求和响应之间添加自定义逻辑（如日志、重试、缓存等）。

基本用法

步骤

1. 添加依赖
   在项目中引入 OkHttp 的依赖。如果你使用的是 Gradle，可以在 build.gradle 文件中添加以下依赖

implementation 'com.squareup.okhttp3:okhttp:4.9.3'

2. 创建 OkHttpClient 实例
   OkHttpClient 是 OkHttp 的核心类，用于发送 HTTP 请求和接收响应。通常将其设计为单例模式，以避免重复创建连接池和线程池。

3. 构建 Request 对象
   使用 Request.Builder 构建 HTTP 请求，设置 URL、请求方法（GET、POST 等）、请求头、请求体等。

4. 发送请求

   • 同步请求：使用 execute() 方法，阻塞当前线程直到收到响应。
   • 异步请求：使用 enqueue() 方法，在后台线程中执行请求，并通过回调处理响应。

5. 处理响应
   解析响应数据，检查状态码，获取响应体等。

同步 GET 请求

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;

public class SyncGetExample {
   
   
    public static void main(String[] args) throws Exception {
   
   
        // 创建 OkHttpClient 实例
        OkHttpClient client = new OkHttpClient();

        // 构建 Request 对象
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();

        // 发送同步请求
        try (Response response = client.newCall(request).execute()) {
   
   
            // 检查请求是否成功
            if (!response.isSuccessful()) {
   
   
                throw new IOException("请求失败，状态码: " + response.code());
            }

            // 获取响应体并打印
            System.out.println(response.body().string());
        }
    }
}

异步 GET 请求

import okhttp3.Call;
import okhttp3.Callback;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class AsyncGetExample {
   
   
    public static void main(String[] args) {
   
   
        // 创建 OkHttpClient 实例
        OkHttpClient client = new OkHttpClient();

        // 构建 Request 对象
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();

        // 发送异步请求
        client.newCall(request).enqueue(new Callback() {
   
   
            @Override
            public void onFailure(Call call, IOException e) {
   
   
                // 请求失败处理
                e.printStackTrace();
            }

            @Override
            public void onResponse(Call call, Response response) throws IOException {
   
   
                // 请求成功处理
                if (!response.isSuccessful()) {
   
   
                    throw new IOException("请求失败，状态码: " + response.code());
                }

                // 获取响应体并打印
                System.out.println(response.body().string());
            }
        });
    }
}

POST 请求（提交表单）

import okhttp3.FormBody;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;

public class PostFormExample {
   
   
    public static void main(String[] args) throws Exception {
   
   
        // 创建 OkHttpClient 实例
        OkHttpClient client = new OkHttpClient();

        // 构建表单请求体
        RequestBody formBody = new FormBody.Builder()
                .add("username", "testuser")
                .add("password", "testpassword")
                .build();

        // 构建 Request 对象
        Request request = new Request.Builder()
                .url("https://example.com/login")
                .post(formBody)
                .build();

        // 发送同步请求
        try (Response response = client.newCall(request).execute()) {
   
   
            if