Projenin başında bir mimari diyagram çizilir.
Kutular ve oklar. Sipariş modülü fatura modülünü sadece belirli bir API üzerinden çağırır. Domain katmanı altyapıya bağımlı değildir.
Bir yıl sonra kodda şu satır vardır:
import com.example.billing.internal.InvoiceRepository;
Sipariş modülü, fatura modülünün repository’sine doğrudan erişiyor.
Kimse bilerek yapmadı. Bir hata düzeltilirken, bir deadline yetiştirilirken, IDE’nin önerdiği ilk import kabul edildi.
Diyagram hâlâ aynı. Kod artık başka bir şey anlatıyor.
Mimari kurallar dokümanda kalırsa
Mimari kurallar genellikle bir wiki sayfasında veya bir ADR’de yazılıdır. Code review sırasında bu kuralları hatırlamak reviewer’ın dikkatine kalır.
Yüzlerce dosyalık bir pull request’te tek bir import satırını fark etmek zordur.
Kurallar otomatik olarak kontrol edilmedikçe, zamanla aşınması kaçınılmazdır.
ArchUnit
ArchUnit, Java kodunun yapısını analiz edip mimari kuralları birim testleri olarak yazmayı sağlayan bir kütüphane.
Katman kuralı:
@ArchTest
static final ArchRule layers = layeredArchitecture()
.consideringAllDependencies()
.layer("Web").definedBy("..web..")
.layer("Service").definedBy("..service..")
.layer("Persistence").definedBy("..persistence..")
.whereLayer("Web").mayNotBeAccessedByAnyLayer()
.whereLayer("Service").mayOnlyBeAccessedByLayers("Web")
.whereLayer("Persistence").mayOnlyBeAccessedByLayers("Service");
Modül sınırı:
@ArchTest
static final ArchRule billingInternals = noClasses()
.that().resideOutsideOfPackage("..billing..")
.should().dependOnClassesThat()
.resideInAPackage("..billing.internal..");
Biri fatura modülünün iç sınıflarını import ettiğinde test kırılır. Hata mesajı hangi sınıfın hangi kuralı ihlal ettiğini açıkça söyler.
Kural artık bir öneri değil, build’in parçası.
Döngüsel bağımlılıklar
Modüller arasındaki döngüsel bağımlılıklar, bir modüler monolitin zamanla büyük bir çamur topuna dönüşmesinin en tipik işaretlerinden biri.
@ArchTest
static final ArchRule noCycles = slices()
.matching("com.example.(*)..")
.should().beFreeOfCycles();
Sipariş modülü faturayı, fatura modülü siparişi çağırıyorsa bu test kırılır. Döngü, iki modülün aslında ayrı olmadığını gösterir.
Mevcut projeye eklemek
Yıllardır geliştirilen bir projeye ArchUnit eklendiğinde, kuralların ilk çalıştırmada yüzlerce ihlal bulması muhtemeldir.
Hepsini düzeltmeden testi aktif etmek mümkün değil gibi görünür. ArchUnit’in freezing rules özelliği bunun için var. Mevcut ihlaller bir dosyaya kaydedilir ve kabul edilir. Test sadece yeni ihlallerde kırılır.
Mevcut borç görünür hale gelir ama büyümesi durur. Ekip zamanla mevcut ihlalleri azaltabilir.
Spring Modulith
Spring tabanlı projelerde Spring Modulith de benzer bir amaca hizmet ediyor. Ana paket altındaki her alt paketi bir modül kabul ediyor, modüller arası erişimi doğruluyor ve modül yapısının dokümantasyonunu üretebiliyor.
Modüller arası iletişimi uygulama event’leri üzerinden kurmayı ve modülleri izole şekilde test etmeyi de kolaylaştırıyor.
Kurallar az ve net olmalı
Her şeyi kurala bağlamak, testleri kırılgan ve can sıkıcı hale getirir. Ekip kuralları aşmanın yollarını aramaya başlar.
Bence birkaç temel kural yeterli: modüllerin iç paketlerine dışarıdan erişim olmaması, döngüsel bağımlılık olmaması ve domain kodunun altyapı detaylarına bağımlı olmaması.
Mimari, diyagramlarda değil kodda yaşar.
Ve kodun mimariye uyup uymadığını her commit’te hatırlatan bir test, en ikna edici dokümantasyondur.
