.NET 帮助

C# 部分类(对开发者的作用)

发布 2024年四月29日
分享:

C# 提供了一个独特的功能,可以增强大型项目中代码的组织和管理:部分关键字类。 该功能可通过partial修改器访问,允许开发人员在多个文件中分割类、接口或结构体的定义。 这种能力尤其适用于处理已生成的源代码,如用户界面控件定义或服务封装代码,以及自定义业务逻辑。 在本文中,我们将了解部分类和IronPDF PDF Library for .NET使用 Visual Studio。

了解部分类

在 C# 中使用部分修饰符定义部分类,表示类定义分散在同一程序集的两个或多个文件中,保持相同的可访问性级别。 这种方法既能将相关代码放在一起,又能保持关注点的分离。 例如,一个部分类 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关键字至关重要,因为它表示该方法可能有实现,也可能没有实现。

举个例子,用户界面组件需要在加载用户界面控件之前执行某些操作。 部分方法提供了一种简洁的方法来插入自定义业务逻辑,而不会干扰自动生成的代码。

// 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#

将业务逻辑与部分类集成

业务逻辑经常需要修改和扩展,超出自动生成的范围,尤其是在具有复杂规则或行为的应用程序中。 部分类提供了一种无缝的方式,可在单独的源文件中包含业务逻辑,而无需更改自动生成的用户界面或数据访问代码。 这种分离可确保开发人员能够轻松访问和修改业务逻辑,从而加强合作,尤其是在有多名开发人员参与项目的情况下。

// 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 窗体的窗体)的情况下,部分类尤其有用。 这种设置允许开发人员将用户界面设计代码分离到不同的源文件中,使他们能够在不影响原始用户界面设计的情况下扩展或修改类。

在网络应用程序中,部分类便于将生成的网络服务封装代码与自定义业务逻辑分离,确保网络服务的更新不会覆盖自定义修改。 同样,在使用 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 文档。 它提供了一种直截了当的方法来使用 IronPDF 从 HTML 生成 PDF此外,该翻译工具还可以翻译 URL、图片、ASPX 和文本,是一款用于报告、文档生成和网页内容存档的多功能工具。 IronPDF 的卓越之处在于其易用性,只需极少的设置即可集成到任何 .NET 项目中,包括使用 C# 开发的应用程序。

将 IronPDF 与部分类集成

为了说明 IronPDF 与部分类的集成,让我们考虑这样一个例子:我们有一个生成 PDF 格式报告的网络应用程序。 我们将在部分类文件中拆分功能,以便将业务逻辑与 PDF 生成逻辑分开。

设置 IronPDF

首先,确保 IronPDF 已添加到您的项目中。 通常可以通过 NuGet 软件包管理器使用以下命令完成翻译:

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#

文件 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. 如果您有兴趣购买,IronPDF 的许可证起价为 749 美元。

< 前一页
Npgsql C#(开发人员工作原理)
下一步 >
C# 虚拟与抽象(开发人员如何运作)

准备开始了吗? 版本: 2024.11 刚刚发布

免费NuGet下载 总下载量: 11,436,010 查看许可证 >