En az şaşkınlık (POLA) ve arayüzler ilkesi

C ++ öğreniyorken yüzyılın iyi bir çeyreği, arayüzlerin affedici olması ve mümkün olduğunca tüketicilerin kaynak veya belgelere erişemeyeceği için yöntemlerin çağrıldığı sırayı umursamayacağı öğretildi. bu.

Ancak, ne zaman genç programcılara ve kıdemli geliştiricilere beni kulak misafiri olduysa, bunun gerçekten bir şey olup olmadığını veya modası geçmiş olup olmadığını merak ettim.

Çamur kadar açık mı?

Bu yöntemlerle bir arayüz düşünün (veri dosyaları oluşturmak için):

OpenFile
SetHeaderString
WriteDataLine
SetTrailerString
CloseFile

Şimdi elbette bunları sırayla gidebilirsin, ama dosya adını (düşün a.out) ya da hangi başlık ve römork dizesini dahil ettiğini umursamadığını söyleyebilirsin , sadece arayabilirsin AddDataLine.

Daha az uç bir örnek, başlıkları ve römorkları atlamak olabilir.

Başka bir dosya açılmadan önce başlık ve römork dizeleri ayarlamak olabilir.

Bu, tanınan bir arayüz tasarımı ilkesi mi yoksa ad verilmeden önce sadece POLA yolu mu?

NB, bu arayüzün minutia'larında bataklığa düşmüyor, bu soru için sadece bir örnek.

En az şaşkınlık ilkesine bağlı kalmanın bir yolu , ISS ve SRP veya hatta KURU gibi diğer ilkeleri dikkate almaktır .

Verdiğiniz belirli örnekte, öneri dosyayı manipüle etmek için belirli bir bağımlılık bağımlılığı gibi görünüyor; ancak API'niz hem dosya erişimini hem de SRP'nin ihlali gibi kokan veri biçimini kontrol eder.

Düzenle / Güncelle: API'nın kendisinden kullanıcıdan DRY'yi ihlal etmesini istediğini de gösterir, çünkü API'yi her kullandıklarında aynı adımları tekrarlamaları gerekir .

G / Ç işlemlerinin veri işlemlerinden ayrı olduğu alternatif bir API'yi düşünün. ve API'nin kendisinin siparişe 'sahip olduğu':

ContentBuilder

SetHeader( ... )
AddLine( ... )
SetTrailer ( ... )

FileWriter

Open(filename) 
Write(content) throws InvalidContentException
Close()

Yukarıdaki ayırma ile, ContentBuilderaslında satır / başlık / römork depolamak dışında bir şey "yapmak" gerekmez (Belki de ContentBuilder.Serialize()siparişi bilen bir yöntem). Diğer SOLID ilkelerini izleyerek, artık satır eklemeden önce veya sonra üstbilgiyi veya treyleri ayarlamanız önemli değildir, çünkü içindeki hiçbir şey ContentBuilderiletilene kadar dosyaya yazılmaz FileWriter.Write.

Ayrıca biraz daha esnek olma avantajına sahiptir; örneğin, içeriği bir teşhis günlüğüne yazmak veya doğrudan bir dosyaya yazmak yerine bir ağ üzerinden geçirmek yararlı olabilir.

Bir API tasarlarken, bunun bir durum, bir dönüş değeri, bir istisna, geri arama veya başka bir şey olup olmadığını da rapor etmeyi düşünmelisiniz. API kullanıcısı muhtemelen sözleşmelerinin ihlallerini veya dosya G / Ç hataları gibi kontrol edemediği diğer hataları programlı olarak tespit edebilecek.

Bu sadece POLA ile ilgili değil, aynı zamanda olası bir hata kaynağı olarak geçersiz durumun önlenmesi ile de ilgilidir.

Somut bir uygulama sağlamadan örneğinize nasıl bazı kısıtlamalar sağlayabileceğimizi görelim:

İlk adım: Bir dosya açılmadan önce hiçbir şeyin çağrılmasına izin verme.

CreateDataFileInterface
  + OpenFile(filename : string) : DataFileInterface

DataFileInterface
  + SetHeaderString(header : string) : void
  + WriteDataLine(data : string) : void
  + SetTrailerString(trailer : string) : void
  + Close() : void

Şimdi , gerçek verilerin yazılabileceği CreateDataFileInterface.OpenFilebir DataFileInterfaceörneği almak için çağrılması gerektiği açıktır .

İkinci adım: Başlıkların ve römorkların daima ayarlandığından emin olun.

CreateDataFileInterface
  + OpenFile(filename : string, header: string, trailer : string) : DataFileInterface

DataFileInterface
  + WriteDataLine(data : string) : void
  + Close() : void

Şimdi bir DataFileInterfacedosya adı, başlık ve fragman almak için gerekli tüm parametreleri önceden sağlamanız gerekir . Tüm satırlar yazılana kadar trey dizesi kullanılamıyorsa, bu parametreyi Close()(büyük olasılıkla yöntemi yeniden adlandırmak WriteTrailerAndClose()) olarak da taşıyabilirsiniz ; böylece dosyanın en azından bir trey dizesi olmadan tamamlanması mümkün olmaz.

Yorumu yanıtlamak için:

Arayüzün ayrılmasını seviyorum. Ancak, yaptırımla ilgili önerilerinizin (ör. WriteTrailerAndClose ()) SRP ihlali konusunda kararsız olduğunu düşünmeye meyilliyim. (Bu, birkaç kez uğraştığım bir şey, ancak öneriniz olası bir örnek gibi görünüyor.) Nasıl cevap verirdiniz?

Doğru. Demek istediğim daha fazla örnek üzerinde durmak istemedim, ama bu iyi bir soru. Bu durumda bence onu arayacağım Finalize(trailer)ve çok fazla bir şey yapmadığını iddia ediyorum . Fragmanı yazmak ve kapatmak sadece uygulama detaylarıdır. Ancak, farklı olduğu konusunda aynı fikirde değilseniz veya benzer bir duruma sahipseniz, olası bir çözüm şudur:

CreateDataFileInterface
  + OpenFile(filename : string, header : string) : IncompleteDataFileInterface

IncompleteDataFileInterface
  + WriteDataLine(data : string) : void
  + FinalizeWithTrailer(trailer : string) : CompleteDataFileInterface

CompleteDataFileInterface
  + Close()

Aslında bu örnek için yapmazdım ama sonuçta tekniğin nasıl taşınacağını gösterir.

Bu arada, örneğin sırayla birçok satır yazmak için yöntemlerin aslında bu sırayla çağrılması gerektiğini varsaydım. Bu gerekli değilse, Ben Cottrel'in önerdiği gibi her zaman bir inşaatçı tercih ederim .