Partial Class简介与应用

发布时间：2023-05-19

一、Partial Class简介

Partial Class是C#中的一个关键字，直译过来是“部分类”。它可以将一个类的定义分成多个部分，分别实现类的成员。这样做优点是可以在一个类文件中，将一个类的所有方法、属性、事件、字段、类变量等按照功能或其他维度分成多个文件编写，方便代码的维护和管理，提升程序的可读性和可维护性。 Partial Class的定义方式如下所示：

public partial class MyClass {
    // 待完成…
}

在这里我们定义了一个名为MyClass的部分类，因为是部分类，所以后面的花括号里是空的。此时，如果其他代码文件中有MyClass的另外一部分，编译器就会将它们合并起来作为一个完整的类。

二、Partial Class的应用场景

Partial Class的应用场景可以说非常广泛。一般来说，应用Partial Class的情况可以分为以下几类：

1、拆分复杂的大型类

在大型项目中，一个类的代码可能会非常冗长而复杂。如果不拆分，代码会非常难以阅读和修改。而采用Partial Class方式，将类按照功能或其他维度拆分成多个部分，就会方便许多。 例如我们有一个名为User的类，它可能会包含很多函数，比如登录、注册、修改信息等，它们对于整个系统来说都非常重要，但是如果将这些函数全部写在同一个文件中，就会导致这个文件太大了，而且回归测试和代码重构都会非常困难。针对这种情况，可以采用Partial Class来将User类拆分成多个部分，比如Login.cs、Regist.cs、UserInfo.cs等等。

2、分离自动生成的代码

在项目中，我们有时会使用代码生成工具来生成一些代码，比如数据库模型、代理类等。这些自动生成的代码容易产生一些问题，比如维护成本高、阅读难度大等。将自动生成的一部分代码与手写的代码分开来，可以方便地修复自动生成的代码通过覆盖手写代码的bug。

3、代码分层

在复杂的项目中，我们通常都会采用代码分层的方式来管理代码。Partial Class就可以用于将一类操作（比如数据库操作）的代码分成多个部分，方便项目的维护和管理。

三、Partial Class注意点

在使用Partial Class时，有几个需要注意的地方：

1、类名必须完全相同

在定义部分类时，必须给出与主题相同的完整类名。如果类名不同时，编译器会将它们视为彼此独立的两个类。

2、成员不可重定义

部分类中定义的成员必须唯一。如果在不同的部分类中定义了相同的成员，编译器会报错。

3、可跨越多个文件

Partial Class可以跨越多个文件，这就意味着可以将类的定义分散到多个文件中，使得代码更容易管理。

四、Partial Class示例代码

1、示例1--将单个类拆分成多个部分

在这个示例中，我们定义了一个名为Person.cs的文件，然后将Person类按照方法拆分成了两个部分，一个是Person1.cs，另一个是Person2.cs。两个部分中都有相同的属性和方法，但是实现不同。 Person.cs：

public partial class Person {
    public string Name { get; set; }
    public int Age { get; set; }
    public bool IsActive { get; set; }
    public void Speak() {
        Console.WriteLine("Hello World!");
    }
}

Person1.cs：

public partial class Person {
    public void Speak() {
        Console.WriteLine("Bonjour, le monde!");
    }
}

Person2.cs：

public partial class Person {
    public void Speak() {
        Console.WriteLine("你好，世界！");
    }
}

在程序中可以这样使用：

Person p = new Person();
p.Name = "Tony";
p.Age = 20;
p.IsActive = true;
p.Speak(); // 输出："Hello World!"

2、示例2--使用Partial Class分离自动生成的代码

在这个示例中，我们使用ASP.NET框架下的ADO.NET实现了一个数据库操作类DbOp。该类是自动生成的。因为DbContext文件与DbOp文件不同，因此我们将DbOp类拆分为两个部分，放置在不同的文件中。 DbOp.cs：

namespace ExampleProject.Data {
    public partial class DbOp {
        public void Insert() {
            using (var ctx = new DbContext()) {
                // 插入
            }
        }
        public void Delete() {
            using (var ctx = new DbContext()) {
                // 删除
            }
        }
        public void Update() {
            using (var ctx = new DbContext()) {
                // 更新
            }
        }
    }
}

DbOp_Plus.cs：

namespace ExampleProject.Data {
    public partial class DbOp {
        public void FindById() {
            using (var ctx = new DbContext()) {
                // 根据ID查找
            }
        }
        public void FindByName() {
            using (var ctx = new DbContext()) {
                // 根据姓名查找
            }
        }
        public void FindByAge() {
            using (var ctx = new DbContext()) {
                // 根据年龄查找
            }
        }
    }
}

在程序中可以这样使用：

DbOp op = new DbOp();
op.Insert(); // 插入数据
op.Delete(); // 删除数据
op.Update(); // 更新数据
op.FindById(); // 根据ID查找数据
op.FindByName(); // 根据姓名查找数据
op.FindByAge(); // 根据年龄查找数据

3、示例3--使用Partial Class实现代码分层

在这个示例中，我们将一个名为SqlHelper的类分成了两个部分：一个是负责连接数据库的部分，另一个是实现具体业务操作的部分。 SqlConnectHelper.cs：

public partial class SqlHelper {
    public string connectionString { get; set; }
    public SqlConnection GetConnection() {
        return new SqlConnection(connectionString);
    }
}

SqlOperateHelper.cs：

public partial class SqlHelper {
    public void Insert(string sqlString) {
        using (SqlConnection conn = GetConnection()) {
            // 插入操作
        }
    }
    public void Delete(string sqlString) {
        using (SqlConnection conn = GetConnection()) {
            // 删除操作
        }
    }
    public void Update(string sqlString) {
        using (SqlConnection conn = GetConnection()) {
            // 更新操作
        }
    }
}

在程序中可以这样使用：

string connectionString = "Data Source=.;Initial Catalog=Test;Integrated Security=SSPI";
SqlHelper helper = new SqlHelper();
helper.connectionString = connectionString;
helper.Insert("INSERT INTO TableName VALUES(...)");
helper.Delete("DELETE FROM TableName WHERE ...");
helper.Update("UPDATE TableName SET ...");

总结

Partial Class是C#语言中的一个非常实用的特性，可以方便地将一个类的定义拆分成多个部分。使用Partial Class能够提升代码的可读性和可维护性，特别是在大型项目和团队协作场景下有很好的应用。同时，需要注意的是，Partial Class的定义要求必须唯一，且类名必须相同。

推荐文章