C# 中的版本控制

發行項
05/09/2023

在本教學課程中，您會了解版本控制在 .NET 中的意義。您也會了解進行程式庫版本控制以及升級成新版程式庫時要考量的因素。

撰寫程式庫

身為已建立公用用途 .NET 程式庫的開發人員，您很可能經歷過必須推出新更新的情況。如何執行此程序影響重大，因為您需要確保現有程式碼能夠順暢轉換到新版文件庫。以下是建立新版本時要考量的幾件事︰

語意版本控制

語意版本控制 (簡稱為 SemVer) 是文件庫各版本套用的命名慣例，表示特定的重大事件。理想情況是，您提供給文件庫的版本資訊應該能幫助開發人員判斷其與使用同一文件庫舊版本的專案是否相容。

SemVer 最基本的方法是 3 元件格式 MAJOR.MINOR.PATCH，其中：

當您進行不相容的 API 變更時會遞增 MAJOR
當您以回溯相容方式新增功能時會遞增 MINOR
當您進行回溯相容的 Bug 修正時會遞增 PATCH

將版本資訊套用至您的 .NET 程式庫時，還有其他方式可以指定其他狀況，例如發行前版本等等。

回溯相容性

當您發行新版文件庫時，與舊版相容會是您的主要考量之一。如果相依於前一版的程式碼在重新編譯時，能在新版正常運作，新舊兩版的文件庫就是來源相容。如果相依於舊版的應用程式在未重新編譯的情況下，能在新版正常運作，新舊兩版的文件庫就是二進位相容。

以下是嘗試維持與舊版文件庫的相容性時要考慮的一些事項︰

虛擬方法︰當您在新版本中將虛擬方法變成非虛擬，表示必須更新覆寫該方法的專案。這是一項極重大的變更，強烈建議您不要這麼做。
方法簽章︰更新方法行為時也會要求您變更其簽章，您應該改建立多載，讓呼叫該方法的程式碼仍然可以運作。您可以一直使用舊的方法簽章呼叫新方法簽章，讓實作保持一致。
Obsolete 屬性︰您可以在程式碼中使用這個屬性，指定未來版本中要取代及可能移除的類別或類別成員。這可確保使用您文件庫的開發人員在面對重大變更時有更完善的準備。
選擇性的方法引數︰當您將先前的選擇性方法引數變為強制，或是變更其預設值後，所有不提供這些引數的程式碼都需要更新。

注意

將強制引數變成選擇性應該沒什麼效果，特別是如果它不變更方法行為時。

使用者升級至新版文件庫的過程愈簡單，他們就愈可能快速升級。

應用程式組態檔

身為 .NET 開發人員，您在大多數的專案類型中，有很大的機會遇到app.config 檔案。這個簡單的組態檔要很長時間才能改善推出新的更新。文件庫的設計通常應該是將可能定期變更的資訊儲存在 app.config 檔案中，因此當這類資訊更新時，只要將舊版的組態檔替換成新版即可，不需要重新編譯文件庫。

使用文件庫

身為使用其他開發人員所組建的 .NET 文件庫的開發人員，您很清楚新版文件庫可能無法與您的專案完全相容，而您可能必須經常更新自己的程式碼，才能使用這些變更。

幸而 C# 和 .NET 生態系統隨附的功能和技巧讓我們能輕鬆更新應用程式，使用可能會推出重大變更的新版程式庫。

組件繫結重新導向

您可以使用 app.config 檔案更新應用程式使用的文件庫版本。新增所謂的繫結重新導向，您可以使用新的文件庫版本，而不必重新編譯應用程式。下例示範如何更新應用程式的 app.config 檔案，使用 ReferencedLibrary 的 1.0.1 修補版本，不使用原先編譯的 1.0.0 版。

<dependentAssembly>
    <assemblyIdentity name="ReferencedLibrary" publicKeyToken="32ab4ba45e0a69a1" culture="en-us" />
    <bindingRedirect oldVersion="1.0.0" newVersion="1.0.1" />
</dependentAssembly>

注意

新版 ReferencedLibrary 與您的應用程式必須是二進位相容，才能使用這個方法。如需決定相容性時需要留意的變更，請參閱前文的回溯相容性一節。

new

您使用 new 修飾詞隱藏繼承的基底類別成員。這是衍生類別可以回應基底類別更新的一種方式。

以下列範例為例：

public class BaseClass
{
    public void MyMethod()
    {
        Console.WriteLine("A base method");
    }
}

public class DerivedClass : BaseClass
{
    public new void MyMethod()
    {
        Console.WriteLine("A derived method");
    }
}

public static void Main()
{
    BaseClass b = new BaseClass();
    DerivedClass d = new DerivedClass();

    b.MyMethod();
    d.MyMethod();
}

輸出

A base method
A derived method

您在上例中可以看到 DerivedClass 如何隱藏出現在 BaseClass 中的 MyMethod 方法。這表示，當新版文件庫中的基底類別新增您衍生類別中已有的成員時，您只要對衍生類別成員使用 new 修飾詞，就可以隱藏基底類別成員。

未指定任何 new 修飾詞時，衍生類別預設會隱藏基底類別中發生衝突的成員，雖然會產生編譯器警告，但程式碼仍會編譯。這表示，只要將新成員新增至現有的類別，即可讓新版文件庫與與相依於它的程式碼為來源和二進位相容。

override

override 修飾詞表示衍生的實作會擴充基底類別成員的實作，而非隱藏它。基底類別成員需要套用 virtual 修飾詞。

public class MyBaseClass
{
    public virtual string MethodOne()
    {
        return "Method One";
    }
}

public class MyDerivedClass : MyBaseClass
{
    public override string MethodOne()
    {
        return "Derived Method One";
    }
}

public static void Main()
{
    MyBaseClass b = new MyBaseClass();
    MyDerivedClass d = new MyDerivedClass();

    Console.WriteLine("Base Method One: {0}", b.MethodOne());
    Console.WriteLine("Derived Method One: {0}", d.MethodOne());
}

輸出

Base Method One: Method One
Derived Method One: Derived Method One

override 修飾詞會在編譯期間評估，如果編譯器找不到要覆寫的虛擬成員，它會擲回錯誤。

您對前述技巧的掌握以及使用時機的瞭解，需要一段時間才能讓您輕鬆轉換版本。