快捷導(dǎo)航

C#?中的partial?關(guān)鍵字詳解

更新時間：2022年07月25日 17:10:17 作者：wumingxiaoyao

這篇文章主要介紹了C#?中的partial?關(guān)鍵字,partial 關(guān)鍵字用于拆分一個類、一個結(jié)構(gòu)、一個接口或一個方法的定義到兩個或更多的文件中，本文通過實(shí)例代碼給大家介紹的非常詳細(xì)，需要的朋友可以參考下

引言

partial 關(guān)鍵字用于拆分一個類、一個結(jié)構(gòu)、一個接口或一個方法的定義到兩個或更多的文件中。每個源文件包含類型或方法定義的一部分，編譯應(yīng)用程序時將把所有部分組合起來。在設(shè)計 Framework 時，可以充分利用 partial 這個特性。

分部類

什么情況下需要拆分類定義呢？

處理大型項目時，使一個類分布于多個獨(dú)立文件中可以讓多位程序員同時對該類進(jìn)行處理。
當(dāng)使用自動生成的源文件時，你可以添加代碼而不需要重新創(chuàng)建源文件。 Visual Studio 在創(chuàng)建 Windows 窗體、Web 服務(wù)包裝器代碼等時會使用這種方法。你可以創(chuàng)建使用這些類的代碼，這樣就不需要修改由 Visual Studio 生成的文件。
使用源生成器在類中生成附加功能時。

例子

將 Coords 類分部在 2 個文件中定義。

在這里插入圖片描述

CoordsOne.cs
定義了 Coords 類的構(gòu)造函數(shù)
注意簽名 partial class Coords

namespace ConsoleApp1.PartialClass
{
    public partial class Coords
    {
        private int x;
        private int y;

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

CoordsTwo.cs
定義了 Coords 類的一個方法
注意簽名 partial class Coords

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

TestPartial.cs
測試一下上面的分部類

using ConsoleApp1.PartialClass;

namespace ConsoleApp1
{
    internal class TestPartial
    {
        static void Main(string[] args)
        {
            Coords coords = new Coords(10, 20);
            coords.PrintCoords();
        }
    }
}

結(jié)果：

Coords: 10,20

partial 分部限制

處理分部類定義時需遵循下面的幾個規(guī)則：

要作為同一類型的各個部分的所有分部類型定義都必須使用 partial 進(jìn)行修飾。

例如，下面的類聲明會生成錯誤：

public partial class A { }
//public class A { }  // Error, must also be marked partial

partial 修飾符只能出現(xiàn)在緊靠關(guān)鍵字 class、struct 或 interface 前面的位置。
分部類型定義中允許使用嵌套的分部類型，如下面的示例中所示：

partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

partial class ClassWithNestedClass
{
    partial class NestedClass { }
}

要成為同一類型的各個部分的所有分部類型定義都必須在同一程序集和同一模塊（.exe 或 .dll 文件）中進(jìn)行定義。分部定義不能跨越多個模塊。經(jīng)測試這些分部的文件必須在同一命名空間。
還是上面的例子，CoordsThree.cs 也定義成 partial 類，但是相比 CoordsOne.cs 和 CoordsTwo.cs 不是在同一個命名空間，會出錯。

在這里插入圖片描述

類名和泛型類型參數(shù)在所有的分部類型定義中都必須匹配。泛型類型可以是分部的。每個分部聲明都必須以相同的順序使用相同的參數(shù)名。
如果某關(guān)鍵字出現(xiàn)在一個分部類型定義中，則該關(guān)鍵字不能與在同一類型的其他分部定義中指定的關(guān)鍵字沖突：public，private，protected，internal，abstract，sealed 等

將 CoordsOne.cs 中 public 改成 internal，產(chǎn)生訪問屬性沖突。

在這里插入圖片描述

分部接口和結(jié)構(gòu)

同理，也可以開發(fā)分部結(jié)構(gòu)和接口

partial interface ITest
{
    void Interface_Test();
}

partial interface ITest
{
    void Interface_Test2();
}

partial struct S1
{
    void Struct_Test() { }
}

partial struct S1
{
    void Struct_Test2() { }
}

分部方法

分部方法在分部類型的一部分中定義了簽名，并在該類型的另一部分中定義了實(shí)現(xiàn)。通過分部方法，類設(shè)計器可提供與事件處理程序類似的方法掛鉤，以便開發(fā)者決定是否實(shí)現(xiàn)。如果開發(fā)者不提供實(shí)現(xiàn)，則編譯器在編譯時刪除簽名。以下條件適用于分部方法：

聲明必須以上下文關(guān)鍵字 partial 開頭。
分部類型各部分中的簽名必須匹配。
構(gòu)造函數(shù)、終結(jié)器、重載運(yùn)算符、屬性聲明或事件聲明中不允許使用 partial 關(guān)鍵字。

例如：

namespace PM
{
    partial class A
    {
        partial void OnSomethingHappened(string s);
    }

    // This part can be in a separate file.
    partial class A
    {
        // Comment out this method and the program
        // will still compile.
        partial void OnSomethingHappened(String s)
        {
            Console.WriteLine("Something happened: {0}", s);
        }
    }
}

在以下情況下，不需要使用分部方法即可實(shí)現(xiàn)：