【微软技术栈】C#.NET 分部类和方法

本文内容

1. 分部类
2. 示例
3. 分部方法

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

1、分部类

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

• 处理大型项目时，使一个类分布于多个独立文件中可以让多位程序员同时对该类进行处理。
• 当使用自动生成的源文件时，你可以添加代码而不需要重新创建源文件。 Visual Studio 在创建Windows 窗体、Web 服务包装器代码等时会使用这种方法。 你可以创建使用这些类的代码，这样就不需要修改由Visual Studio生成的文件。
• 在类中生成附加功能时。

若要拆分类定义，请使用 partial 关键字修饰符，如下所示：

public partial class Employee
{
    public void DoWork()
    {
    }
}

public partial class Employee
{
    public void GoToLunch()
    {
    }
}

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 注释
• 接口
• 泛型类型参数属性
• 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 文件）中进行定义。 分部定义不能跨越多个模块。
• 类名和泛型类型参数在所有的分部类型定义中都必须匹配。 泛型类型可以是分部的。 每个分部声明都必须以相同的顺序使用相同的参数名。
• 下面用于分部类型定义中的关键字是可选的，但是如果某关键字出现在一个分部类型定义中，则该关键字不能与在同一类型的其他分部定义中指定的关键字冲突：
  • public
  • private
  • 受保护
  • internal
  • abstract
  • sealed
  • 基类
  • new 修饰符（嵌套部分）
  • 泛型约束

2、示例

下面的示例在一个分部类定义中声明 Coords 类的字段和构造函数，在另一个分部类定义中声明成员 PrintCoords。

public partial class Coords
{
    private int x;
    private int y;

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

public partial class Coords
{
    public void PrintCoords()
    {
        Console.WriteLine("Coords: {0},{1}", x, y);
    }
}

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() { }
}

3、分部方法

分部类或结构可以包含分部方法。 类的一个部分包含方法的签名。 可以在同一部分或另一部分中定义实现。 如果未提供该实现，则会在编译时删除方法以及对方法的所有调用。 根据方法签名，可能需要实现。 在以下情况下，不需要使用分部方法即可实现：

• 没有任何可访问性修饰符（包括默认的 专用）。
• 返回 void。
• 没有任何输出参数。
• 没有以下任何修饰符：virtual、override、sealed、new 或 extern。

任何不符合所有这些限制的方法（例如 public virtual partial void 方法）都必须提供实现。 此实现可以由源生成器提供。

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

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

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

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

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