Partial Class簡介與應用

一、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的定義要求必須唯一，且類名必須相同。