Refactoring und
Migration
Stefan Priebsch, thePHP.cc
IPC Spring 2009, Berlin

Wohin mit dem
alten Code?
Stefan Priebsch, thePHP.cc
IPC Spring 2009, Berlin

Stefan Priebsch
Co-Founder and Principal Consultant

Warum wird
Software alt?

Wann wird
Software alt?

Diese Software ist
nur ein Prototyp

Wir schreiben die
Dokumentation später

Wir schaffen erst mal
eine Zwischenlösung

Excel hat nicht
skaliert, und Access
mochte ich nicht

Software-Altlasten

„Es ist mir egal,
wozu etwas konstruiert wurde.
Ich will wissen, was es kann!“
--Gene Kranz,
Apollo 13

Der Teufelskreis

Migration

Migration
● Umstellung auf neue Technologie
● Ändern von Daten-Formaten
● Wechsel grundlegender Software
● Umzug auf einen anderen Server

Die Konfiguration
normieren

Die Konfiguration normieren
● zend.ze1_compatibility_mode = Off
● Nicht mehr vorhanden in PHP 5.3

Die Konfiguration normieren
● register_globals = Off
● import_request_data() verwenden

Sehr böse!

Die Konfiguration normieren
● register_long_arrays = Off
● Superglobale Variablen verwenden

Die Konfiguration normieren
● enable_dl = Off
● Extensions in der php.ini laden

Die Konfiguration normieren
● short_open_tags = Off
● Immer <?php verwenden

Die Konfiguration normieren
● magic_quotes_* = Off
● magic_quotes_gpc
● magic_quotes_runtime
● magic_quotes_sybase
● Mit nicht maskierten Daten arbeiten
● Bereits maskierte Daten de-maskieren

Die Konfiguration normieren
● allow_call_time_pass_reference = Off
● & in die Funktionsdeklaration verschieben

Refactoring

Refactoring
● Kleine Änderungen am Code
● Schrittweise Design-Verbesserung
● Keine Änderung des sichtbaren Verhaltens
● Laufend testen
● Keine neuen Features hinzufügen!

Redundanten
#1 Code eliminieren

Lange Code-
#2 blöcke kürzen

Unterschiedliche
#3 Belange trennen

Globale
Abhängigkeiten
vermeiden

Globale Abhängigkeiten
● Globale Variablen
● Superglobale Variablen
● $_GET, $_POST, $_FILES
● $_SERVER, $_ENV
● $_SESSION
● Statische Methodenaufrufe
● Singletons

class BlogPosting
{
protected $id;
...
public function getComments()
{
return MysqlDatabaseHandler::getComments($this->id);
}
}

Nur in PHP 5.3

class BlogPosting
{
protected $id;
protected $dbHandlerClassName;
...
public function getComments()
{
return
$this->dbHandlerClassName::getComments($this->id);
}
public function setDbHandler($className)
{
$this->dbHandlerClassName = $className;
}
}

Objekte einführen

Request

Session

Response

Configuration Registry

class BlogPostManager
{
protected $db;
public function findPosts($author)
{
…
return MySqlDatabase::getPosts(...);
}
}

class Registry
{
protected $dbHandler;
protected $dbHandlerClassName = 'MySqlDatabase';
public function getInstance() …
public function getDatabaseHandler()
{
if (is_null($this->dbHandler)) {
$this->dbHandler = new $this->dbHandlerClassName;
}
return $this->dbHandler;
}
public function setDatabaseHandler($className) ...
}

class BlogPostManager
{
protected $db;
public function __construct()
{
$this->db = Registry::getInstance()->getDatabase();
}
public function findPosts($author)
...
}

Dependency Injection

class BlogPostManager
{
protected $db;
public function __construct(DatabaseHandler $db)
{
$this->db = $db;
}
public function findPosts($author)
...
}

class BlogPostManager
{
protected $db;
public function __construct(DatabaseHandler $db = null)
{
if (is_null($db)) {
$this->db = $db;
} else {
$this->db = new MySqlDatabase();
}
}
public function findPosts($author)
...
}

Refactoring
und Testen

Fehler frühzeitig
vermeiden

Fehler frühzeitig vermeiden
● Alle PHP-Fehler anzeigen
● E_ALL | E_STRICT
● php -l
● HTML Tidy
● xmllint
● jsl / JSLint
● CSS-Validation

Ausgaben vergleichen

Ausgaben vergleichen
● Alt und Neu vergleichen
● HTML
● XML
● JSON
● Binärdaten
● Probleme
● Line Endings
● Uhrzeit, Zufallszahlen
● persistenter Status

Trace Logs
vergleichen

Trace Logs vergleichen
● xdebug (http://www.xdebug.org)
(http://www.xdebug.org)
● Trace Log erzeugen
● Funktionsaufrufe
● Parameter
● Rückgabewerte
● Zwei Trace Logs vergleichen

Systemtests

Systemtests
● Anwendung im Webserver testen
● Selenium (http://seleniumhq.org)
(http://seleniumhq.org)
● Zusicherungen auf DOM-Ebene
● Test-Setup aufwändig
● Tests langsam

Unit-Tests

Unit-Tests
● Klassen und Teile der Anwendung testen
● PHPUnit (http://www.phpunit.de)
(http://www.phpunit.de)
● Zahlreiche Zusicherungen
● Probleme
● stark gekoppelter Code
● prozeduraler Code

Die API, nicht die
Implementierung
testen

Agile Migration

Agile Migration
● in kleinen Schritten vorgehen
● neue PHP-Versionen „sofort“ auf
Entwicklungssystemen einsetzen
● laufendes Refactoring

http://thephp.cc
Twitter: thephpcc
stefan@thephp.cc
http://www.priebsch.de
Twitter: spriebsch
Xing, LinkedIn, Facebook