掌握 DRY 原則：在 C# 中應用設計模式以撰寫更乾淨的程式碼

步驟和範例：

1. 初始程式碼：生成員工ID的邏輯直接在按鈕的單擊事件處理程式中。

   

2. 重構程式碼：Tim通過使其更靈活改進了該方法。 此方法現在不再依賴特定的UI元素，而是接受lastName作為參數並返回生成的ID。 此更改允許方法在各種上下文和UI元素中使用：

   private string GenerateEmployeeID(string firstName, string lastName)
   {
     string employeeID = firstName.Substring(0, 4) + lastName.Substring(0, 4) + DateTime.Now.Millisecond.ToString();
     return employeeID;
   }

   private string GenerateEmployeeID(string firstName, string lastName)
   {
     string employeeID = firstName.Substring(0, 4) + lastName.Substring(0, 4) + DateTime.Now.Millisecond.ToString();
     return employeeID;
   }

   隨後，Tim演示了如何從單擊事件中調用此方法：

   employeeIdText.Text = GenerateEmployeeID(firstNameText.Text, lastNameText.Text);

   employeeIdText.Text = GenerateEmployeeID(firstNameText.Text, lastNameText.Text);

   他還指出，此方法現在可在應用程式的其他部分使用，例如在處理具有多個員工記錄的CSV文件時，而不用重複程式碼。

步驟和範例：

1. 建立類庫：

   • Tim在(9:47)建立了一個新的.NET Framework類庫專案，命名為DRYDemoLibrary。

   • 在這個庫中，他定義了一個公共類GenerateEmployeeID方法移動到此類中：

     public class EmployeeProcessor
     {
      public string GenerateEmployeeID(string firstName, string lastName)
      {
         string employeeID = firstName.Substring(0, 4) + lastName.Substring(0, 4) + DateTime.Now.Millisecond.ToString();
         return employeeID;
      }
     }

     public class EmployeeProcessor
     {
      public string GenerateEmployeeID(string firstName, string lastName)
      {
         string employeeID = firstName.Substring(0, 4) + lastName.Substring(0, 4) + DateTime.Now.Millisecond.ToString();
         return employeeID;
      }
     }

2. 在專案中使用類庫：

   • 在他的WinForms (13:18)和WPF專案(14:00)中，Tim新增了一個對DRYDemoLibrary類庫的引用。

   • 然後，他用來自類庫的GenerateEmployeeID方法的調用替換了舊程式碼：

     EmployeeProcessor processor = new EmployeeProcessor();
     employeeIDText.Text = processor.GenerateEmployeeID(firstNameText.Text, lastNameText.Text);

     EmployeeProcessor processor = new EmployeeProcessor();
     employeeIDText.Text = processor.GenerateEmployeeID(firstNameText.Text, lastNameText.Text);

   • 這種方法消除冗餘，因為方法現在被維護在一個地方。 Tim演示了同一類庫可以在不同的UI框架（WinForms和WPF）中使用而不需重複程式碼。

3. 優點：

   • 一致性：通過在類庫中集中邏輯，Tim確保對邏輯的更改（如錯誤修復）將被一致地應用於所有專案。

   • 減少維護：方法中的更改只需在類庫中進行，避免不一致並減少維護開銷。

步驟和範例：

1. 建立新解決方案和專案：

   • Tim 在(17:29)中以建立主控台應用程式的新解決方案開始，模擬在不同型別專案（如Windows服務或主控台應用程式）中需要使用DRYDemoLibrary的場景。

   • 他將新專案命名為ConsoleUI，並展示了如何設置基本的主控台應用程式。

     class Program
     {
      static void Main(string[] args)
      {
         Console.ReadLine();
      }
     }

     class Program
     {
      static void Main(string[] args)
      {
         Console.ReadLine();
      }
     }

2. 新增類庫的引用：

   • Tim解釋了如何在新專案中新增對DRYDemoLibrary DLL的引用。 這涉及瀏覽類庫專案bin文件夾中的DLL文件，並將其新增到主控台應用程式中。

     using DRYDemoLibrary;

     using DRYDemoLibrary;

   • 新增引用後，Tim (19:24) 使用庫中的EmployeeProcessor類根據使用者輸入生成員工ID。

     Console.WriteLine("What is your first name?");
     string firstName = Console.ReadLine();
     
     Console.WriteLine("What is your last name?");
     string lastName = Console.ReadLine();
     
     EmployeeProcessor processor = new EmployeeProcessor();
     string employeeID = processor.GenerateEmployeeID(firstName, lastName);
     
     Console.WriteLine($"Your employee ID is {employeeID}");

     Console.WriteLine("What is your first name?");
     string firstName = Console.ReadLine();
     
     Console.WriteLine("What is your last name?");
     string lastName = Console.ReadLine();
     
     EmployeeProcessor processor = new EmployeeProcessor();
     string employeeID = processor.GenerateEmployeeID(firstName, lastName);
     
     Console.WriteLine($"Your employee ID is {employeeID}");

3. 運行主控台應用程式：

   • Tim演示了運行主控台應用程式，顯示它使用該庫成功生成了員工ID。 這確認了來自類庫的同一程式碼可以在不同的專案中重用。

     

4. 更新DLL：

   • Tim簡要提到如果DLL更改，可以在引用它的專案中進行更新。 他指出，儘管此影片未詳細介紹，但使用NuGet包是管理和更新多個專案中DLL的推薦方法。

重點：

1. 建立NuGet包：

   • Tim建議將類庫打包為NuGet包，而不是手動管理DLL文件。 這涉及將DLL打包到NuGet包並將其上傳到NuGet伺服器（私有或公共）。

2. 更新包：

   • 使用NuGet包可以簡單地通過更新包版本來更新引用類庫的所有專案。 這確保了一致性並降低了版本不匹配或更新丟失的風險。

3. 效益：

   • 集中管理：NuGet包提供了一種集中管理庫版本和依賴的方法。

   • 易於更新：跨多個專案更新庫變得更容易且更可靠。

   • 整合：NuGet與各種開發工具和環境整合，簡化管理庫依賴的過程。

初始測試設置

Tim首先運行一個因DLL中的錯誤而目前失敗的單元測試。 他強調了單元測試在發現問題中的重要性，儘管程式碼在主解決方案之外。 程式碼預期從四個字母的輸入中，但是Tim傳遞了一個三字母的名字，導致DLL文件出現崩潰，即使它未直接包含在解決方案中。

重構程式碼以解決錯誤

為了解決名字處理的問題，Tim重構了程式碼。 他解釋了如何通過建立一個新的類庫專案（23:50）來應用DRY於開發。 此方法確保對多個物件的更改可以一次完成，並在無需重複修復的情況下有效地測試。

新增單元測試

Tim在類庫專案中引入了一個名為EmployeeProcessorTest的新測試類，並使用XUnit設置單元測試。 他演示了如何建立生成員工ID的測試方法，並討論了模擬依賴而非依賴實際值的重要性。

寫測試方法

Tim編寫了一個名為GenerateEmployeeID_ShouldCalculate的單元測試方法。 他設置了一個帶內聯資料的理論以測試不同場景，確保方法返回預期結果。 他還解釋了如何使用Assert.Equal來驗證輸出。

public class EmployeeProcessorTest
{
   [Theory]
   [InlineData("Timothy", "Corey", "TimoCore")]
   public void GenerateEmployeeID_ShouldCalculate(string firstName, string lastName, string expectedStart)
   {
      // Arrange
      var processor = new EmployeeProcessor();

      // Act
      var actualStart = processor.GenerateEmployeeID(firstName, lastName).Substring(0, 8);

      // Assert
      Assert.Equal(expectedStart, actualStart);
   }
}

public class EmployeeProcessorTest
{
   [Theory]
   [InlineData("Timothy", "Corey", "TimoCore")]
   public void GenerateEmployeeID_ShouldCalculate(string firstName, string lastName, string expectedStart)
   {
      // Arrange
      var processor = new EmployeeProcessor();

      // Act
      var actualStart = processor.GenerateEmployeeID(firstName, lastName).Substring(0, 8);

      // Assert
      Assert.Equal(expectedStart, actualStart);
   }
}

運行單元測試

Tim強調模擬動態資料（如日期和時間值）以控制測試條件和結果的重要性。 他討論了處理動態字串的挑戰，以及如何使用受控值測試不同情況。 隨後，他運行單元測試，但在此之前，他新增了兩個運行測試所需的NuGet包：xunit.runner.visualstudio。

在成功運行對一個內聯資料的所有測試後，輸出如下：

現在，在(31:30)，Tim新增了另一個內聯資料並將子字串的第二個參數更改為expectedStart.Length：

public class EmployeeProcessorTest
{
   [Theory]
   [InlineData("Timothy", "Corey", "TimoCore")]
   [InlineData("Tim", "Corey", "TimCore")]
   public void GenerateEmployeeID_ShouldCalculate(string firstName, string lastName, string expectedStart)
   {
      var processor = new EmployeeProcessor();
      var actualStart = processor.GenerateEmployeeID(firstName, lastName).Substring(0, expectedStart.Length);
      Assert.Equal(expectedStart, actualStart);
   }
}

public class EmployeeProcessorTest
{
   [Theory]
   [InlineData("Timothy", "Corey", "TimoCore")]
   [InlineData("Tim", "Corey", "TimCore")]
   public void GenerateEmployeeID_ShouldCalculate(string firstName, string lastName, string expectedStart)
   {
      var processor = new EmployeeProcessor();
      var actualStart = processor.GenerateEmployeeID(firstName, lastName).Substring(0, expectedStart.Length);
      Assert.Equal(expectedStart, actualStart);
   }
}

在(32:05)再次運行單元測試，第二個理論的測試失敗：

通過私有方法提高程式碼

為了遵循DRY，Tim進一步重構程式碼，通過在DRYDemoLibrary下的實際GetPartOfName。 此方法處理部分名字的提取，提高了程式碼可重用性和可讀性。 Tim進行了以下更改：

public string GenerateEmployeeID(string firstName, string lastName)
{
   string employeeID = $@"{GetPartOfName(firstName, 4)}{GetPartOfName(lastName, 4)}{DateTime.Now.Millisecond.ToString()}";
   return employeeID;
}

private string GetPartOfName(string name, int numberOfCharacters)
{
   string output = name;

   if (name.Length > numberOfCharacters)
   {
      output = name.Substring(0, numberOfCharacters);
   }

   return output;
}

public string GenerateEmployeeID(string firstName, string lastName)
{
   string employeeID = $@"{GetPartOfName(firstName, 4)}{GetPartOfName(lastName, 4)}{DateTime.Now.Millisecond.ToString()}";
   return employeeID;
}

private string GetPartOfName(string name, int numberOfCharacters)
{
   string output = name;

   if (name.Length > numberOfCharacters)
   {
      output = name.Substring(0, numberOfCharacters);
   }

   return output;
}

更新單元測試

Tim更新了單元測試以反映程式碼中的更變，例如修改子字串的預期長度。 他解釋了運行這些測試如何快速識別問題並確認程式碼符合新要求。 Tim新增了新理論，然後運行單元測試以驗證輸出是否符合預期：

建立.NET Standard庫

減少開發中的重複

Tim Corey強調，通過採用.NET Standard類庫，您不僅在程式碼庫中最小化程式碼重複，也在開發過程中最小化。 而不是在不同平台專案中重複程式碼，您可以在一個通用的庫中集中它，適用於多個環境。

效益：

• 統一程式碼庫：對於各種平台只有一個程式碼庫，減少了維護和更新程式碼所需的 effort。
• 簡化的測試：通過.NET Standard庫，您可以一次性編寫單元測試，確保它們適用於所有支持的平台。

測試和除錯：Tim介紹了自動化測試作為進一步減少 effort 和重複的一種方法。 自動化測試證明您的程式碼正確無誤而不需要手動測試每個應용程式的迭代版本。