Don't repeat yourself

Dieser Artikel erfüllt die GlossarWiki-Qualitätsanforderungen nur teilweise:

Korrektheit: 3 (zu größeren Teilen überprüft)

Umfang: 3 (einige wichtige Fakten fehlen)

Quellenangaben: 3 (wichtige Quellen vorhanden)

Quellenarten: 5 (ausgezeichnet)

Konformität: 5 (ausgezeichnet)

Definition

Das Programmierprinzip Don't repeat yourself (DRY, Wiederhole dich nicht) besagt, dass Code nicht dupliziert und anschließend nur marginal modifiziert werden sollte.

Beründung

Der Grund ist folgender: Wenn eine Folge von Anweisungen mehrfach in sehr ähnlicher Form verwendet wird, liegt diesen Anweisungen ein allgemeineres Prinzip zu Grunde, das explizit ins zugehörige Programm eingearbeitet werden sollte.

Code ohne Duplikate und Quasis-Duplikate von Anweisungen wird häufig als DRY bezeichnet. Mit “to DRY code” wird der Vorgang bezeichnet, Anweisungs-Duplikate aus dem entsprechenden Code zu entfernen.

Code der DRY ist bietet folgende Vorteile:

⇒ Wartbarkeit (da Änderungen nicht an mehreren, fast identischen Anweisungen vorgenommen werden müssen)

⇒ Robustheit (bei einer Änderung, die an mehreren Stellen vorgenommen werden muss, kommt es häufig zu Inkonsitenzen)

⇒ Lesbarkeit (da weniger Code existiert)

Beispiel: Der Klassiker

Der Non-DRY-Klassiker dürfte wohl folgender sein:

if (<Boolscher Ausdruck>)
  return true;
else
  return false;

Hier schreibt man natürlich:

return <Boolscher Ausdruck>;

Von diesem Klassiker gibt es zahlreiche Varianten, wie z.B.:

if (i > 0)
  return <Ein langer Ausdruck>;
else
  return -<Derselbe lange Ausdruck>;

Um diesen Code DRY zu bekommen, führt man entweder eine Hilfsvariable ein

var a = <Ein langer Ausdruck>;
if (i > 0)
  return a;
else
  return -a;

oder –– eleganter -- verwendet man die If-Then-Else-Funktion ... ? ... : ... an Stelle der If-Then-Else-Anweisung:

return (i>0 ? 1 : -1) * <Ein langer Ausdruck>;

Beispiel für C#-Code, der nicht DRY ist (Autor: Anonym)

Folgendes Beispiel stammt aus einem C#-Tool, das Daten für unterschiedliche Gruppen von Personen verarbeitet. Als das Tool entwickelt wurde, gab es genau zwei Gruppen.

// Filtere hier nach Gruppe 1 oder 2
if (this.selectedGroup == 1)
  persons = persons.Where(p => p.IsActive && p.Group == 1);

else if (this.selectedGroup == 2)
  persons = persons.Where(p => p.IsActive && p.Group == 2);

Wenn man diesen Code DRY macht, wird er nicht nur kürzer, sondern funktioniert auch noch, wenn irgendwann einmal die Anzahl der Gruppen erhöht wird.

persons = persons.Where(p => p.IsActive && p.Group == this.selectedGroup);

Beispiel für JavaScript-Code, der nicht DRY ist (Autoren: Anyom)

Folgender Code stammt aus einen einfachen JavaScript-Spiel mit 15 Spielsteinen („Coins“). Für jeden einzelnen Stein wurde der zugehörige Code seperat ausformuliert:

var btnSrc1 = new Image();
var btn1;

var btnSrc2 = new Image();
var btn2;

var btnSrc3 = new Image();
var btn3;
...

function Main()
{		
...
  btnSrc1.src = 'button1.png';
  btnSrc1.name = 'coin1';
  btnSrc1.onload = loadGfx;
  	
  btnSrc2.src = 'button2.png';
  btnSrc2.name = 'coin2';
  btnSrc2.onload = loadGfx;
  	
  btnSrc3.src = 'button3.png';
  btnSrc3.name = 'coin3';
  btnSrc3.onload = loadGfx;
...
}

function loadGfx(e)
{		
...
  if(e.target.name = 'coin1'){btn1 = new Bitmap(btnSrc1);}
  if(e.target.name = 'coin2'){btn2 = new Bitmap(btnSrc2);}
  if(e.target.name = 'coin3'){btn3 = new Bitmap(btnSrc3);}
...
}

// etc. pp.

Ein Array, ein zusätzliches Attribut btn für die btnSrc-Objekte und die Verwendung einer Schleife machen diesen Code DRY, d.h. kompakter, lesbarer und änderungsfreundlicher. Zum Beispiel kann die Anzahl der Spielsteine jederzeit problemlos geändert werden, indem der Wert von NR_OF_COINS geändert wird.

var bs_array = [], btnSrc;

for (var i = 0; i < NR_OF_COINS)
{ btnSrc = new Image();

  btnSrc.src    = 'button'+i+'.png';
  btnSrc.name   = 'coin'+i;
  btnSrc.onload = loadGfx;

  bs_array[i] = btnSrc;
}

function loadGfx()
{ e.target.btn = new Bitmap(e.target); }

Anmerkung: Hier sind noch weitere Verbesserungen denkbar, wie z.B. eine bessere Wahl der Objekt- und Attributnamen. Dies hat aber nichts mehr mit dem Prinzip “Don't repeat yourself” zu tun.

Quellen

3. Kowarschick (MMProg): Wolfgang Kowarschick; Vorlesung „Multimedia-Programmierung“; Hochschule: Hochschule Augsburg; Adresse: Augsburg; Web-Link; 2018; Quellengüte: 3 (Vorlesung)

Siehe auch

1. Wikipedia (EN): DRY (Web)