Posted by Merhaba arkadaşlar, bu yazımda sizlere SonarQube Code Smell Uyarıları konusundan bahsedeceğim.
Kod yazarken sadece çalışan bir uygulama oluşturmak yeterli değildir; kodun okunabilir, bakımı kolay ve performanslı olması da önemlidir. SonarQube, yazılan kodun kalitesini ölçmek için kullanılan popüler bir aracır ve “Code Smell” uyarıları bu yolda önemli bir rehberdir. Bu yazıda, yaygın code smell uyarılarına örnekler ve çözüm yolları sunulmuştur.
1. Uzun Metotlar
Uyarı: “This method has X lines, which is greater than the X lines authorized. Split it into smaller methods.”
Problem:
Uzun metotlar kodun anlaşılırlığını zorlarken tekrar eden veya birden fazla sorumluluğu olan kod blokları barındırabilir.
Kod Örneği (Hatalı):
public void ProcessData(List<int> data)
{
foreach (var item in data)
{
// Veriyi temizleme
var cleanData = item.ToString().Trim();
// Veriyi dönüştürme
int processedData = int.Parse(cleanData);
// Veriyi kaydetme
SaveData(processedData);
}
}Çözüm:
Metodu parçalara bölerek her bir sorumluluğu ayrı bir metoda taşıyın.
Kod Örneği (Düzenlenmiş):
public void ProcessData(List<int> data)
{
foreach (var item in data)
{
var cleanData = CleanData(item);
var processedData = TransformData(cleanData);
SaveData(processedData);
}
}
private string CleanData(int item)
{
return item.ToString().Trim();
}
private int TransformData(string data)
{
return int.Parse(data);
}
private void SaveData(int data)
{
// Kaydetme işlemi
}2. Magic Number Kullanımı
Uyarı: “Define a constant instead of duplicating this literal X times.”
Problem:
Kodda sabit değerlerin (magic number) kullanılması, kodun anlaşılırlığını zorlaştırır ve gelecekte yapılacak değişiklikleri riskli hale getirir.
Kod Örneği (Hatalı):
if (age > 18)
{
Console.WriteLine("Erişime izin verildi.");
}Çözüm:
Magic numberı anlamlı bir sabit ile değiştirin.
Kod Örneği (Düzenlenmiş):
private const int MinimumAge = 18;
if (age > MinimumAge)
{
Console.WriteLine("Erişime izin verildi.");
}3. Hatalı Değişken İsimlendirme
Uyarı: “Rename this variable to match the regular expression: [a-z][a-zA-Z0-9]*.”
Problem:
Anlamlı olmayan değişken isimleri, kodun okunabilirliğini olumsuz etkiler.
Kod Örneği (Hatalı):
int x = 100;
int y = 200;
int z = x + y;Çözüm:
Değişkenleri neyi temsil ettiğine dair anlamlı isimlerle değiştirin.
Kod Örneği (Düzenlenmiş):
int width = 100;
int height = 200;
int area = width + height;4. Boş Catch Blokları
Uyarı: “Avoid empty catch blocks.”
Problem:
Hata yönetiminin yapılmaması hata ayıklama ve loglama süreçlerini zorlaştırır.
Kod Örneği (Hatalı):
try
{
var data = File.ReadAllText("path/to/file");
}
catch (Exception)
{
}Çözüm:
Hata durumunda loglama veya uygun bir yönetim ekleyin.
Kod Örneği (Düzenlenmiş):
try
{
var data = File.ReadAllText("path/to/file");
}
catch (Exception ex)
{
Console.WriteLine($"Hata: {ex.Message}");
// Alternatif olarak loglama kütüphanesi kullanabilirsiniz.
}5. Gereksiz Return Değeri
Uyarı: “Remove this unnecessary ‘return’ statement.”
Problem:
Gereksiz return ifadeleri kodu karmaşık hale getirir.
Kod Örneği (Hatalı):
public bool IsPositive(int number)
{
if (number > 0)
{
return true;
}
else
{
return false;
}
}Çözüm:
Kodu sadeleştirin.
Kod Örneği (Düzenlenmiş):
public bool IsPositive(int number)
{
return number > 0;
}6. Fazladan Yorumlar
Uyarı: “Remove this commented out code.”
Problem:
Gereksiz yorum satırları kodun okunabilirliğini azaltır.
Kod Örneği (Hatalı):
public void Calculate()
{
// var unusedValue = 42;
Console.WriteLine("Calculation done.");
}Çözüm:
Gereksiz yorum satırları kaldırın.
Kod Örneği (Düzenlenmiş):
public void Calculate()
{
Console.WriteLine("Calculation done.");
}7. Gereksiz Değişken Atamaları
Uyarı: “Remove this useless assignment to local variable.”
Problem:
Gereksiz atamalar bellek ve performans sorunları yaratabilir.
Kod Örneği (Hatalı):
int result = 0;
result = Add(5, 3);Çözüm:
Atamayı doğrudan yapın.
Kod Örneği (Düzenlenmiş):
int result = Add(5, 3);8. Fazla Parametreli Metotlar
Uyarı: “Reduce the number of parameters in this method to make it more manageable.”
Problem:
Çok sayıda parametre, metodu kullanmayı zorlaştırır ve karmaşıklaştırır.
Kod Örneği (Hatalı):
public void CreateUser(string firstName, string lastName, string email, string password, DateTime dateOfBirth)
{
// Kullanıcı oluşturma
}Çözüm:
Bir nesne oluşturarak parametreleri gruplayın.
Kod Örneği (Düzenlenmiş):
public void CreateUser(User user)
{
// Kullanıcı oluşturma
}
}
public class User
{
public string FirstName { get; set; }
public string LastName { get; set; }
public string Email { get; set; }
public string Password { get; set; }
public DateTime DateOfBirth { get; set; }
}9. Null Kontrollerinin Eksik Olması
Uyarı: “Add null checks to prevent possible null reference exceptions.”
Problem:
Null referans hataları uygulamada beklenmeyen hatalara yol açabilir.
Kod Örneği (Hatalı):
Console.WriteLine(user.Name);Çözüm:
Null kontrolü ekleyin.
Kod Örneği (Düzenlenmiş):
if (user != null)
{
Console.WriteLine(user.Name);
}10. Fazla Karmaşık İf Koşulları
Uyarı: “Simplify this conditional expression.”
Problem:
Karmaşık koşullar kodu zor anlaşılır hale getirir.
Kod Örneği (Hatalı):
if ((x > 10 && y < 20) || (z == 30 && x != 15))
{
DoSomething();
}Çözüm:
Koşulları daha anlamlı değişkenlere bölerek basitleştirin.
Kod Örneği (Düzenlenmiş):
bool isWithinRange = x > 10 && y < 20;
bool isSpecialCase = z == 30 && x != 15;
if (isWithinRange || isSpecialCase)
{
DoSomething();
}SonarQube, kod kalitesini artırmak ve sürdürülebilir bir yazılım geliştirme süreci sağlamak için güçlü bir araçtır. Bu yazıda ele alınan code smell örnekleri, daha temiz, okunabilir ve bakımı kolay bir kod tabanı oluşturmanın önemini göstermektedir. Küçük görünen hatalar bile zamanla büyük sorunlara yol açabilir, bu nedenle yazılım geliştirme sürecinde bu tür uyarılara dikkat etmek önemlidir. Kodunuzu düzenli olarak analiz ederek ve iyileştirmeler yaparak sadece hataları önlemekle kalmaz, aynı zamanda daha güvenilir ve profesyonel bir yazılım ortaya çıkarabilirsiniz.
Umarım faydalı olur.
Bir sonraki yazıda görüşmek üzere…