.NET 帮助

WebClient C#（开发者如何使用）

发布 2024年六月6日

网络客户端是 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#

这个新的 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），则可能需要手动设置内容类型标头。

带 WebClient 的 IronPDF

IronPDFPDF 是一个 .NET 库，可帮助开发人员轻松创建、编辑和管理 PDF 文件。它使用 Chrome 渲染引擎来实现精确的HTML 转换为 PDF. 该库可将网页内容、HTML 和图像转换为 PDF，并包含数字签名和表单处理等功能。

它可与各种 .NET 版本一起使用，并支持多种操作系统，因此适用于不同的开发环境。 IronPDF 提供全面的文档和强大的支持，帮助开发人员顺利集成 PDF 功能。

代码示例

下面是一个使用 IronPDF 与 C# 的基本示例，使用 WebClient 类将 HTML 内容转换为 PDF。本示例代码演示了如何从 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 进行翻译，使用类似以下的命令：