C# Using(開發者的工作原理)
即使您剛開始使用C#,您可能已經遇到過using指令。如果您是IronPDF的使用者,您將非常熟悉以名稱空間using ironpdf開始您的程式碼。
然而,using關鍵詞還有另外一個用途。 在本指南中,我們將探討using語句——它是什麼,如何運作,以及如何幫助您建立更高效的程式碼。 一起深入了解吧!
C#中的Using是什麼?
C#中的using語句是一種便利的方法,用於操作實現IDisposable介面的資源。 IDisposable物件通常會持有如文件句柄或網路連接等未管控的資源,這些資源需要在使用完成後釋放。 這正是使用using語句的原因——它幫助您確保這些資源在使用後被正確地處理掉。
Using語句如何運作
使用using語句時,C#會在物件不再需要時,自動調用物件的Dispose方法。 這意味著您不需要手動調用Dispose方法,也不需要擔心會忘記這麼做。 using語句會為您處理這一切!
讓我們看看一個簡單的例子來看看using語句如何運作:
using System;
using System.IO;
class Program
{
static void Main()
{
// Using a using statement to ensure StreamReader is disposed of
using (StreamReader reader = new StreamReader("example.txt"))
{
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
}
}Imports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Using a using statement to ensure StreamReader is disposed of
Using reader As New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Using
End Sub
End ClassImports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Using a using statement to ensure StreamReader is disposed of
Using reader As New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Using
End Sub
End Class在這個例子中,名為reader的StreamReader物件被包裝在一個using區塊中。 當using區塊退出時,會自動調用reader的Dispose方法,釋放它所持有的任何資源。
Using區塊 vs. Using宣告
從C# 8.0開始,您可以使用using宣告代替using區塊。 using宣告是一種更短且更簡潔的方式來定義可釋放的物件,例如:
using System;
using System.IO;
class Program
{
static void Main()
{
// Using the using declaration simplifies the code
using var reader = new StreamReader("example.txt");
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
}using System;
using System.IO;
class Program
{
static void Main()
{
// Using the using declaration simplifies the code
using var reader = new StreamReader("example.txt");
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
}Imports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Using the using declaration simplifies the code
Dim reader = New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Sub
End ClassImports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Using the using declaration simplifies the code
Dim reader = New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Sub
End Class使用using宣告時,您不需要大括號或縮排,使您的程式碼更易讀。 當變數超出範圍時,Dispose方法仍然會被自動調用。
Try區塊,Finally區塊,以及Using語句
您可能會想知道using語句與C#中的try和finally區塊之間的關係。 事實上,using語句實際上是try-finally區塊的簡寫!
以下是之前相同的例子,但使用try-finally區塊而不是using語句來編寫:
using System;
using System.IO;
class Program
{
static void Main()
{
StreamReader reader = null;
try
{
reader = new StreamReader("example.txt");
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
finally
{
if (reader != null)
{
reader.Dispose();
}
}
}
}using System;
using System.IO;
class Program
{
static void Main()
{
StreamReader reader = null;
try
{
reader = new StreamReader("example.txt");
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
finally
{
if (reader != null)
{
reader.Dispose();
}
}
}
}Imports System
Imports System.IO
Module Program
Sub Main()
Dim reader As StreamReader = Nothing
Try
reader = New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
Finally
If reader IsNot Nothing Then
reader.Dispose()
End If
End Try
End Sub
End ModuleImports System
Imports System.IO
Module Program
Sub Main()
Dim reader As StreamReader = Nothing
Try
reader = New StreamReader("example.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
Finally
If reader IsNot Nothing Then
reader.Dispose()
End If
End Try
End Sub
End Module正如您所見,using語句通過去除try-finally區塊和顯式調用Dispose方法的需求,使程式碼更清晰、更易讀。
管理多個資源
using語句的一大優點是它可以一次處理多個資源。 您可以將using語句一個接一個地堆疊,或者使用單個using語句來處理用逗號分隔的多個資源。以下是一個展示這兩種方法的範例:
using System;
using System.IO;
class Program
{
static void Main()
{
// Stacking using statements for multiple disposable resources
using (StreamReader reader1 = new StreamReader("example1.txt"))
using (StreamReader reader2 = new StreamReader("example2.txt"))
{
string content1 = reader1.ReadToEnd();
string content2 = reader2.ReadToEnd();
Console.WriteLine($"Content from example1.txt:\n{content1}\nContent from example2.txt:\n{content2}");
}
// Attempting to use a single using statement with multiple resources (not valid)
// Note: This method using comma-separated resources is not supported in C#
}
}using System;
using System.IO;
class Program
{
static void Main()
{
// Stacking using statements for multiple disposable resources
using (StreamReader reader1 = new StreamReader("example1.txt"))
using (StreamReader reader2 = new StreamReader("example2.txt"))
{
string content1 = reader1.ReadToEnd();
string content2 = reader2.ReadToEnd();
Console.WriteLine($"Content from example1.txt:\n{content1}\nContent from example2.txt:\n{content2}");
}
// Attempting to use a single using statement with multiple resources (not valid)
// Note: This method using comma-separated resources is not supported in C#
}
}Imports Microsoft.VisualBasic
Imports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Stacking using statements for multiple disposable resources
Using reader1 As New StreamReader("example1.txt")
Using reader2 As New StreamReader("example2.txt")
Dim content1 As String = reader1.ReadToEnd()
Dim content2 As String = reader2.ReadToEnd()
Console.WriteLine($"Content from example1.txt:" & vbLf & "{content1}" & vbLf & "Content from example2.txt:" & vbLf & "{content2}")
End Using
End Using
' Attempting to use a single using statement with multiple resources (not valid)
' Note: This method using comma-separated resources is not supported in C#
End Sub
End ClassImports Microsoft.VisualBasic
Imports System
Imports System.IO
Friend Class Program
Shared Sub Main()
' Stacking using statements for multiple disposable resources
Using reader1 As New StreamReader("example1.txt")
Using reader2 As New StreamReader("example2.txt")
Dim content1 As String = reader1.ReadToEnd()
Dim content2 As String = reader2.ReadToEnd()
Console.WriteLine($"Content from example1.txt:" & vbLf & "{content1}" & vbLf & "Content from example2.txt:" & vbLf & "{content2}")
End Using
End Using
' Attempting to use a single using statement with multiple resources (not valid)
' Note: This method using comma-separated resources is not supported in C#
End Sub
End Class注意:C#不支持單個using語句用逗號分隔多個資源。 每個資源都需要自己的using語句。
實現IDisposable介面
有時候,您可能會建立自己的自定義類別來管理一個或多個資源。 如果您的類別負責處理可釋放的物件或未管控的資源,您應該實現IDisposable介面。
這是一個實現IDisposable介面的自定義類別範例:
using System;
using System.IO;
public class CustomResource : IDisposable
{
private StreamReader _reader;
public CustomResource(string filePath)
{
_reader = new StreamReader(filePath);
}
public void ReadContent()
{
string content = _reader.ReadToEnd();
Console.WriteLine(content);
}
public void Dispose()
{
if (_reader != null)
{
_reader.Dispose();
_reader = null;
}
}
}using System;
using System.IO;
public class CustomResource : IDisposable
{
private StreamReader _reader;
public CustomResource(string filePath)
{
_reader = new StreamReader(filePath);
}
public void ReadContent()
{
string content = _reader.ReadToEnd();
Console.WriteLine(content);
}
public void Dispose()
{
if (_reader != null)
{
_reader.Dispose();
_reader = null;
}
}
}Imports System
Imports System.IO
Public Class CustomResource
Implements IDisposable
Private _reader As StreamReader
Public Sub New(ByVal filePath As String)
_reader = New StreamReader(filePath)
End Sub
Public Sub ReadContent()
Dim content As String = _reader.ReadToEnd()
Console.WriteLine(content)
End Sub
Public Sub Dispose() Implements IDisposable.Dispose
If _reader IsNot Nothing Then
_reader.Dispose()
_reader = Nothing
End If
End Sub
End ClassImports System
Imports System.IO
Public Class CustomResource
Implements IDisposable
Private _reader As StreamReader
Public Sub New(ByVal filePath As String)
_reader = New StreamReader(filePath)
End Sub
Public Sub ReadContent()
Dim content As String = _reader.ReadToEnd()
Console.WriteLine(content)
End Sub
Public Sub Dispose() Implements IDisposable.Dispose
If _reader IsNot Nothing Then
_reader.Dispose()
_reader = Nothing
End If
End Sub
End Class在這個例子中,CustomResource類別管理一個StreamReader物件,這是一個可釋放的物件。 通過實現IDisposable介面並實現Dispose方法,我們可以使用using語句來處理這個類別的實例。
以下是如何使用using語句與CustomResource類別:
class Program
{
static void Main()
{
using (CustomResource resource = new CustomResource("example.txt"))
{
resource.ReadContent();
}
}
}class Program
{
static void Main()
{
using (CustomResource resource = new CustomResource("example.txt"))
{
resource.ReadContent();
}
}
}Friend Class Program
Shared Sub Main()
Using resource As New CustomResource("example.txt")
resource.ReadContent()
End Using
End Sub
End ClassFriend Class Program
Shared Sub Main()
Using resource As New CustomResource("example.txt")
resource.ReadContent()
End Using
End Sub
End Class當using區塊結束時,Dispose方法會被調用,釋放它管理的StreamReader物件。
使用Using語句處理異常
using語句的另一個好處是它能更優雅地處理異常。 如果在using區塊中發生異常,Dispose方法仍然會在資源上被調用,確保正確的清理。
例如,考慮以下程式碼:
using System;
using System.IO;
class Program
{
static void Main()
{
try
{
using (StreamReader reader = new StreamReader("nonexistentfile.txt"))
{
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
}
catch (FileNotFoundException ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}using System;
using System.IO;
class Program
{
static void Main()
{
try
{
using (StreamReader reader = new StreamReader("nonexistentfile.txt"))
{
string content = reader.ReadToEnd();
Console.WriteLine(content);
}
}
catch (FileNotFoundException ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}Imports System
Imports System.IO
Friend Class Program
Shared Sub Main()
Try
Using reader As New StreamReader("nonexistentfile.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Using
Catch ex As FileNotFoundException
Console.WriteLine($"Error: {ex.Message}")
End Try
End Sub
End ClassImports System
Imports System.IO
Friend Class Program
Shared Sub Main()
Try
Using reader As New StreamReader("nonexistentfile.txt")
Dim content As String = reader.ReadToEnd()
Console.WriteLine(content)
End Using
Catch ex As FileNotFoundException
Console.WriteLine($"Error: {ex.Message}")
End Try
End Sub
End Class在這種情況下,如果程式碼拋出FileNotFoundException,異常會被catch區塊捕獲並處理。 即使異常發生在using區塊內,Dispose方法仍然會在StreamReader物件上被調用,確保沒有資源洩漏。
在IronPDF中使用Using語句
IronPDF是一個流行的程式庫,可用於在C#和.NET應用程式中建立、編輯和提取PDF文件。 與其他操作資源的程式庫類似,IronPDF也可以通過使用using語句來確保正確的資源管理。
讓我們探討如何使用using語句與IronPDF從HTML字串建立PDF文件,展示using語句在實際應用場景中的威力。
首先,確保您已在項目中安裝了IronPDF NuGet套件:
現在,讓我們從PDF文件中提取所有資料:
using IronPdf;
class Program
{
static void Main()
{
// Using a using statement with IronPDF to ensure resources are managed
using (PdfDocument pdfDocument = PdfDocument.FromFile("PDFData.pdf"))
{
string extractedText = pdfDocument.ExtractAllText();
Console.WriteLine(extractedText);
}
}
}using IronPdf;
class Program
{
static void Main()
{
// Using a using statement with IronPDF to ensure resources are managed
using (PdfDocument pdfDocument = PdfDocument.FromFile("PDFData.pdf"))
{
string extractedText = pdfDocument.ExtractAllText();
Console.WriteLine(extractedText);
}
}
}Imports IronPdf
Friend Class Program
Shared Sub Main()
' Using a using statement with IronPDF to ensure resources are managed
Using pdfDocument As PdfDocument = PdfDocument.FromFile("PDFData.pdf")
Dim extractedText As String = pdfDocument.ExtractAllText()
Console.WriteLine(extractedText)
End Using
End Sub
End ClassImports IronPdf
Friend Class Program
Shared Sub Main()
' Using a using statement with IronPDF to ensure resources are managed
Using pdfDocument As PdfDocument = PdfDocument.FromFile("PDFData.pdf")
Dim extractedText As String = pdfDocument.ExtractAllText()
Console.WriteLine(extractedText)
End Using
End Sub
End Class在這段程式碼中,我們使用PdfDocument.FromFile方法打開名為"PDFData.pdf"的PDF文件。 這個方法返回一個PdfDocument實例,我們將其包裝在一個using語句中。
在using區塊內,我們在PdfDocument實例上調用ExtractAllText來提取PDF中的所有文字。 當using區塊退出時,將自動在PdfDocument上調用Dispose方法,釋放它所持有的任何資源。
通過在PdfDocument上使用using語句,我們確保在提取完文字後PDF文件被正確關閉,即使在過程中發生異常。 這是一個很好的範例,展示了using語句如何在C#中有效管理資源。
C# 使用語句
總結
這就是using語句的一個快速導覽! 我們已經看到它如何確保一次性物件的有效處理,無縫地管理一個或多個資源。 using語句不僅有助於維持更清晰的程式碼,還提高了C#專案的可讀性。
我們還介紹了IronPDF,一個強健的C# PDF操作程式庫。 將using語句與IronPDF聯合使用展示了此程式碼功能的實際應用,加強了這一概念及其重要性。
準備好使用IronPDF了嗎? 您可以從我們IronPDF和Iron Software的30天免費試用套件開始。 它在開發目的中完全免費使用,因此您可以真正看到它的功能。 如果您喜歡您所看到的,IronPDF最低只需$999取得授權選項。 想獲得更大節省,請查看Iron Suite完整軟體套件,您可以用兩款產品的價格獲得Iron Software的全部九款工具。 祝您編碼愉快!
Jacob Mellor是Iron Software的首席技術官,一位在C# PDF技術上開創先河的遠見工程師。作為Iron Software核心程式碼庫的原開發者,他從創立以來就一直在塑造公司的產品架構,與首席執行官Cameron Rimington一起將公司轉變為服務於NASA、特斯拉和全球政府公司的50多名人員的公司。