分部类和方法（C# 编程指南）

项目
11/14/2024

拆分一个类、一个结构、一个接口或一个方法的定义到两个或更多的文件中是可能的。每个源文件包含类型或方法定义的一部分，编译应用程序时将把所有部分组合起来。

分部类

在以下几种情况下需要拆分类定义：

通过单独的文件声明某个类可以让多位程序员同时对该类进行处理。
你可以向该类中添加代码，而不必重新创建包括自动生成的源代码的源文件。 Visual Studio 在创建Windows 窗体、Web 服务包装器代码等时会使用这种方法。你可以创建使用这些类的代码，这样就不需要修改由Visual Studio生成的文件。
源代码生成器可以在类中生成额外的功能。

若要拆分类定义，请使用分部关键字修饰符。实际上，每个分部类通常在单独的文件中定义，以便随着时间的推移更轻松地管理和扩展类。

以下示例 Employee 演示如何将类划分为两个文件：Employee_Part1.cs和Employee_Part2.cs。

// This is in Employee_Part1.cs
public partial class Employee
{
    public void DoWork()
    {
    }
}

// This is in Employee_Part2.cs
public partial class Employee
{
    public void GoToLunch()
    {
    }
}

//Main program demonstrating the Employee class usage
public class Program
{
    public static void Main()
    {
        Employee emp = new Employee();
        emp.DoWork();
        emp.GoToLunch();
    }
}

// Expected Output:
// Employee is working.
// Employee is at lunch.

partial 关键字指示可在命名空间中定义该类、结构或接口的其他部分。所有部分都必须使用 partial 关键字。在编译时，各个部分都必须可用来形成最终的类型。各个部分必须具有相同的可访问性，如 public、private 等。

如果将任意部分声明为抽象的，则整个类型都被视为抽象的。如果将任意部分声明为密封的，则整个类型都被视为密封的。如果任意部分声明基类型，则整个类型都将继承该类。

指定基类的所有部分必须一致，但忽略基类的部分仍继承该基类型。各个部分可以指定不同的基接口，最终类型将实现所有分部声明所列出的全部接口。在某一分部定义中声明的任何类、结构或接口成员可供所有其他部分使用。最终类型是所有部分在编译时的组合。

注意

partial 修饰符不可用于委托或枚举声明中。

下面的示例演示嵌套类型可以是分部的，即使它们所嵌套于的类型本身并不是分部的也如此。

class Container
{
    partial class Nested
    {
        void Test() { }
    }

    partial class Nested
    {
        void Test2() { }
    }
}

编译时会对分部类型定义的属性进行合并。以下面的声明为例：

[SerializableAttribute]
partial class Moon { }

[ObsoleteAttribute]
partial class Moon { }

它们等效于以下声明：

[SerializableAttribute]
[ObsoleteAttribute]
class Moon { }

将从所有分部类型定义中对以下内容进行合并：

XML 注释。但是，如果分部成员的两个声明都包含注释，则仅包括实现成员的注释。
interfaces
泛型类型参数属性
class 特性
成员

以下面的声明为例：

partial class Earth : Planet, IRotate { }
partial class Earth : IRevolve { }

它们等效于以下声明：

class Earth : Planet, IRotate, IRevolve { }

限制

处理分部类定义时需遵循下面的几个规则：

要作为同一类型的各个部分的所有分部类型定义都必须使用 partial 进行修饰。例如，下面的类声明会生成错误：
```
public partial class A { }
//public class A { }  // Error, must also be marked partial
```
partial 修饰符只能出现在紧靠关键字 class、struct 或 interface 前面的位置。

分部类型定义中允许使用嵌套的分部类型，如下面的示例中所示：

partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

要成为同一类型的各个部分的所有分部类型定义都必须在同一程序集和同一模块（.exe 或 .dll 文件）中进行定义。分部定义不能跨越多个模块。
类名和泛型类型参数在所有的分部类型定义中都必须匹配。泛型类型可以是分部的。每个分部声明都必须以相同的顺序使用相同的参数名。
下面用于分部类型定义中的关键字是可选的，但是如果某关键字出现在一个分部类型定义中，则必须在相同类型的其他分部定义中指定相同的关键字：
- 公共
- private
- 受保护
- internal
- abstract
- sealed
- 基类
- new 修饰符（嵌套部分）
- 泛型约束

有关详细信息，请参阅类型参数的约束。

示例

在以下示例中，类的Coords字段和构造函数在一个分部类定义（Coords_Part1.cs）中声明，方法PrintCoords在另一个分部类定义中声明。Coords_Part2.cs 这种分离演示了如何跨多个文件划分分部类，以便更轻松地保持可维护性。

 // This is in Coords_Part1.cs
 public partial class Coords
 {
     private int x;
     private int y;

     public Coords(int x, int y)
     {
         this.x = x;
         this.y = y;
     }
 }

 // This is in Coords_Part2.cs
 public partial class Coords
 {
     public void PrintCoords()
     {
         Console.WriteLine("Coords: {0},{1}", x, y);
     }
 }

// Main program demonstrating the Coords class usage
 class TestCoords
 {
     static void Main()
     {
         Coords myCoords = new Coords(10, 15);
         myCoords.PrintCoords();

         // Keep the console window open in debug mode.
         Console.WriteLine("Press any key to exit.");
         Console.ReadKey();
     }
 }
 // Output: Coords: 10,15

从下面的示例可以看出，你也可以开发分部结构和接口。

partial interface ITest
{
    void Interface_Test();
}

partial interface ITest
{
    void Interface_Test2();
}

partial struct S1
{
    void Struct_Test() { }
}

partial struct S1
{
    void Struct_Test2() { }
}

分部成员

分部类或结构可以包含分部成员。类的一个部分包含成员的签名。可以在同一部分或另一部分中定义实现。

当签名遵循以下规则时，分部方法不需要实现：

声明未包含任何访问修饰符。默认情况下，该方法具有 private 访问权限。
返回类型为 void。
没有任何参数具有 out 修饰符。
方法声明不能包括以下任何修饰符：
- virtual
- override
- sealed
- new
- extern

当未提供实现时，在编译时会移除该方法以及对该方法的所有调用。

任何不符合所有这些限制的方法（包括属性和索引器）都必须提供实现。此实现可以由源生成器提供。不能使用自动实现的属性实现部分属性。编译器无法区分自动实现的属性和分部属性的声明声明。

从 C# 13 开始，部分属性的实现声明可以使用字段支持的属性来定义实现声明。字段支持的属性提供简洁的语法， field 其中关键字访问该属性的编译器合成后备字段。例如，可以编写以下内容：

// in file1.cs
public partial class PropertyBag
{
    // Defining declaration
    public partial int MyProperty { get; set; }
}

// In file2.cs
public partial class PropertyBag
{
    // Defining declaration
    public partial int MyProperty { get => field; set; }
}

可以在或getset访问器中使用，也可以同时使用field两者。

重要

关键字 field 是 C# 13 中的预览功能。必须使用 .NET 9 并将元素preview设置为<LangVersion>项目文件中，才能使用field上下文关键字。

应注意在 field 具有名为 field字段的类中使用关键字功能。新 field 关键字将隐藏属性访问器范围中命名 field 的字段。可以更改变量的名称 field ，或使用 @ 令牌将标识符引用 field 为 @field。可以通过阅读关键字的功能规范field来了解详细信息。

分部方法允许类的某个部分的实现者声明成员。类的另一部分的实现者可以定义该成员。在以下两个情形中，此分离很有用：生成样板代码的模板和源生成器。

模板代码：模板保留方法名称和签名，以使生成的代码可以调用方法。这些方法遵循允许开发人员决定是否实现方法的限制。如果未实现该方法，编译器会移除方法签名以及对该方法的所有调用。调用该方法（包括调用中的任何参数计算结果）在运行时没有任何影响。因此，分部类中的任何代码都可以随意地使用分部方法，即使未提供实现也是如此。未实现该方法时调用该方法不会导致编译时错误或运行时错误。
源生成器：源生成器提供成员的实现。开发人员可以添加成员声明（通常由源生成器读取属性）。开发人员可以编写调用这些成员的代码。源生成器在编译过程中运行并提供实现。在这种情况下，不会遵循不经常实现的分部成员的限制。

// Definition in file1.cs
partial void OnNameChanged();

// Implementation in file2.cs
partial void OnNameChanged()
{
  // method body
}

分部成员声明必须以上下文关键字 partial 开头。
分部类型的两个部分中的分部成员签名必须匹配。
分部成员可以有 static 和 unsafe 修饰符。
分部成员可能是泛型成员。约束在定义和实现方法声明时必须相同。参数和类型参数名称在定义和实现方法声明时不必相同。
你可以为已定义并实现的分部方法生成委托，但不能为没有实现的分部方法生成委托。

C# 语言规范

有关详细信息，请参阅 C# 语言规范中的分部类型和分部方法。该语言规范是 C# 语法和用法的权威资料。分部方法的新功能在功能规范中定义。

通过

分部类和方法（C# 编程指南）

分部类

限制

示例

分部成员

C# 语言规范

另请参阅

其他资源