.NET 幫助

WebClient C#（它對開發人員的工作原理）

發佈 2024年6月6日

WebClient是一個強大的 C# 類別，專為透過網路發送和接收資料而設計。它是 .NET Framework System.Net 命名空间的一部分，適用於各種應用程序，從簡單的文件下載到將數據發送到網絡伺服器。

本教程介紹如何有效使用 WebClient 類，專注於其核心功能以及如何處理下載文件和發布數據等常見場景。我們也將探索IronPDF 庫在使用 WebClient 的上下文中。

WebClient 的基本使用

創建一個新的 WebClient

要開始使用 WebClient，您需要創建其實例。此實例作為您進行 HTTP 請求的入口。

這是一個初始化 WebClient 的簡單方法：

WebClient client = new WebClient();

WebClient client = new WebClient();

Dim client As New WebClient()

VB C#

這個 new WebClient() 是基本設置。它準備您的應用程序與 HTTP 伺服器互動。透過創建此實例，您可以使用 WebClient 類提供的多種方法來下載和上傳數據。

設置 WebClient 屬性

在您開始發送請求之前，您可能需要自訂 WebClient 實例的行為。例如，您可以設置一個使用者代理標頭，以告知伺服器正在發出請求的客戶端：

// Adding user-agent to the HTTP headers
client.Headers["User-Agent"] = "Mozilla/5.0 (Windows NT 10.0; Win64; x64)";

// Adding user-agent to the HTTP headers
client.Headers["User-Agent"] = "Mozilla/5.0 (Windows NT 10.0; Win64; x64)";

' Adding user-agent to the HTTP headers
client.Headers("User-Agent") = "Mozilla/5.0 (Windows NT 10.0; Win64; x64)"

VB C#

設定用戶代理標頭很重要，因為有些伺服器會檢查這個標頭以判斷請求是否來自已知的瀏覽器或設備。這可能會影響伺服器對您的請求的回應方式。

使用 WebClient 下載資料

簡單檔案下載

WebClient 提供了一個簡單的方法，可以直接從 URL 下載文件到本地文件。這對於需要與外部資源配合操作的應用程式非常有用，比如下載配置文件或更新。

// Download file from the specified URI address
string address = "http://example.com/file.zip";
string localFile = "C:\\Downloads\\file.zip";
try
{
    client.DownloadFile(address, localFile);
    Console.WriteLine("Download complete.");
}
catch (Exception ex)
{
    Console.WriteLine("Download failed: " + ex.Message);
}

// Download file from the specified URI address
string address = "http://example.com/file.zip";
string localFile = "C:\\Downloads\\file.zip";
try
{
    client.DownloadFile(address, localFile);
    Console.WriteLine("Download complete.");
}
catch (Exception ex)
{
    Console.WriteLine("Download failed: " + ex.Message);
}

' Download file from the specified URI address
Dim address As String = "http://example.com/file.zip"
Dim localFile As String = "C:\Downloads\file.zip"
Try
	client.DownloadFile(address, localFile)
	Console.WriteLine("Download complete.")
Catch ex As Exception
	Console.WriteLine("Download failed: " & ex.Message)
End Try

VB C#

在此範例中，DownloadFile 用於從 字串位址 擷取文件，並將其儲存為本地文件。此過程包裹在 try-catch 區塊中，以處理任何潛在的錯誤，例如內部伺服器錯誤或連接問題。

在記憶體中處理下載數據

有時候，你可能想要直接在記憶體中處理下載的數據，而不將其保存到磁碟。這可以使用 DownloadData 方法完成，該方法返回一個位元組陣列：

string uriAddress = "http://example.com/data.json";
try
{
    byte[] data = client.DownloadData(uriAddress);
    string json = System.Text.Encoding.UTF8.GetString(data);
    Console.WriteLine("Data received: " + json);
}
catch (Exception ex)
{
    Console.WriteLine("Error receiving data: " + ex.Message);
}

string uriAddress = "http://example.com/data.json";
try
{
    byte[] data = client.DownloadData(uriAddress);
    string json = System.Text.Encoding.UTF8.GetString(data);
    Console.WriteLine("Data received: " + json);
}
catch (Exception ex)
{
    Console.WriteLine("Error receiving data: " + ex.Message);
}

Dim uriAddress As String = "http://example.com/data.json"
Try
	Dim data() As Byte = client.DownloadData(uriAddress)
	Dim json As String = System.Text.Encoding.UTF8.GetString(data)
	Console.WriteLine("Data received: " & json)
Catch ex As Exception
	Console.WriteLine("Error receiving data: " & ex.Message)
End Try

VB C#

此處，來自 uriAddress 的數據被下載到一個位元組陣列中。然後假設數據為 JSON 格式，將其轉換為字串。在處理以 JSON 格式返回的 API 資料時，將資料保存在記憶體中特別有用。

使用WebClient上傳資料

將資料發送到伺服器

WebClient 也可以用來將資料發送到伺服器。這通常是使用 HTTP POST 方法來完成的，您將資料作為請求正文的一部分發送。

string postAddress = "http://example.com/api/post";
// Prepare string data for POST request
string stringData = "name=John&age=30";
byte[] postData = System.Text.Encoding.ASCII.GetBytes(stringData);
try
{
    byte[] response = client.UploadData(postAddress, "POST", postData);
    // Log response headers and content
    Console.WriteLine("Response received: " + System.Text.Encoding.ASCII.GetString(response));
}
catch (Exception ex)
{
    Console.WriteLine("Post failed: " + ex.Message);
}

string postAddress = "http://example.com/api/post";
// Prepare string data for POST request
string stringData = "name=John&age=30";
byte[] postData = System.Text.Encoding.ASCII.GetBytes(stringData);
try
{
    byte[] response = client.UploadData(postAddress, "POST", postData);
    // Log response headers and content
    Console.WriteLine("Response received: " + System.Text.Encoding.ASCII.GetString(response));
}
catch (Exception ex)
{
    Console.WriteLine("Post failed: " + ex.Message);
}

Dim postAddress As String = "http://example.com/api/post"
' Prepare string data for POST request
Dim stringData As String = "name=John&age=30"
Dim postData() As Byte = System.Text.Encoding.ASCII.GetBytes(stringData)
Try
	Dim response() As Byte = client.UploadData(postAddress, "POST", postData)
	' Log response headers and content
	Console.WriteLine("Response received: " & System.Text.Encoding.ASCII.GetString(response))
Catch ex As Exception
	Console.WriteLine("Post failed: " & ex.Message)
End Try

VB C#

此代碼片段將 postData 發送到伺服器。在發送之前，數據首先被編碼為字節陣列。 WebClient 會自動處理位元組陣列資料的內容類型標頭，但如果您需要以不同的格式（例如 JSON）發送資料，則可能需要手動設定內容類型標頭。

IronPDF 與 WebClient

IronPDF是一個 .NET 程式庫，幫助開發人員輕鬆創建、編輯和管理 PDF 文件。它使用 Chrome 渲染引擎以獲得精確的HTML 轉換為 PDF. 該函式庫允許將網頁內容、HTML 和圖像轉換為 PDF，並包括數位簽名和表單處理等功能。

它適用於各種 .NET 版本，並支援多個操作系統，使其在不同的開發環境中具有多功能性。 IronPDF 提供全面的文檔和強大的支援，以協助開發人員順利整合 PDF 功能。

範例程式碼

以下是使用 IronPDF 和 C# 将 HTML 内容转换为 PDF 的基本示例，使用 WebClient 类。此範例程式碼展示了如何從 URL 獲取 HTML，然後使用 IronPDF 從該 HTML 生成 PDF 文件。

using IronPdf;
using System.Net;
class Program
{
    static void Main()
    {
        License.LicenseKey = "License-Key";
        // Create a new WebClient instance to download HTML
        using (WebClient client = new WebClient())
        {
            // Specify the URL of the HTML page
            string url = "http://example.com";
            string htmlString = client.DownloadString(url);
            // Create a new HTML to PDF converter instance
            var renderer = new ChromePdfRenderer();
            // Convert HTML string to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlString);
            // Save the PDF to a file
            pdf.SaveAs("output.pdf");
        }
    }
}

using IronPdf;
using System.Net;
class Program
{
    static void Main()
    {
        License.LicenseKey = "License-Key";
        // Create a new WebClient instance to download HTML
        using (WebClient client = new WebClient())
        {
            // Specify the URL of the HTML page
            string url = "http://example.com";
            string htmlString = client.DownloadString(url);
            // Create a new HTML to PDF converter instance
            var renderer = new ChromePdfRenderer();
            // Convert HTML string to PDF
            var pdf = renderer.RenderHtmlAsPdf(htmlString);
            // Save the PDF to a file
            pdf.SaveAs("output.pdf");
        }
    }
}

Imports IronPdf
Imports System.Net
Friend Class Program
	Shared Sub Main()
		License.LicenseKey = "License-Key"
		' Create a new WebClient instance to download HTML
		Using client As New WebClient()
			' Specify the URL of the HTML page
			Dim url As String = "http://example.com"
			Dim htmlString As String = client.DownloadString(url)
			' Create a new HTML to PDF converter instance
			Dim renderer = New ChromePdfRenderer()
			' Convert HTML string to PDF
			Dim pdf = renderer.RenderHtmlAsPdf(htmlString)
			' Save the PDF to a file
			pdf.SaveAs("output.pdf")
		End Using
	End Sub
End Class

VB C#

確保將 IronPDF 函式庫添加到您的項目中。在您的開發環境中，通常可以通過 NuGet 使用如下命令來完成：