Sınıfları Adlandırma - Her şeyi “<WhatEver> Yöneticisi” olarak adlandırmamak nasıl önlenir? [kapalı]

Uzun zaman önce, beni nesnelerin isimlendirilmesinde "doğru" bir yola sokan bir makale okudum (bir blog girişine inanıyorum): Programınızdaki şeyleri adlandırmak konusunda çok titiz olun.

Örneğin, uygulamam (tipik bir işletme uygulaması olarak) kullanıcıları, şirketleri ve adresleri işleyecek olsaydım a User, a Companyve Addressetki alanı sınıfım olurdu - ve muhtemelen bu şeyleri işleyen a UserManager, a CompanyManagerve a yerlerinde AddressManager.

Yani neyin olanlar söyleyebilir UserManager, CompanyManagerve AddressManagerbunu? Hayır, çünkü Yönetici etki alanı nesnelerinizle yapabileceğiniz her şeye uyan çok genel bir terimdir.

Okuduğum makalede çok özel isimler kullanılması öneriliyor. Bir C ++ uygulaması olsaydı ve UserManagerişi kullanıcılara yığından ayrılıp serbest kalsaydı, kullanıcıları yönetmez, doğumlarını ve ölümlerini korurdu. Hmm, belki buna a diyebiliriz UserShepherd.

Ya da belki de UserManagerişi her bir User nesnesinin verilerini incelemek ve verileri kriptografik olarak imzalamaktır. Sonra bir tane olurdu UserRecordsClerk.

Şimdi bu fikir bana yapıştı, uygulamaya çalışıyorum. Ve bu basit fikri inanılmaz derecede zor bul.

Sınıfların ne yaptığını açıklayabilirim (hızlı ve kirli kodlamaya girmediğim sürece) yazdığım sınıflar tam olarak bir şey yapar. Bu açıklamadan isimlere gitmek için özlediğim şey bir tür isimler kataloğu, kavramları isimlerle eşleştiren bir kelime hazinesi.

Sonuçta aklımda bir desen kataloğu gibi bir şey istiyorum (sık sık tasarım desenleri nesne adlarını kolayca sağlar, örneğin bir fabrika )

• Fabrika - Başka nesneler oluşturur (tasarım deseninden alınan adlandırma)
• Çoban - Bir çoban nesnelerin ömrünü, yaratımlarını ve kapanmalarını ele alır
• Eşitleyici - Verileri iki veya daha fazla nesne (veya nesne hiyerarşileri) arasında kopyalar

• Dadı - Nesnelerin oluşturulduktan sonra "kullanılabilir" duruma ulaşmasına yardımcı olur - örneğin diğer nesnelere kablolama

• vesaire vesaire.

Peki, bu sorunu nasıl ele alıyorsunuz? Sabit bir kelime dağarcığınız var mı, anında yeni isimler mi icat ediyorsunuz yoksa önemli olmayan veya yanlış olan şeyleri isimlendirmeyi düşünüyor musunuz?

Not: Ayrıca konuyu tartışan makaleler ve bloglar ile de ilgileniyorum. Başlangıç ​​olarak, bu konuda beni düşündüren orijinal makale: Java Sınıflarını 'Yönetici' olmadan adlandırmak

Güncelleme: Cevapların özeti

Bu arada bu sorudan öğrendiklerimin küçük bir özeti.

• Yeni metaforlar yaratmamaya çalışın (Dadı)
• Diğer çerçevelerin neler yaptığına bir göz atın

Bu konuyla ilgili diğer makaleler / kitaplar:

• Kendinizi düzenli olarak sınıflara hazırlarken / eklerken hangi isimler buluyorsunuz?
• Sınıfları adlandırmak için en iyi yaklaşım nedir?
• Kitap: Tasarım Desenleri: Yeniden Kullanılabilir Nesne Tabanlı Yazılım Öğeleri (Ciltli)
• Kitap: Kurumsal Uygulama Mimarisinin Kalıpları (Ciltli)
• Kitap: Uygulama Kalıpları (Ciltsiz kitap )

Ve cevaplardan topladığım geçerli bir isim önekleri / sonekleri listesi (öznel olarak!):

• koordinatör
• inşaatçı
• yazar
• Okuyucu
• Handler
• konteyner
• Protokol
• Hedef
• Dönüştürücü
• kontrolör
• Görünüm
• Fabrika
• varlık
• Kova

Ve yol için iyi bir ipucu:

Adlandırma felci olma. Evet, isimler çok önemli, ancak çok fazla zaman harcayacak kadar önemli değiller. 10 dakika içinde iyi bir isim düşünemiyorsanız, devam edin.

Benzer bir soru sordum , ancak mümkünse zaten .NET çerçevesindeki adları kopyalamaya çalışıyorum ve Java ve Android çerçevelerinde fikirler arıyorum .

Öyle görünüyor Helper, Managerve Utilhiçbir devlet içeren ve genellikle prosedürel ve statik olan sınıfları koordine etmek için takmak kaçınılmaz isimler vardır. Bir alternatif Coordinator.

Sen isimlerle özellikle mor prosey almak ve benzeri şeyler için gidebiliriz Minder, Overseer, Supervisor, Administrator, ve Master, ama ben alışık çerçeve adları gibi tutarak tercih söylediği gibi.

.NET çerçevesinde de bulduğunuz bazı diğer son ekler (doğru terim ise) şunlardır:

• Builder
• Writer
• Reader
• Handler
• Container

Sen kaynak-code-wordle.de bir göz atın , ben orada .NET çerçeve ve diğer bazı kütüphaneler sınıf adlarının en sık kullanılan son eklerini analiz ettik .

İlk 20:

• nitelik
• tip
• yardımcı
• Toplamak
• dönüştürücü
• işleyicisi
• bilgi
• Sağlayıcı
• istisna
• hizmet
• eleman
• yönetici
• düğüm
• seçenek
• fabrika
• bağlam
• madde
• tasarımcı
• baz
• editör

Ben tamamen iyi isimler için çalışıyorum ve çoğu zaman bir şeyler için isim seçerken çok dikkatli olmanın önemi hakkında yazıyorum. Aynı nedenden ötürü, bir şeyleri adlandırırken metaforlara karşı temkinli davranıyorum. Orijinal soruda, "fabrika" ve "senkronizatör" ne demek istedikleri için iyi isimlere benziyor. Ancak, "çoban" ve "dadı" değildir, çünkü bunlar metaforlara dayanmaktadır . Kodunuzdaki bir sınıf tam anlamıyla bir dadı olamaz ; bir dadı diyorsunuz çünkü gerçek bir dadı bebeklere veya çocuklara çok benziyor. Gayri resmi konuşmada sorun yok, ama kodları kimin ne zaman bildiğini bilenler tarafından sürdürülmesi gereken sınıfları adlandırmak için sorun değil.

Neden? Çünkü metaforlar kültüre bağımlıdır ve genellikle bireysel bağımlıdır. Sizin için, "dadı" sınıfını adlandırmak çok açık olabilir, ama belki başka biri için bu kadar açık değildir. Sadece kişisel kullanım için kod yazmıyorsanız buna güvenmemeliyiz.

Her durumda, kongre bir metafor yapabilir veya bozabilir. "Fabrika" nın kendisi bir metafor üzerine kuruludur, fakat bir süredir ortalıkta olan ve şu anda programlama dünyasında oldukça iyi bilinen bir metafor, bu yüzden kullanmanın güvenli olduğunu söyleyebilirim. Ancak, "dadı" ve "çoban" kabul edilemez.

Biz herhangi bir olmadan yapabileceğini xxxFactory, xxxManagerya xxxRepositorybiz doğru gerçek dünya modellenmiş eğer sınıfları:

Universe.Instance.Galaxies["Milky Way"].SolarSystems["Sol"]
        .Planets["Earth"].Inhabitants.OfType<Human>().WorkingFor["Initech, USA"]
        .OfType<User>().CreateNew("John Doe");

;-)

Thedailywtf.com, "ManagerOfPeopleWhoHaveMortgages", vb. 'De yayınlanan bir şeye kaygan bir eğim gibi geliyor.

Bir monolitik Manager sınıfının iyi bir tasarım olmadığı, ancak 'Manager'ı kullanmanın kötü olmadığını düşünüyorum. UserManager yerine UserAccountManager, UserProfileManager, UserSecurityManager vb.

'Yönetici' iyi bir kelimedir, çünkü bir sınıfın gerçek dünyadaki bir 'şeyi' temsil etmediğini açıkça göstermektedir. 'AccountsClerk' - bunun kullanıcı verilerini yöneten bir sınıf olup olmadığını veya işleri için Hesap Memuru olan birini temsil ettiğini nasıl anlarım?

Bu alandaki makalelerle ilgilendiğinizden Steve Yegge'in "İsimlerin Krallığında İcra" başlıklı görüşüyle ​​ilgilenebilirsiniz:

http://steve-yegge.blogspot.com/2006/03/execution-in-kingdom-of-nouns.html

Kendimi kullanmayı düşünmediğini bulduğunuzda Managerveya Helperbir sınıf adında, bunu doğru soyutlama henüz ve / veya ben ihlal ediyorum bulamadım araçlarının bir kod koku düşünün tek bir sorumluluk ilkesini böylece üstlenmeden ve tasarıma daha çok çaba koyarak, genellikle isimlendirmeyi daha kolay hale getirir.

Ancak iyi tasarlanmış sınıflar bile kendilerini her zaman adlandırmaz ve seçimleriniz kısmen iş modeli sınıfları mı yoksa teknik altyapı sınıfları mı oluşturduğunuza bağlıdır.

İş modeli sınıfları zor olabilir, çünkü her alan adı için farklıdırlar. PolicyBir alandaki (örneğin LateRentalPolicy) strateji sınıflarında olduğu gibi çok kullandığım bazı terimler var , ancak bunlar genellikle iş kullanıcılarıyla paylaşabileceğiniz, sınıfları tasarlayıp adlandırabileceğiniz bir " her yerde kullanılan dil " oluşturmaya çalışmaktan kaynaklanıyor -dünya fikirleri, nesneleri, eylemleri ve olayları.

Teknik altyapı sınıfları biraz daha kolaydır, çünkü gerçekten iyi bildiğimiz alanları tanımlarlar. Ben gibi, sınıf adları içine tasarım deseni isimleri dahil etmek tercih InsertUserCommand, CustomerRepository,veya SapAdapter.yerine niyet uygulanmasını iletişim konusunda endişelerini anlıyorum ama tasarım desenleri sınıf tasarımının bu iki yönü evlenmek - istediğiniz yere en azından sen, altyapı ile uğraşırken ayrıntıları gizlerken bile uygulama tasarımının şeffaf olması.

GOF kitabı tarafından tanımlanan desenlerle au fait olmak ve bunlardan sonra nesneleri adlandırmak, sınıfları adlandırmam, organize etmem ve niyeti iletmemde bana çok yol kat ediyor. Çoğu insan bu isimlendirmeyi (veya en azından büyük bir bölümünü) anlayacaktır.

Sınıfım için XyzManager'dan daha somut bir isim bulamazsam, bu benim için bunun gerçekten bir sınıfa ait bir işlevsellik, yani mimari bir 'kod kokusu' olup olmadığını yeniden düşünmem için bir nokta olur.

Akılda tutulması gereken en önemli şey: isim yeterince açıklayıcı mı? Sınıfın ne yapması gerektiğini ismine bakarak anlatabilir misiniz? Sınıf adlarınızda "Yönetici", "Hizmet" veya "İşleyici" gibi kelimeler kullanmak çok genel kabul edilebilir, ancak birçok programcı bunları kullandığından sınıfın ne için olduğunu anlamaya yardımcı olur.

Ben kendim cephe desenini çok kullanıyorum (en azından ben buna denir). Bir olabilirdi Usersadece bir kullanıcıyı ve açıklar sınıf Usersbenim "kullanıcıların koleksiyonu" nin takip tutar sınıfını. Sınıfa a UserManagerdemiyorum çünkü gerçek hayatta yöneticileri sevmiyorum ve onlara hatırlatmak istemiyorum :) Sadece çoğul formu kullanmak sınıfın ne yaptığını anlamama yardımcı oluyor.

C # 'a özgü olarak, adlandırma mantığı hakkında birçok iyi bilgiye sahip "Çerçeve Tasarım Yönergeleri: Kurallar, Deyimler ve Yeniden Kullanılabilir .NET Kütüphaneleri için Desenler" buldum .

Bu daha spesifik kelimeleri bulmaya gelince, genellikle bir eş anlamlılar sözlüğü kullanıyorum ve iyi bir kelime bulmaya çalışmak için ilgili kelimeleri atlıyorum. Bununla birlikte çok fazla zaman geçirmemeye çalışıyorum, gelişim boyunca ilerledikçe daha iyi isimler buluyorum veya bazen bunun SuchAndSuchManagergerçekten birden fazla sınıfa ayrılması gerektiğini anlıyorum ve sonra o kullanımdan kaldırılan sınıfın adı sorun olmayacak .

Buradaki kritik şeyin kodunuzun görünürlüğü alanında tutarlı olması gerektiğine inanıyorum, yani kodunuza bakması / kod üzerinde çalışması gereken herkes adlandırma kuralınızı anladığı sürece, onları çağırmaya karar verseniz bile bu iyi olmalı 'CompanyThingamabob' ve 'UserDoohickey'. Bir şirket için çalışıyorsanız, ilk durak, adlandırma için bir şirket sözleşmesi olup olmadığını görmektir. Bir şirket için yoksa veya bir şirket için çalışmazsanız, sizin için anlamlı olan terimleri kullanarak kendinizinkini oluşturun, en az rasgele kod yazan birkaç güvenilir iş arkadaşınızın / arkadaşınızın etrafından geçin ve mantıklı herhangi bir geri bildirim ekleyin.

Başkalarının konvansiyonunu, yaygın olarak kabul edildiğinde bile, size sayfanın üstünden atlamıyorsa, kitabımda bir hata var. Her şeyden önce kodumu diğer belgelere başvurmadan anlamam gerekiyor, ancak aynı sektörde aynı alanda başka biri için anlaşılmaz olmayacak kadar genel olması gerekiyor.

Sisteminiz için kullandığınız kalıpları, adlandırma kurallarını / kataloglama / sınıfların gruplandırılmasını, kullanılan kalıp tarafından tanımlanma eğilimi olarak değerlendiririm. Şahsen, başka bir kişinin kodumu almasının ve onunla çalışmasının en olası yolu olduğu için bu adlandırma kurallarına sadık kalıyorum.

Örneğin, UserRecordsClerk, hem UserRecordsClerk hem de CompanyRecordsClerk tarafından uygulanan genel bir RecordsClerk arabirimini genişletmek ve daha sonra uzmanlaşmak olarak açıklanabilir, yani, alt sınıflarının genel olarak ne için olduğunu / ne olduğunu görmek için arabirimdeki yöntemlere bakılabilir.

Bilgi için Tasarım Desenleri gibi bir kitaba bakın , mükemmel bir kitap ve kodunuzla nerede olmayı hedeflediğinizi temizlemenize yardımcı olabilir - zaten kullanmıyorsanız! ;Ö)

Deseniniz iyi seçildiği ve uygun olduğu kadar kullanıldığı sürece, o zaman oldukça yaratıcı olmayan basit sınıf isimleri yeterli olmalıdır!