DRY İlkesini Ustalaşmak: Daha Temiz Kod için C#'ta Tasarım Desenleri Uygulama

Adımlar ve Örnek:

1. İlk Kod: Çalışan kimlik numarası oluşturma mantığı bir butonun tıklama olay işleyicisinde doğrudan idi.

   

2. Yeniden Düzenlenmiş Kod: Tim metodu daha esnek hale getirerek iyileştiriyor. Belirli UI öğelerine güvenmek yerine, yöntem artık firstName ve lastName parametre olarak kabul eder ve üretilen kimliği döndürür. Bu değişiklik, metodun çeşitli bağlamlarda ve UI elemanlarında kullanılmasına olanak sağlar:

   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 daha sonra bu methodun tıklama olayından nasıl çağrıldığını gösteriyor:

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

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

   Ayrıca bu metodun artık uygulamanın diğer bölümlerinde, çoklu çalışan kayıtlarıyla CSV dosyalarını işlerken tekrar edilmeden kullanılabileceğini de belirtiyor.

Adımlar ve Örnek:

1. Sınıf Kütüphanesi Oluşturma:

   • Tim (9:47)'de .NET Framework'te yeni bir sınıf kütüphanesi projesi oluşturarak DRYDemoLibrary adını veriyor.

   • Bu kütüphanenin içinde, o, bir public class EmployeeProcessor tanımlar ve GenerateEmployeeID yöntemini bu sınıfa taşır:

     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. Projelerde Sınıf Kütüphanesi Kullanma:

   • WinForms (13:18) ve WPF projelerinde (14:00), Tim DRYDemoLibrary sınıf kütüphanesine bir referans ekler.

   • Ardından eski kodu, bu sınıf kütüphanesinden GenerateEmployeeID yöntemine yapılan çağrılarla değiştirir:

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

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

   • Bu yaklaşım, metodun artık tek bir yerde sürdürüldüğü için tekrarı ortadan kaldırır. Tim aynı sınıf kütüphanesinin, kodu tekrar etmeden farklı UI çerçeveleri (WinForms ve WPF) üzerinden kullanılabileceğini gösterir.

3. Avantajlar:

   • Tutarlılık: Tim, mantığı bir sınıf kütüphanesinde merkezileştirme yoluyla, mantık değişikliklerinin (örneğin, hata düzeltmeleri) tüm projeler arasında eşit şekilde uygulandığını sağlar.

   • Bakımının Azaltılması: Metot değişiklikleri sadece sınıf kütüphanesinde yapılmalıdır, bu da tutarsızlıkları önler ve bakım yükünü azaltır.

Adımlar ve Örnek:

1. Yeni Bir Çözüm ve Proje Oluşturma:

   • Tim (17:29)'da, farklı bir proje türünde, örneğin bir Windows hizmeti veya konsol uygulaması varolması gerektiği bir senaryoyu simüle ederek bir konsol uygulama için yeni bir çözüm oluşturmaya başlar.

   • Yeni projeye ConsoleUI adını verir ve nasıl bir temel konsol uygulaması kurulacağını gösterir.

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

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

2. Sınıf Kütüphanesine Referans Ekleme:

   • Tim, yeni projeye DRYDemoLibrary DLL'ine bir referansın nasıl ekleneceğini açıklar. Bu, sınıf kütüphanesi projesinin bin klasöründeki DLL dosyasına geçip, konsol uygulamasına eklemeyi içerir.

     using DRYDemoLibrary;

     using DRYDemoLibrary;

   sınıfı

     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. Konsol Uygulamasını Çalıştırma:

   • Tim, kütüphaneyi kullanarak başarılı bir şekilde çalışan kimlik numarası oluşturduğunu göstermek için konsol uygulamasını çalıştırmayı gösterir. Bu, sınıf kütüphanesinden gelen kodun farklı projelerde yeniden kullanılabilir olduğunu doğrular.

     

4. DLL'yi Güncelleme:

   • Tim, kısa bir şekilde eğer DLL değişirse, onu başvuru projelerde güncelleyebileceğinizi belirtir. Bu videoda detaya yer verilmemiş olsa da, birden çok projede DLL'leri yönetmek ve güncellemek için NuGet paketlerini kullanmanın önerilen bir yaklaşım olduğunu belirtir.

Ana Noktalar:

1. Bir NuGet Paketi Oluşturma:

   • Tim, DLL dosyalarını elle yönetmek yerine sınıf kütüphanesi için bir NuGet paketi oluşturmayı önerir. Bu, DLL'i bir NuGet paketine paketlemeyi ve bir NuGet sunucusuna (özel veya genel) yüklemeyi içerir.

2. Paketleri Güncelleme:

   • Bir NuGet paketi kullanarak, referans yerine, yalnızca paket sürümünü güncelleyerek kütüphaneyi tüm projeler arasında güncelleyebilirsiniz. Bu, tutarlılığı sağlama ve sürüm eşleşmezliklerini ya da eksik güncellemeleri önleme bakımından dikkat çeker.

3. Faydalar:

   • Merkezi Yönetim: NuGet paketleri, kütüphane sürümlerini ve bağımlılıklarını yönetmek için merkezi bir yol sunar.

   • Kolay Güncellemeler: Birden çok proje üzerinde kütüphaneyi güncellemek daha kolay ve daha güvenilir hale gelir.

   • Entegrasyon: NuGet, çeşitli geliştirme araçları ve ortamlarıyla entegrasyon kardeştirir ve kütüphane bağımlılıklarını yönetme sürecini kolaylaştırır.

İlk Test Kurulumu

Tim, şu anda DLL'deki bir hata nedeniyle başarısız olan bir birim testi yayımlayarak başlıyor. Bu testlerin, kod ana çözümün dışındayken bile sorunları tanımlamada ne kadar önemli olduğunu vurguluyor. Kod, 4 harfli bir girdi bekliyordu, ancak Tim 3 harfli bir ilk ad geçti, bu da DLL dosyasında çökmeye neden oldu, çözüme doğrudan dahil edilmemiş olsa bile.

Hataları Ele Almak İçin Kodu Refaktöre Etmek

İlk ad işleme sorununu ele almak için Tim, kodu yeniden düzenliyor. Geliştirme çalışmalarına DRY uygulanmasını, yeni bir sınıf kütüphanesi projesi oluşturarak (23:50) nasıl yapılacağını açıklıyor. Bu yaklaşım, birden fazla nesneyle ilgili değişikliklerin bir kez yapılmasını ve yinelenen düzeltmelere gerek kalmadan etkili bir şekilde test edilmesini sağlar.

Birim Testlerini Ekleme

Tim, sınıf kütüphanesi projesinde EmployeeProcessorTest adlı yeni bir test sınıfını tanıtıyor ve XUnit kullanarak birim testleri kuruyor. Çalışan kimlikleri oluşturmak için bir test yöntemi nasıl oluşturulacağını gösteriyor ve gerçek değerlere güvenmek yerine bağımlılıkları taklit etmenin önemini tartışıyor.

Bir Test Yöntemi Yazma

Tim, GenerateEmployeeID_ShouldCalculate adlı bir birim test yöntemi yazıyor. Yöntemin beklenen sonuçları döndüreceğini garanti altına almak için farklı senaryoları test etmeye yönelik satır içi verilere sahip bir teori oluşturuyor. Assert.Equal'ı kullanarak çıktıyı nasıl doğrulayabileceğini de açıklıyor.

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);
   }
}

Birim Testini Çalıştırma

Tim, tarih ve saat değerleri gibi dinamik verileri taklit etmenin test koşullarını ve sonuçlarını kontrol etmede ne kadar önemli olduğunu vurguluyor. Dinamik dizelerle çalışma zorluğunu ve farklı senaryoları kontrol edilen değerler kullanarak nasıl test edeceğini tartışıyor. Ardından birim testi çalıştırır, fakat bundan önce testlerin çalışması için gerekli olan iki NuGet paketini ekler: xunit.runner.console ve xunit.runner.visualstudio.

Bir satır içi veri için tüm testleri başarıyla çalıştırdıktan sonra çıkış aşağıdaki gibi gösterilir:

Şimdi (31:30) itibarıyla, Tim başka bir inline data ekledi ve alt dizenin ikinci parametresini expectedStart.Length olarak değiştirdi:

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) İkinci teoriyle birlikte birim testini tekrar çalıştırdıktan sonra test bozuldu:

Özel Yöntemlerle Kodu Geliştirme

Tim, DRY'e uymak için kodu daha fazla yeniden yapılandırarak, gerçek EmployeeProcessor sınıfında DRYDemoLibrary altında GetPartOfName adlı özel bir yöntem oluşturur. Bu yöntem, bir ismin parçalarını ayıklamayı ele alıyor, kodun yeniden kullanılabilirliğini ve okunabilirliğini artırıyor. Tim aşağıdaki değişiklikleri yaptı:

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;
}

Birim Testlerini Güncelleme

Tim, alt dizelerin beklenen uzunluğunun değiştirilmesi gibi koddaki değişikliklere yansıtmak için birim testlerini güncelliyor. Bu testleri çalıştırmanın sorunları hızla tanımlamaya ve kodun yeni gereksinimleri karşıladığını doğrulamaya nasıl yardımcı olacağını açıklıyor. Tim yeni teoriler ekliyor ve sonrasında çıktıların beklenip beklenmediğini doğrulamak için birim testlerini çalıştırıyor:

.NET Standard Kütüphanesi Oluşturma

Geliştirme Sürecinde Tekrarı Azaltma

Tim Corey, .NET Standard kütüphanesi benimseyerek sadece kod tabanındaki değil, geliştirme sürecindeki kod tekrarlarını da en aza indirdiğinizi vurguluyor. Farklı platforma özel projeler arasında kodu çoğaltmak yerine, çeşitli ortamlarda çalışan tek bir kütüphanede merkezi hale getirirsiniz.

Faydalar:

• Birleşik Kod Tabanı: Çeşitli platformlar için tek bir kod tabanı, kodunuzu sürdürme ve güncelleme çabasını azaltır.
• Basitleştirilmiş Test: Bir .NET Standard kütüphanesi ile, birim testlerini bir kez yazabilir ve tüm desteklenen platformlar için geçerli olduklarını doğrulayabilirsiniz.

Test ve Hata Ayıklama: Tim, çabayı ve tekrarı daha da azaltmanın bir yolu olarak birim testlerini tanıtıyor. Otomatik testler, her uygulama yinelemesini manuel olarak test etme ihtiyacı olmadan kodunuzun doğruluğunu doğrular.