SOLID Prensipleri Uygulaması Hakkında

Forumda kod paylaşılırken dikkat edilmesi gerekenler. (Lütfen okuyunuz.)

SOLID Prensipleri Uygulaması Hakkında

iozguradem

Merhaba,

Geliştirdiğim kodları SOLID prensiplerine uygun olarak kodlamaya gayret ediyorum. Single Responsibility prensibine göre her method sadece bir özellik için değiştirilebilir olmalıdır. Yani tek bir sorumluluğu gerçekleştirmelidir.

Şimdi benim geliştirdiğim bir bölümde bir kayıt güncelleme işlemi var. Bu işlemi yapan method altında bir kaç farklı iş yapıyorum;
- Form validasyonu
- İlgili kaydı bulma
- Kaydı güncelleme çalışma
- Hata yakalama ve işlem sonucuna göre yönlendirme

Bu işlemlerin tamamını tek bir metotta topladığım zaman kodlarım zaman zaman çok uzuyor. Ayrıca bu işlerin hepsi Single Responsibility prensibine göre ayrı ayrı bir iş olarak değerlendirip private metotlara almalı ve ana metot üzerinden bunları tek tek mi çağırmalıyım? Kafam karıştığı için fikirlerinize ihtiyacım var. Aşağıda şuanki hali var? Bunu SOLID'e göre bölmem gerekiyor mu yoksa çok da sorun değil mi?

	public function postUpdateDetail($id)
	{	
 // Dökümanı bulma
 $document = Document::find($id);
 if ($document == null) App::abort(404);
 // Validasyon
 $validator = Validator::make(
 array(
 'Belge No' => Input::get('document_no'),
 'Başlık' => Input::get('title')
 ),
 array(
 'Belge No' => 'required',
 'Başlık' => 'required|min:3'
 )
 );	
 if (validator->fails()) {
 // Hataların gösterimi
 return Redirect::to("document/detail/$id")
 ->withErrors($validator);
 }

 // Güncelleme
 try {
 $document->document_no = Input::get('document_no');
 $document->title = Input::get('title');
 $document->save(); 
 Session::flash('success', 'Bilgiler güncellendi.');
 return Redirect::to('document/new');
 } catch (Exception $e) {
 Session::flash('error', 'Güncelleme anında bir hata meydana geldi.');
 return Redirect::to("document/detail/$id");
 }

	}

makseli

Bende daha önce bu durumda kalmıştım. Benim uyguladığım şu;

app dizi altında uygulama isimli bir kütüphane yapıyorum. Locik dediğimiz karar verme işlemlerini burada gerçekleştiriyorum.

Conroller methodlarında sadece olaylar yönetiyorum. Örn:


public function update(){

 $durum = $this->uygulama->kontrol($inputBilgileri);

 if($durum === true)
 $durum = $this->uygulama->baskaIslemVarsaOnlarFelan(); 

 if($durum === true)
 $durum = $this->uygulama->islemKayit(); 

# durum değişkeni bool true döndürmüyorsa dizi halinde hata metinlerini döndürüyorum

 if($durum === true)
 //basarili view
 else
 //tekrar form veya hata sayfası
}

Böylelikle controller lar dolup taşmıyor. Aynı method ları admin panelinde ( eğer varsa ) de yazmak zorunda kalmıyorsunuz.

makseli

Ayrıca srp de;
1 sınıfta en fazla 10 method kuralına katılsam da
1 method da en fazla 10 satır çok zorluyor beni.

zaman zaman ihlal ettiğim oluyor. Ama daha sonra hata aldığım yerler buralar oluyor

Bazen çok fazla kod yazdığımı hissettiriyor.

zafer

iozguradem;
Bana kalırsa yazılım prensiplerine sıkı sıkıya sarılmakta çok doğru değil. Prensipler elbette iyidir ve dikkat etmek gerekir ancak pratikte bazen sınırların dışına çıkmak, doğaçlama yapmak gerekebilir. Bence önce kendi koduna bak sonra presibi incele ve üzerinde biraz düşün sana hangisi daha doğru geliyorsa onunla devam et. Neticede yapılan hatada aslında doğruyu bulmak için atılmış bir adımdır.

Senin koduna gelirsek SOLID prensiplerinden bihaber birisi olarak baktığım zaman. postUpdateDetail gibi bir işlemin içinde ben detayların güncelleneceğini düşünürüm (basit düşün) daha fazlası değil, dolayısıyla o metod içinde yapılan kontrol (validasyon) işlemi o metod için fazlalıktır ve başka bir metoda taşınmasında fayda vardır diye düşünürüm. Zaten açıklama satırlarından bile o metod içinde iki farklı iş olduğu gayet net anlaşıyor. Yani burada prensipler olmasa bile aklın yolu bir

makseli;
Aslında ilk bakışta yaklaşımın güzel gibi görünüyor. Hem controller sınflarını daha sade ve temiz tutuyorsun. Hemde metotların çok uzamıyor. Ancak biraz düşününce senin bu yaptığın controller sınıflarını uygulama kütüphanesine bağımlı hale getiriyor. Yani hem taşınabilirliği hemde yeniden kullanımı kısıtlıyor gibi geldi bana. Ancak yukarıdada belirttiğim gibi bazen doğaçlama yapmak gerekir.

cangelis

Konu açılalı bayağı olmuş ama 1-2 şey yazmak istedim yine de

Satır sayısını azaltmakla ilgili:

$document = Document::find($id);
 if ($document == null) App::abort(404);

yerine

Document::findOrFail($id);

array(
 'Belge No' => Input::get('document_no'),
 'Başlık' => Input::get('title')
 );

yerine:

Input::only(['document_no', 'title')])

$document->document_no = Input::get('document_no');
 $document->title = Input::get('title');
 $document->save();

yerine

$document->update(Input::only(['document_no', 'title']))

Olabilir.

Ek olarak:

Eğer ki ekleme ve düzenlemede aynı validasyon kuralları varsa validasyonu yaratma işini ayrı methoda taşıyabilirsin. Ya da 1-2 farklılık varsa php'nin muhteşem array_* methodlarıyla küçük şakalar yapabilirsin

cangelis

Ek olarak, daha önce yazdığım senin kodunla neredeyse aynı işi yapan bir method gözüme çarptı. Satır sayısının ne kadar azaldığını göreceksin:

 public function postEdit($categoryId)
 {
 $category = $this->subCategory->findOrFail($categoryId);
 $validation = $this->createValidator();
 if ($validation->fails()) {
 return \Redirect::back()->withErrors($validation);
 }
 $category->update(Input::all());
 return \Redirect::to('category/edit/' . $categoryId)
 ->with('flash_message', ['message' => trans('general.category_updated'), 'type' => 'success']);
 }

iozguradem

cangelis wrote:Ek olarak, daha önce yazdığım senin kodunla neredeyse aynı işi yapan bir method gözüme çarptı. Satır sayısının ne kadar azaldığını göreceksin:
 public function postEdit($categoryId)
 {
 $category = $this->subCategory->findOrFail($categoryId);
 $validation = $this->createValidator();
 if ($validation->fails()) {
 return \Redirect::back()->withErrors($validation);
 }
 $category->update(Input::all());
 return \Redirect::to('category/edit/' . $categoryId)
 ->with('flash_message', ['message' => trans('general.category_updated'), 'type' => 'success']);
 }

Teşekkürler. Epey yararı dokundu bu bilgilerin.

cangelis

Bir de dökümantasyonda geçmeyen bir bilgi daha vereyim konuyla ilgili:

Şu hareketi;

array(
 'Belge No' => Input::get('document_no'),
 'Başlık' => Input::get('title')
 ),

Muhtemelen hata mesajlarında "document no alanı doldurulmalıdır" yerine "Belge no alanı doldurulmalıdır" şeklinde yazsın diye yapiyorsun. Onun da kısa yolunu göstereyim:

lang/validation.php içinde en altta 'attributes' denen boş bir array var. Oraya bunları ekleyebilirsin. Mesela:

'attributes' => [ 'document_no' => 'Belge No' ]

yaparsan bundan sonra hata mesajlarında document_no gördüğü yere Belge no yazar.

Roni

@cangelis çok güzel açıklamalar ve ip uçları

Laravel Türkiye Forumları, ücretsiz forum uygulaması Flarum ile yapılmıştır.