C# partial 說明

weixin_34119545發表於2012-07-30

1. 什麼是區域性型別?

C# 2.0 引入了區域性型別的概念。區域性型別允許我們將一個類、結構或介面分成幾個部分,分別實現在幾個不同的.cs檔案中。

區域性型別適用於以下情況:

(1) 型別特別大,不宜放在一個檔案中實現。
(2) 一個型別中的一部分程式碼為自動化工具生成的程式碼,不宜與我們自己編寫的程式碼混合在一起。
(3) 需要多人合作編寫一個類。

區域性型別是一個純語言層的編譯處理,不影響任何執行機制——事實上C#編譯器在編譯的時候仍會將各個部分的區域性型別合併成一個完整的類。

   public partial class Program
   {
     static void Main(string[] args)
     {
     }
   }

   partial class Program
   { 
     public void Test()
     { 
     }
   }


2. 區域性型別的限制

(1) 區域性型別只適用於類、介面、結構,不支援委託和列舉。
(2) 同一個型別的各個部分必須都有修飾符 partial。
(3) 使用區域性型別時,一個型別的各個部分必須位於相同的名稱空間中。
(4) 一個型別的各個部分必須被同時編譯。

3. 區域性型別的注意點

(1) 關鍵字partial是一個上下文關鍵字,只有和 class、struct、interface 放在一起時才有關鍵字的含義。因此partial的引入不會影響現有程式碼中名稱為partial的變數。
(2) 區域性型別的各個部分一般是分開放在幾個不同的.cs檔案中,但C#編譯器允許我們將他們放在同一檔案中。

4. 區域性型別的應用特性

在區域性型別上的特性具有“累加”效應。

[Attribute1, Attribute2("Hello")]
partial class Class1{}

[Attribute3, Attribute2("Exit")]
partial class Class1{}


相當於

[Attribute1, Attribute2("Hello"), Attribute3, Attribute2("Exit")]
class Class1 {}


注:Attribute2屬性允許在類上多次使用。

5. 區域性型別上的修飾符

(1) 一個型別的各個部分上的訪問修飾符必須維持一致性。
(2) 如果一個型別有一個部分使用了abstract修飾符,那麼整個類都將被視為抽象類。
(3) 如果一個型別有一個部分使用了 sealed 修飾符,那麼整個類都將被視為密封類。
(4) 一個類的各個部分不能使用相互矛盾的修飾符,比如不能在一個部分上使用abstract,又在另一個部分上使用sealed。

6. 區域性型別的基類和介面

(1) 一個型別的各個部分上指定的基類必須一致。某個部分可以不指定基類,但如果指定,則必須相同。
(2) 區域性型別上的介面具有“累加”效應。

partial class Class2: Iinterface1, Iinterface2 {}
partial class Class2: Iinterface3 {}
partial class Class2: Iinterface2 {}


相當於

class Class2: Iinterface1, Iinterface2, Iinterface3 {}




把所有的原始碼作為一個型別儲存在一個單獨的檔案裡是一個好的程式設計習慣,但有時候一個型別變得過於龐大以至於這樣做成為一個不切實際的約束。此外,程式設計人員經常使用原始碼生成器來產生一個應用程式的初始結構,然後再修改產生的程式碼。不幸的是,當原始碼在將來某個時候再次釋出時,已存在的修改就要被覆蓋了。

 

Partial types允許把類,結構和介面打破為多個程式碼碎片存在不同的原始碼檔案,以便於簡化開發和維護。加之partial types允許機器產生的和使用者編寫的型別部分分離,這樣就可以方便增加工具產生的程式碼。

 

Partial,是一個新的型別修飾符,在把一個型別定義在多個部分的時候使用。下面是一個partial class的示例,以兩個部分實現。這兩個部分可能在兩個不同的原始碼檔案,比如說第一個部分是由一個資料庫對映工具產生的,而第二個部分是手工編寫的。

public partial class Customer
{
    private int id;
    private string name;
    private string address;
    private List<Order> orders;
    public Customer() {
        
    }
}
public partial class Customer
{
    public void SubmitOrder(Order order) {
        orders.Add(order);
    }
    public bool HasOutstandingOrders() {
        return orders.Count > 0;
    }
}


當上面的兩個部分在一起編譯,結果產生的程式碼就好像這個類是寫在一個單元裡一樣。

 

public class Customer
{
    private int id;
    private string name;
    private string address;
    private List<Order> orders;
    public Customer() {
        
    }
    public void SubmitOrder(Order order) {
        orders.Add(order);
    }
    public bool HasOutstandingOrders() {
        return orders.Count > 0;
    }
}


一個partial type的所有部分必須在一起編譯,這樣所有的部分才能在編譯的時候整合在一起。特別的是partial types不允許加入已經編譯好的型別。