JAVA帮助

OkHttp Java：简化 HTTP 请求

发布 2024年七月1日

在现代 Java 开发中，有效处理 HTTP 请求对于构建强大的应用程序，尤其是依赖网络服务和 API 的应用程序至关重要。OkHttp 是一款功能强大的 HTTP 和 HTTP/2 客户端，适用于 Java 和 Kotlin，因其性能、易用性和先进功能而广受欢迎。

本文提供了一份全面的 OkHttp 指南，涵盖其主要功能、安装和常见用例。

什么是 OkHttp？

OkHttp 是一个用于处理 HTTP 请求的通用开源 Java 库，它提供了一套全面的功能，可无缝集成到您的应用程序中。利用直观的 API，创建新请求或执行简单的 POST 请求就像配置一个带有查询参数和字符串 URL 的新请求生成器一样简单。

此外，OkHttp 还有助于高效处理响应，提供对响应正文和响应标头的访问，甚至支持响应缓存，以优化网络流量并减少服务器可用性问题。无论是同步调用还是异步调用，OkHttp 的连接池都能确保最佳性能，即使在处理多个 IP 地址时也是如此。

OkHttp Java（如何为开发人员工作）：图 1

对于习惯于使用 Apache HTTP 客户端的开发人员来说，OkHttp 提供了一个更现代、更高效的替代方案，而且性能和灵活性都有所提高。对于要求响应速度和可扩展性的应用程序来说，支持异步调用和回调使其成为首选。

有了 OkHttp，管理众多 HTTP 客户端和请求变得毫不费力，开发人员可以专注于构建稳健可靠的应用程序，而不会影响性能或功能。

主要功能

OkHttp 的主要功能包括

同步和异步请求处理：OkHttp 允许同步(阻塞)和异步(非阻塞)业务。
连接池：重复使用 HTTP 连接，最大限度地减少客户端连接问题并提高性能。
透明 GZIP 压缩：减少 HTTP 响应的大小，节省带宽并加快数据传输。
缓存：支持响应缓存，减少重复网络请求。
支持 HTTP/2**：允许在单个连接上多路复用多个请求和响应，从而提高性能。
超时和重试：提供对连接和读取超时的精细控制，以及对失败请求的重试机制。

安装 OkHttp

要开始在 Java 项目中使用 OkHttp，您需要在构建配置中加入其依赖关系。如果您使用 Maven，请在您的 pom.xml 文件中添加以下依赖关系：

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>5.0.0-alpha.14</version>
</dependency>

<dependency>
    <groupId>com.squareup.okhttp3</groupId>
    <artifactId>okhttp</artifactId>
    <version>5.0.0-alpha.14</version>
</dependency>

XML

对于 Gradle，请在build.gradle文件中添加此行：

implementation 'com.squareup.okhttp3:okhttp:5.0.0-alpha.14'

请确保在 Maven Central 或 GitHub 上查看最新版本。

基本用法

创建 OkHttpClient

OkHttpClient "类是执行 HTTP 请求的主要入口。建议创建一个 OkHttpClient 实例并在整个应用程序中重复使用，以利用连接池的优势。

import okhttp3.OkHttpClient;
OkHttpClient client = new OkHttpClient();

import okhttp3.OkHttpClient;
OkHttpClient client = new OkHttpClient();

JAVA

提出 GET 请求

要进行简单的 GET 请求，您需要创建一个 Request 对象，并使用 OkHttpClient 执行该请求。

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

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

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

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JAVA

OkHttp Java（如何为开发人员工作）：图 2

提出 POST 请求

对于 POST 请求，您需要包含请求正文和返回响应。 OkHttp 提供了 RequestBody 类来处理这个问题。

import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
import java.io.IOException;

public class OkHttpExample {
    public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        String json = "{\"title\":\"foo\",\"body\":\"bar\",\"userId\":1}";
        RequestBody body = RequestBody.create(json, JSON);
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts")
                .post(body)
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

import okhttp3.MediaType;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.Response;
import java.io.IOException;

public class OkHttpExample {
    public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");

    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        String json = "{\"title\":\"foo\",\"body\":\"bar\",\"userId\":1}";
        RequestBody body = RequestBody.create(json, JSON);
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts")
                .post(body)
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JAVA

OkHttp Java（如何为开发人员工作）：图 3

异步请求

异步请求使用回调处理，允许您的应用程序在等待响应时保持响应。

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

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        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()) {
                    System.out.println(response.body().string());
                } else {
                    System.err.println("Request failed: " + response.code());
                }
            }
        });
    }
}

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

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient();
        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()) {
                    System.out.println(response.body().string());
                } else {
                    System.err.println("Request failed: " + response.code());
                }
            }
        });
    }
}

JAVA

高级功能

拦截器

拦截器是一项强大的功能，可以检查、修改或重试请求和响应。这些工具可用于记录日志、添加标头或处理身份验证。

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(new Interceptor() {
                    @Override
                    public Response intercept(Chain chain) throws IOException {
                        Request request = chain.request().newBuilder()
                                .addHeader("Authorization", "Bearer your_token_here")
                                .build();
                        return chain.proceed(request);
                    }
                })
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

import okhttp3.Interceptor;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient.Builder()
                .addInterceptor(new Interceptor() {
                    @Override
                    public Response intercept(Chain chain) throws IOException {
                        Request request = chain.request().newBuilder()
                                .addHeader("Authorization", "Bearer your_token_here")
                                .build();
                        return chain.proceed(request);
                    }
                })
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JAVA

处理超时

OkHttp 提供了为 HTTP 请求本身的不同阶段设置超时的方法。

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .writeTimeout(10, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
import java.util.concurrent.TimeUnit;

public class OkHttpExample {
    public static void main(String[] args) {
        OkHttpClient client = new OkHttpClient.Builder()
                .connectTimeout(10, TimeUnit.SECONDS)
                .writeTimeout(10, TimeUnit.SECONDS)
                .readTimeout(30, TimeUnit.SECONDS)
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JAVA

缓存响应

OkHttp 可以缓存响应，以减少请求延迟并提高性能。这需要设置缓存目录和大小。

import okhttp3.Cache;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.File;
import java.io.IOException;

public class OkHttpExample {
    public static void main(String[] args) {
        File cacheDirectory = new File("cacheDirectory");
        Cache cache = new Cache(cacheDirectory, 10 * 1024 * 1024); // 10 MB cache
        OkHttpClient client = new OkHttpClient.Builder()
                .cache(cache)
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

import okhttp3.Cache;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.File;
import java.io.IOException;

public class OkHttpExample {
    public static void main(String[] args) {
        File cacheDirectory = new File("cacheDirectory");
        Cache cache = new Cache(cacheDirectory, 10 * 1024 * 1024); // 10 MB cache
        OkHttpClient client = new OkHttpClient.Builder()
                .cache(cache)
                .build();
        Request request = new Request.Builder()
                .url("https://jsonplaceholder.typicode.com/posts/1")
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful()) {
                System.out.println(response.body().string());
            } else {
                System.err.println("Request failed: " + response.code());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

JAVA

在 Java 中将 OkHttp 与 IronPDF 集成

结合 OkHttp 和 IronPDF 的功能，Java 开发人员可以从网络上获取数据并将其转换为 PDF。 OkHttp 是一个强大的 HTTP 客户端，用于处理网络请求，而 IronPDF 则是一个功能强大的库，用于从各种来源生成 PDF。

IronPDF - 概述

IronPDF for Java 是一个综合库，旨在简化 Java 应用程序中的 PDF 生成。利用其直观的 API，开发人员可以毫不费力地从各种数据源（包括 HTML、图像和文本）创建、处理和渲染 PDF 文档。

IronPDF 支持 PDF 加密、数字签名和交互式表格填写等高级功能，使开发人员能够根据自己的具体要求制作专业级 PDF。其无缝集成和丰富的文档使其成为 Java 开发人员的首选解决方案，他们希望通过强大的 PDF 生成功能来增强自己的应用程序。

OkHttp Java（如何为开发人员工作）：图 4

设置依赖关系

首先，在您的 pom.xml 中添加必要的依赖项(用于 Maven)xml 文件或 `build.gradle(用于 Gradle)锉刀

Maven

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>2024.3.1</version>
</dependency>

<dependency>
    <groupId>com.ironsoftware</groupId>
    <artifactId>ironpdf</artifactId>
    <version>2024.3.1</version>
</dependency>

XML

Gradle

implementation 'com.ironsoftware:ironpdf:2024.3.1'

整合 OkHttp 和 IronPDF

现在，让我们将这两项功能结合起来：用 OkHttp 获取 HTML 内容，用 IronPDF 生成 PDF。

import com.ironsoftware.ironpdf.PdfDocument;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
import java.nio.file.Paths;

public class OkHttpToPdf {
    private final OkHttpClient client = new OkHttpClient();

    public String fetchHtml(String url) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
            return response.body().string();
        }
    }

    public void generatePdfFromUrl(String url, String outputFilePath) {
        try {
            String htmlContent = fetchHtml(url);
            PdfDocument pdf = PdfDocument.renderHtmlAsPdf(htmlContent);
            pdf.saveAs(Paths.get(outputFilePath));
            System.out.println("PDF generated successfully at " + outputFilePath);
        } catch (IOException e) {
            System.err.println("Failed to fetch HTML content: " + e.getMessage());
        } catch (Exception e) {
            System.err.println("Failed to generate PDF: " + e.getMessage());
        }
    }

    public static void main(String[] args) {
        OkHttpToPdf converter = new OkHttpToPdf();
        converter.generatePdfFromUrl("https://ironpdf.com/java", "website.pdf");
    }
}

import com.ironsoftware.ironpdf.PdfDocument;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
import java.nio.file.Paths;

public class OkHttpToPdf {
    private final OkHttpClient client = new OkHttpClient();

    public String fetchHtml(String url) throws IOException {
        Request request = new Request.Builder()
                .url(url)
                .build();
        try (Response response = client.newCall(request).execute()) {
            if (!response.isSuccessful()) throw new IOException("Unexpected code " + response);
            return response.body().string();
        }
    }

    public void generatePdfFromUrl(String url, String outputFilePath) {
        try {
            String htmlContent = fetchHtml(url);
            PdfDocument pdf = PdfDocument.renderHtmlAsPdf(htmlContent);
            pdf.saveAs(Paths.get(outputFilePath));
            System.out.println("PDF generated successfully at " + outputFilePath);
        } catch (IOException e) {
            System.err.println("Failed to fetch HTML content: " + e.getMessage());
        } catch (Exception e) {
            System.err.println("Failed to generate PDF: " + e.getMessage());
        }
    }

    public static void main(String[] args) {
        OkHttpToPdf converter = new OkHttpToPdf();
        converter.generatePdfFromUrl("https://ironpdf.com/java", "website.pdf");
    }
}

JAVA

代码解释

上面的代码演示了如何使用 Java 中的 OkHttp 和 IronPDF 库从 URL 获取 HTML 内容并将其转换为 PDF 文件：

导入声明：导入了必要的库，包括用于生成 PDF 的 IronPdf 和用于 HTTP 请求的 OkHttp。
OkHttpClient 初始化：创建一个 OkHttpClient 实例。
fetchHtml方法：该方法从指定的 URL 抓取 HTML 内容。
- 使用所提供的 URL 生成请求。
- 执行请求并获得响应。
- 如果响应不成功，则会抛出一个 IOException 异常。
- 响应体以字符串形式返回。
生成 PDFFromUrl` 方法：该方法根据指定 URL 的 HTML 内容生成 PDF，并将其保存到给定的文件路径。
- 使用 fetchHtml 方法获取 HTML 内容。
- HTML 内容使用 IronPDF 呈现为 PDF。
- PDF 将保存到指定的文件路径。
- 在获取 HTML 和生成 PDF 时都包含适当的错误处理。
main 方法：这是程序的入口。
- 创建一个 OkHttpToPdf 实例。
- 使用特定的 URL 和输出文件路径调用 generatePdfFromUrl 方法。

输出

使用 OkHttp 客户端获取 URL 数据，然后使用 IronPDF 高效渲染，将其转换为 PDF，如下图所示：

OkHttp Java（如何为开发人员工作）：图 5

有关 IronPDF 的更多详细信息，请访问此网站IronPDF文档page. 还请查看以下内容IronPDF代码示例和IronPDF API 参考资料进一步使用 IronPDF。

结论

OkHttp 是一款适用于 Java 和 Android 的多功能、功能强大的 HTTP 客户端，可简化网络请求过程。 OkHttp 客户端支持同步和异步操作、连接池、透明 GZIP 压缩、缓存和 HTTP/2，非常适合各种使用情况。通过将 OkHttp 集成到您的 Java 应用程序中，您可以提高它们的性能、可靠性和效率。

通过将 OkHttp 与 IronPDF 集成，您可以高效地从 Web 源获取 HTML 内容并将其转换为 PDF 文档。这种方法尤其适用于需要生成报告、保存网页或将网页内容转换为离线文档的应用程序。

利用 IronPDF for Java 在您的 Java 应用程序中释放生成 PDF 的潜力免费试用此外，译文还必须能够将专业级 PDF 生成无缝集成到您的项目中。立即下载，提升您的 PDF 生成体验!

< 前一页
Apache Commons IO：Java I/O 实用工具

下一步 >
Java 版 Gson：将对象转换为 JSON

在此页面上

什么是 OkHttp？
- 主要功能
安装 OkHttp
基本用法
高级功能
在 Java 中将 OkHttp 与 IronPDF 集成
- IronPDF - 概述
- 设置依赖关系
整合 OkHttp 和 IronPDF
结论

通过Maven安装

版本：2024.11.4

<dependency>
  <groupId>com.ironsoftware</groupId>
  <artifactId>ironpdf</artifactId>
  <version>2024.11.4</version>
</dependency>

报告问题

加入我们的Iron Swag漏洞赏金计划

准备开始了吗？版本： 2024.11 刚刚发布

查看许可证 >

OkHttp Java：简化 HTTP 请求

什么是 OkHttp？

主要功能

安装 OkHttp

基本用法

创建 OkHttpClient

提出 GET 请求

提出 POST 请求

异步请求

高级功能

拦截器

处理超时

缓存响应

在 Java 中将 OkHttp 与 IronPDF 集成

IronPDF - 概述

设置依赖关系

Maven

Gradle

整合 OkHttp 和 IronPDF

代码解释

输出

结论

在此页面上

报告问题

准备开始了吗？版本： 2024.11 刚刚发布

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 0天试用密钥立即。

试用表格已提交
成功地.

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 0天试用密钥立即。

受到全球数百万工程师的信任

IronPDF 是 IRON 的一部分套装

OkHttp Java：简化 HTTP 请求

什么是 OkHttp？

主要功能

安装 OkHttp

基本用法

创建 OkHttpClient

提出 GET 请求

提出 POST 请求

异步请求

高级功能

拦截器

处理超时

缓存响应

在 Java 中将 OkHttp 与 IronPDF 集成

IronPDF - 概述

设置依赖关系

Maven

Gradle

整合 OkHttp 和 IronPDF

代码解释

输出

结论

在此页面上

报告问题

准备开始了吗？ 版本： 2024.11 刚刚发布

试用表格已提交成功地.

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 0天试用密钥 立即。

试用表格已提交成功地.

受到全球数百万工程师的信任

在实际环境中测试

全面功能产品

24/5 技术支持

获取您的免费 0天试用密钥 立即。

受到全球数百万工程师的信任

IronPDF 是 IRON 的一部分套装

准备开始了吗？版本： 2024.11 刚刚发布

试用表格已提交
成功地.

获取您的免费 0天试用密钥立即。

试用表格已提交
成功地.

获取您的免费 0天试用密钥立即。