JAVA 幫助

OkHttp Java：簡化 HTTP 請求

發佈 2024年7月1日

在現代 Java 開發中，有效處理 HTTP 請求對於構建健壯的應用程序至關重要，特別是那些依賴於 Web 服務和 API 的應用程序。OkHttp 是一個強大的 Java 和 Kotlin HTTP & HTTP/2 客戶端，由於其性能、易用性和先進功能而成為流行的選擇。

本文提供了有關OkHttp的全面指南，涵蓋其主要功能、安裝和常見用例。

什麼是OkHttp？

OkHttp 是一個多功能的開源 Java 庫，用於處理 HTTP 請求，並提供了一套完整的功能集，以便無縫地整合到您的應用程式中。透過其直觀的 API，創建新請求或執行簡單的 POST 請求就像配置具有查詢參數和字串 URL 的新請求生成器一樣簡單。

此外，OkHttp 加強了回應處理的效率，提供對回應主體、回應標頭的存取，甚至支援回應快取，以優化網路流量和減少伺服器可用性問題。無論是進行同步還是非同步調用，OkHttp的連接池技術確保了最佳性能，即使在處理多個IP地址時也是如此。

OkHttp Java（對開發者的運作方式）：圖 1

對習慣使用 Apache HTTP Client 的開發者來說，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

程式碼說明

上面的程式碼展示了如何使用 OkHttp 和 IronPDF 庫在 Java 中從 URL 獲取 HTML 內容並將其轉換為 PDF 文件：

導入語句：引入必要的庫，包括用於生成PDF的IronPDF和用於HTTP請求的OkHttp。
OkHttpClient 初始化：創建了一個 OkHttpClient 的實例。
fetchHtml 方法：此方法從指定的 URL 獲取 HTML 內容。
- 請求是使用提供的URL構建的。
- 請求已執行並取得回應。
- 如果響應不成功，則拋出 IOException。
- 回應內容作為字串返回。
generatePdfFromUrl 方法：此方法將指定 URL 的 HTML 內容生成 PDF 並保存到指定的文件路徑。
- HTML 內容是使用 fetchHtml 方法提取的。
- HTML內容使用 IronPDF 轉換為 PDF。
- PDF 已儲存到指定的檔案路徑。
- 已包含適當的錯誤處理，以應對 HTML 獲取和 PDF 生成。
main 方法：這是程式的入口點。
- 創建了一個 OkHttpToPdf 實例。
- generatePdfFromUrl 方法會使用特定的 URL 和輸出檔案路徑進行呼叫。

輸出

使用 OkHttp 客戶端抓取 URL 資料，然後使用 IronPDF 高效地將其渲染並轉換為 PDF，如下所示：

OkHttp Java（開發人員如何運作）：圖5

如需有關IronPDF的詳細資訊，請造訪此IronPDF 文件檔案頁面。請您也檢查這個IronPDF 程式碼範例和IronPDF API 參考文件頁面以進一步利用IronPDF。

結論

OkHttp 是一個多功能且強大的 Java 和 Android HTTP 客戶端，可以簡化進行網路請求的過程。由於支援同步和非同步操作、連線池、透明 GZIP 壓縮、快取和 HTTP/2，OkHttp 客戶端非常適合廣泛的使用情境。通過將OkHttp整合到您的Java應用中，您可以提升其性能、可靠性和效率。

通過將 OkHttp 與 IronPDF 集成，您可以有效地從網絡來源獲取 HTML 內容並將其轉換為 PDF 文檔。這種方法特別適用於需要生成報告、保存網頁或將網頁內容轉換為離線文件的應用程序。

在您的 Java 應用程序中，通過 IronPDF 解鎖 PDF 生成的潛力。免費試用，實現專業級 PDF 生成與您的項目無縫整合。立即下載，提升您的 PDF 生成體驗!

< 上一頁
Apache Commons IO：Java I/O 工具

下一個 >
Gson for Java：將物件轉換為 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天試用序號立即。