OutSystems Mimarisinde Modüllerin İsimlendirilmesi

OutSystems Mimari Framework’ünü kullanarak bir uygulama geliştirirken farklı modülleri farklı katmanlarda kullanırız ve genellikle her bir modül farklı bir amaca hizmet eder. Yaptığınız uygulamaya aşina olmayan birisi için isimlendirilmemiş modüllerin kullanılıyor olması bu modüllerin hangi amaç ile kullanıldığının anlaşılmasını zorlaştırabilir. Bu yüzden, bu gibi durumlarda modülleri uygun şekilde isimlendirmek işleri kolaylaştırmak ve anlaşılabilirliği arttırmak için kullanışlı bir çözüm olabilir.

Bunun yanı sıra modülleri isimlendirmek bize bazı avantajlar da sağlar.

Resimdeki örneğe baktığımız zaman hangi modülün hangi amaca hizmet ettiğini anlamak zor olabilir. Bu sorunun üstesinden gelebilmek için modüllerin isimlendirilmesi hem geliştiricinin hem de uygulama hakkında daha az bilgiye sahip bir kişinin anlayabilmesi için iyi bir çözüm olacaktır.

Peki modülleri nasıl isimlendiriyoruz? OutSystems Mimari Framework’ü ile uygulama geliştirirken Foundation, Core ve End-User olmak üzere 3 farklı katmanda modüllerimizi ayırıyorduk. Bunları ayrı ayrı incelersek Foundation Katmanında bulunan gelen kütüphane modülleri için modülün sonuna “_Lib” sonekini eklemeliyiz. Modülümüzde üçüncü parti kütüphaneler (Plugin) kullanıyor isek “_Plug” sonekini modül ismine ekliyoruz. Modülde tekrar kullanılabilir UI şablonları kullanıyor ve bunlar herhangi bir business logic içermiyorsa “_PAT” sonekini ekliyoruz. Sayfanın tasarımı, görünümü, elemenler, menü gibi öğeleri içeren modüllerde “_TH” sonekini kullanabiliriz. Harici bir hizmeti consume etmek ve normalleştirmek için kullandığımız Integration Service modüllerinde “_IS” sonekini kullanıyoruz. Driver modülleri için ise “_Drv” son ekini modül ismine ekliyoruz. Eğer mobil için bir modül geliştiriyor isek _ sonrasına M ekleyerek Mobil olduğunu belirtebiliriz. (örnek _MTh,_MPat..)

Core Modüllerinde isimlendirmeye baktığımız zaman ise public entity, action ve blok içeren yeniden kullanılabilir core servisleri için “_CS” sonekini kullanıyoruz. İsole Edilmiş Business Logic ve Core Wigdetları için “_BL” ve “_CW” soneklerini ekleyebilirsiniz. Karmaşık hesaplamalar yaptığımız (örneğin bir fatura hesaplama motoru veya bir sigorta simülatörü) business logiclerde Modül “_BL” soneki yerine “_Eng” sonekini kullanıyor olmalıdır. Verileri senkronize etmemiz gereken durumlar olabilir. Bu durumda modülde “_Sync” soneki bulunmalıdır. Eğer dış kullanıcılara bir API’yi açık hale getiren, çekirdek hizmetlerin sistemlerden bağımsız kalmasını veAPI’nin çeşitli sürümlerini destekleyen bir modül geliştiriyorsak “_API” sonekini modüle eklemeliyiz. Foundation modüllerinde olduğu gibi eğer mobil için bir modül geliştiriyor isek _ sonrasına M ekleyerek Mobil olduğunu belirtebiliriz. (Örnek _MCS, _MBL, _MCW…).

End-User modüllerini isimlendirmeye geldiğimiz zaman, modül ismi kullanıcının erişeceği URL’nin son kısmı olarak karşımıza çıkar. Burada önerilen modül isimlendirmesi, isimlendirmeni olabildiğince kısa olması, kullanıcı için anlamlı olması ve direkt olmasıdır.

Örnek Modül İsimlendirmesi

OutSystems Modül İsimlendirmesi CheatSheet

Takıldığınız yerlerde yukarıdaki cheatsheeti kullanabilirsiniz. Burada anlattığımız isimlendirme OutSystems tarafından önerilen yöntemdir. Takibi bu isimlendirmeyi kullanmak zorunda değilsiniz, isterseniz kendi isimlendirmenizi oluşturup onu da kullanabilirsiniz. Unutmayalım ki İyi bir mimari, soyutlama, yeniden kullanılabilir hizmetler, izole edilmiş son kullanıcı süreçleri ve yönetilen referansları teşvik etmeyi amaçlar.