.NET 幫助

C# 部分 (開發人員如何使用)

發佈 2024年4月29日
分享:

C# 提供了一個獨特的功能,能增強在大型項目中代碼的組織與管理:partial 關鍵字類別。這個功能通過 partial 修飾符實現,允許開發者將類、接口或結構的定義拆分到多個文件中。這種能力對於處理已生成的源代碼(如用戶界面控件定義或服務包裝代碼)與自定義業務邏輯非常有利。在本文中,我們將了解 partial 類和 IronPDF 庫 使用 Visual Studio。

理解部分類別

在 C# 中,使用 partial 修飾符來定義部分類別,保持相同的存取層級,表示該類別的定義分佈於同一個組件內的兩個或更多文件中。這種方法可以將相關的程式碼聚集在一起,同時保持關注點分離。例如,一個 partial class Employee 可能在一個文件中擁有其業務邏輯,在另一個文件中擁有其資料存取層,但這兩部分都編譯成一個類別。這種分離不僅使程式碼更加易於管理,還允許多名開發人員在同一個類別上協同工作而不會發生衝突。

// File 1: Employee_BusinessLogic.cs
public partial class Employee
{
    public void CalculatePay() { /* Implementation */ }
}
// File 2: Employee_DataAccess.cs
public partial class Employee
{
    public void Load() { /* Implementation */ }
}
// File 1: Employee_BusinessLogic.cs
public partial class Employee
{
    public void CalculatePay() { /* Implementation */ }
}
// File 2: Employee_DataAccess.cs
public partial class Employee
{
    public void Load() { /* Implementation */ }
}
' File 1: Employee_BusinessLogic.cs
Partial Public Class Employee
	Public Sub CalculatePay()
	End Sub
End Class
' File 2: Employee_DataAccess.cs
Partial Public Class Employee
	Public Sub Load()
	End Sub
End Class
VB   C#

利用部分方法

部分類別也可以定義部分方法,這些方法是可選的,甚至可以被聲明為抽象的,允許更靈活的實現策略。這些方法使一個有趣的場景成為可能,即類的一部分可以聲明一個方法而不實現它,允許類的另一部分來實現它。如果沒有提供實現,則在編譯時會移除部分方法的調用,不會導致性能損失。

// File 1: Employee_BusinessLogic.cs
public partial class Employee
{
    partial void OnPayCalculated(double amount);
    public void CalculatePay()
    {
        double amount = 1000; // Simplified calculation
        OnPayCalculated(amount);
    }
}
// File 2: Employee_Events.cs
public partial class Employee
{
    partial void OnPayCalculated(double amount)
    {
        Console.WriteLine($"Pay calculated: {amount}");
    }
}
// File 1: Employee_BusinessLogic.cs
public partial class Employee
{
    partial void OnPayCalculated(double amount);
    public void CalculatePay()
    {
        double amount = 1000; // Simplified calculation
        OnPayCalculated(amount);
    }
}
// File 2: Employee_Events.cs
public partial class Employee
{
    partial void OnPayCalculated(double amount)
    {
        Console.WriteLine($"Pay calculated: {amount}");
    }
}
' File 1: Employee_BusinessLogic.cs
Partial Public Class Employee
	Partial Private Sub OnPayCalculated(ByVal amount As Double)
	End Sub
	Public Sub CalculatePay()
		Dim amount As Double = 1000 ' Simplified calculation
		OnPayCalculated(amount)
	End Sub
End Class
' File 2: Employee_Events.cs
Partial Public Class Employee
	Private Sub OnPayCalculated(ByVal amount As Double)
		Console.WriteLine($"Pay calculated: {amount}")
	End Sub
End Class
VB   C#

部分類別方法的高級用法

部分類別方法作為一種局部分定義的方法,是在部分類別內的一個特性,允許在部分類別的一部分中聲明,並在另一部分中可選擇性地實現。這個特性特別有用於在生成的代碼中提供鉤子,開發者可以可選地實現。partial 關鍵字在這裡是關鍵,因為它表示該方法可能有或沒有實現。

考慮一個範例,其中一個 UI 元件需要在用戶界面控制裝載之前執行某些操作。部分類別方法提供了一種乾淨的方法來插入自定義業務邏輯,而不會使自動生成的代碼變得雜亂。

// File: UIControls_AutoGenerated.cs
public partial class UIControls
{
    partial void OnControlLoading();
    public void LoadControl()
    {
        OnControlLoading();
        // Auto-generated loading logic here
    }
}
// File: UIControls_CustomLogic.cs
public partial class UIControls
{
    partial void OnControlLoading()
    {
        // Custom business logic code here
        Console.WriteLine("Custom control loading logic executed.");
    }
}
// File: UIControls_AutoGenerated.cs
public partial class UIControls
{
    partial void OnControlLoading();
    public void LoadControl()
    {
        OnControlLoading();
        // Auto-generated loading logic here
    }
}
// File: UIControls_CustomLogic.cs
public partial class UIControls
{
    partial void OnControlLoading()
    {
        // Custom business logic code here
        Console.WriteLine("Custom control loading logic executed.");
    }
}
' File: UIControls_AutoGenerated.cs
Partial Public Class UIControls
	Partial Private Sub OnControlLoading()
	End Sub
	Public Sub LoadControl()
		OnControlLoading()
		' Auto-generated loading logic here
	End Sub
End Class
' File: UIControls_CustomLogic.cs
Partial Public Class UIControls
	Private Sub OnControlLoading()
		' Custom business logic code here
		Console.WriteLine("Custom control loading logic executed.")
	End Sub
End Class
VB   C#

使用部分類別整合業務邏輯

業務邏輯往往需要超出自動生成的內容進行修改和擴展,特別是在具有複雜規則或行為的應用程式中。部分類別提供了一種無縫的方法,可以在不更改自動生成的UI或資料存取代碼的情況下,在單獨的源文件中包含業務邏輯。這種分離確保了業務邏輯可以被開發人員輕鬆存取和修改,增強了協作特性,特別是在多個開發人員一起工作的專案中。

// File: Employee_AutoGenerated.cs
public partial class Employee
{
    // Auto-generated properties and methods
}
// File: Employee_BusinessLogic.cs
public partial class Employee
{
    public void Promote()
    {
        // Business logic code to promote an employee
        Console.WriteLine("Employee promoted.");
    }
}
// File: Employee_AutoGenerated.cs
public partial class Employee
{
    // Auto-generated properties and methods
}
// File: Employee_BusinessLogic.cs
public partial class Employee
{
    public void Promote()
    {
        // Business logic code to promote an employee
        Console.WriteLine("Employee promoted.");
    }
}
' File: Employee_AutoGenerated.cs
Partial Public Class Employee
	' Auto-generated properties and methods
End Class
' File: Employee_BusinessLogic.cs
Partial Public Class Employee
	Public Sub Promote()
		' Business logic code to promote an employee
		Console.WriteLine("Employee promoted.")
	End Sub
End Class
VB   C#

嵌套部分類型

嵌套部分類型擴展了部分類的概念到嵌套類,允許嵌套類的部分在不同的文件中定義。這在組織大型嵌套結構時特別有用,比如一個包含多個嵌套類型來處理控制行為各個方面的複雜使用者介面控制定義。

// File: ComplexControl_Part1.cs
public partial class ComplexControl
{
    public partial class NestedControl
    {
        public void Initialize() { /* Initialization code here */ }
    }
}
// File: ComplexControl_Part2.cs
public partial class ComplexControl
{
    public partial class NestedControl
    {
        public void Cleanup() { /* Cleanup code here */ }
    }
}
// File: ComplexControl_Part1.cs
public partial class ComplexControl
{
    public partial class NestedControl
    {
        public void Initialize() { /* Initialization code here */ }
    }
}
// File: ComplexControl_Part2.cs
public partial class ComplexControl
{
    public partial class NestedControl
    {
        public void Cleanup() { /* Cleanup code here */ }
    }
}
' File: ComplexControl_Part1.cs
Partial Public Class ComplexControl
	Partial Public Class NestedControl
		Public Sub Initialize()
		End Sub
	End Class
End Class
' File: ComplexControl_Part2.cs
Partial Public Class ComplexControl
	Partial Public Class NestedControl
		Public Sub Cleanup()
		End Sub
	End Class
End Class
VB   C#

實用應用

部分類別在涉及自動生成源代碼的場景中特別有用,例如Visual Studio創建Windows表單的Forms。這種設置允許開發人員將UI設計代碼分離到一個獨立的源文件中,使他們能夠擴展或修改類別而不影響原始的UI設計。

在Web應用程序中,部分類別有助於將生成的Web服務包裝器代碼與自定義業務邏輯分開,確保對Web服務的更新不會覆蓋自定義的修改。同樣,在使用LINQ to SQL的應用程序中,dbml文件生成可以擴展的部分類別定義,以包括額外的功能或業務邏輯,而不會觸及自動生成的代碼。

// Auto-generated UI class
public partial class MainForm : Form
{
    // Designer code
}
// Custom logic for MainForm
public partial class MainForm
{
    // Custom event handlers and methods
}
// Auto-generated UI class
public partial class MainForm : Form
{
    // Designer code
}
// Custom logic for MainForm
public partial class MainForm
{
    // Custom event handlers and methods
}
' Auto-generated UI class
Partial Public Class MainForm
	Inherits Form

	' Designer code
End Class
' Custom logic for MainForm
Partial Public Class MainForm
	Inherits Form

	' Custom event handlers and methods
End Class
VB   C#

IronPDF:C# PDF 庫

C# 部分 (對開發人員的運作方式): 圖 1 - IronPDF

IronPDF 是一個全面的 .NET 庫,允許開發人員在其應用程式中創建、讀取和編輯 PDF 文檔。它提供了一個簡單的方法來 從 HTML 生成 PDF, URL、圖片、ASPX和文字,使其成為報告、文檔生成和網頁內容歸檔的多功能工具。IronPDF 易於使用,需要最少的設置即可集成到任何 .NET 項目中,包括使用 C# 開發的應用程式。

將 IronPDF 與局部類別整合

為了說明 IronPDF 與局部類別的整合,我們來考慮一個例子:我們有一個生成 PDF 格式報告的網頁應用程式。我們將功能分割到局部類別文件中,以保持業務邏輯與 PDF 生成邏輯的分離。

設置 IronPDF

首先,確保將 IronPDF 添加到您的項目中。這通常可以通過 NuGet Package Manager 使用以下命令來完成:

Install-Package IronPdf

創建生成報告的部分類別

我們將類別分為兩部分:一部分負責與報告數據相關的業務邏輯,另一部分使用IronPDF生成PDF。

文件1:ReportGenerator_BusinessLogic.cs

此文件包含為報告準備數據的業務邏輯。

public partial class ReportGenerator
{
    public IEnumerable<string> GetDataForReport()
    {
        // Imagine this method fetches and prepares data for the report
        return new List<string> { "Data1", "Data2", "Data3" };
    }
}
public partial class ReportGenerator
{
    public IEnumerable<string> GetDataForReport()
    {
        // Imagine this method fetches and prepares data for the report
        return new List<string> { "Data1", "Data2", "Data3" };
    }
}
Partial Public Class ReportGenerator
	Public Function GetDataForReport() As IEnumerable(Of String)
		' Imagine this method fetches and prepares data for the report
		Return New List(Of String) From {"Data1", "Data2", "Data3"}
	End Function
End Class
VB   C#

File 2: ReportGenerator_PdfGeneration.cs

此檔案使用 IronPDF 從準備好的數據生成 PDF 報告。

public partial class ReportGenerator
{
    public void GeneratePdfReport()
    {
        var renderer = new IronPdf.ChromePdfRenderer();
        var data = GetDataForReport();
        var htmlContent = $"<html><body><h1>Report</h1><p>{string.Join("</p><p>", data)}</p></body></html>";
        // Generate PDF from HTML string
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        // Save the PDF to a file
        pdf.SaveAs("Report.pdf");
        Console.WriteLine("Report generated successfully.");
    }
}
public partial class ReportGenerator
{
    public void GeneratePdfReport()
    {
        var renderer = new IronPdf.ChromePdfRenderer();
        var data = GetDataForReport();
        var htmlContent = $"<html><body><h1>Report</h1><p>{string.Join("</p><p>", data)}</p></body></html>";
        // Generate PDF from HTML string
        var pdf = renderer.RenderHtmlAsPdf(htmlContent);
        // Save the PDF to a file
        pdf.SaveAs("Report.pdf");
        Console.WriteLine("Report generated successfully.");
    }
}
Partial Public Class ReportGenerator
	Public Sub GeneratePdfReport()
		Dim renderer = New IronPdf.ChromePdfRenderer()
		Dim data = GetDataForReport()
		Dim htmlContent = $"<html><body><h1>Report</h1><p>{String.Join("</p><p>", data)}</p></body></html>"
		' Generate PDF from HTML string
		Dim pdf = renderer.RenderHtmlAsPdf(htmlContent)
		' Save the PDF to a file
		pdf.SaveAs("Report.pdf")
		Console.WriteLine("Report generated successfully.")
	End Sub
End Class
VB   C#

用法

通過設置部分類別,在ReportGenerator類別的實例上調用GeneratePdfReport方法即可生成 PDF 報告。

var reportGenerator = new ReportGenerator();
reportGenerator.GeneratePdfReport();
var reportGenerator = new ReportGenerator();
reportGenerator.GeneratePdfReport();
Dim reportGenerator As New ReportGenerator()
reportGenerator.GeneratePdfReport()
VB   C#

C# 部分(對開發者的運作方式):圖 2 - PDF 報告輸出

結論

C# 部分(開發者的工作原理):圖 3 - 授權

在 C# 中使用部分類別、部分方法和嵌套部分類型為開發人員提供了一種靈活且強大的工具,用於代碼組織和管理。通過將自動生成的代碼與業務邏輯、用戶界面控制定義和應用程序的其他部分分開,開發人員可以創建更易於維護、閱讀和擴展的應用程序。

通過分離業務邏輯和 PDF 處理的關注點,開發人員可以實現更好的代碼組織、可維護性和可擴展性。IronPDF 的強大功能結合部分類別的組織優勢,為使用 PDF 的 .NET 開發人員創造了一個強大的工具集。你可以免費試用 IronPDF。 免費試用如果您有興趣購買,IronPDF 的授權起價為 $749。

< 上一頁
Npgsql C#(開發人員如何使用)
下一個 >
C# 虛擬和抽象(如何為開發者工作)

準備開始了嗎? 版本: 2024.10 剛剛發布

免費 NuGet 下載 總下載次數: 10,993,239 查看許可證 >