RoWaWorld

Eine ältere Version des Dokuments wurde geladen! Beim Speichern wird eine neue Version des Dokuments mit diesem Inhalt erstellt.

<WRAP rww-topic-heading>
====== Composer ======
</WRAP>

</WRAP>

Composer ist ein Paket- und Abhängigkeitsmanager für PHP.

Mit Composer werden PHP-Bibliotheken und Frameworks installiert, aktualisiert und verwaltet.

In meinen Projekten wird Composer insbesondere für **Laravel** und damit für die Entwicklung von **RoWaBase** eingesetzt.

<WRAP rww-back>
[[:werkzeuge:start|←]] [[:werkzeuge:start|Werkzeuge]]
</WRAP>

----

===== Composer-Version anzeigen =====

Die installierte Composer-Version kann in der Kommandozeile geprüft werden:

<code>
composer --version
</code>

Kurzform:

<code>
composer -V
</code>

----

===== Grundprinzip =====

Ein PHP-Projekt kann von zahlreichen externen Paketen abhängig sein.

Composer verwaltet:

* welche Pakete benötigt werden
  * welche Versionen zulässig sind
  * welche konkreten Versionen installiert sind
  * Abhängigkeiten zwischen den Paketen
  * das automatische Laden von PHP-Klassen

Die wichtigsten Bestandteile sind:

<code>
composer.json
composer.lock
vendor/
</code>

----

===== composer.json =====

Die Datei ''composer.json'' beschreibt die Anforderungen des Projekts.

Sie befindet sich normalerweise im Stammverzeichnis.

Beispiel:

<code>
E:\xampp\htdocs\rowabase\composer.json
</code>

Darin werden unter anderem die benötigte PHP-Version und die verwendeten Pakete definiert.

Ein vereinfachtes Beispiel:

<code json>
{
    "require": {
        "php": "^8.2",
        "laravel/framework": "^12.0"
    }
}
</code>

Die Datei ''composer.json'' gehört zur Projektdefinition und wird deshalb mit Git versioniert.

----

===== composer.lock =====

Die Datei ''composer.lock'' enthält die **konkret aufgelösten Paketversionen**.

Während ''composer.json'' beispielsweise einen zulässigen Versionsbereich beschreiben kann, hält ''composer.lock'' fest, welche Version tatsächlich installiert wurde.

Dadurch können verschiedene Entwicklungsumgebungen denselben Paketstand verwenden.

Die Datei:

<code>
composer.lock
</code>

sollte bei Anwendungen wie RoWaBase ebenfalls mit Git versioniert werden.

----

===== vendor-Verzeichnis =====

Composer installiert die PHP-Pakete standardmäßig in:

<code>
vendor/
</code>

Dieses Verzeichnis kann sehr viele Dateien enthalten.

Es wird normalerweise **nicht mit Git versioniert**.

Bei Laravel befindet sich deshalb typischerweise folgender Eintrag in ''.gitignore'':

<code>
/vendor
</code>

Die benötigten Dateien können anhand von ''composer.json'' und ''composer.lock'' jederzeit wieder installiert werden.

----

===== Abhängigkeiten installieren =====

Sind ''composer.json'' und ''composer.lock'' vorhanden, werden die festgelegten Pakete installiert mit:

<code>
composer install
</code>

Composer verwendet dabei die in ''composer.lock'' festgelegten Versionen.

Dieser Befehl ist beispielsweise wichtig, nachdem ein bestehendes Projekt auf einen anderen Rechner kopiert oder aus einem Git-Repository ausgecheckt wurde.

----

===== install und update =====

''install'' und ''update'' haben unterschiedliche Aufgaben.

**Installieren des festgelegten Projektstands:**

<code>
composer install
</code>

Dabei werden möglichst genau die Versionen aus ''composer.lock'' installiert.

**Abhängigkeiten aktualisieren:**

<code>
composer update
</code>

Dabei löst Composer die Abhängigkeiten anhand der Regeln in ''composer.json'' neu auf und aktualisiert anschließend auch ''composer.lock''.

<WRAP info>
''composer update'' sollte nicht einfach routinemäßig ausgeführt werden.

Es kann zahlreiche Paketversionen verändern und damit einen größeren technischen Eingriff in das Projekt darstellen.
</WRAP>

----

===== Neues Paket installieren =====

Ein zusätzliches PHP-Paket wird mit ''require'' in das Projekt aufgenommen:

<code>
composer require hersteller/paket
</code>

Composer:

* sucht eine passende Version
  * installiert das Paket
  * aktualisiert ''composer.json''
  * aktualisiert ''composer.lock''

Die Änderungen an ''composer.json'' und ''composer.lock'' sollten anschließend gemeinsam mit dem dazugehörigen Anwendungscode in Git gespeichert werden.

----

===== Entwicklungsabhängigkeiten =====

Pakete, die nur während der Entwicklung benötigt werden, können als Entwicklungsabhängigkeit installiert werden:

<code>
composer require --dev hersteller/paket
</code>

Sie erscheinen in ''composer.json'' unter:

<code>
require-dev
</code>

Typische Beispiele sind Test-, Analyse- oder Entwicklungswerkzeuge.

----

===== Paket entfernen =====

Ein installiertes Paket kann entfernt werden mit:

<code>
composer remove hersteller/paket
</code>

Composer passt dabei die Projektabhängigkeiten entsprechend an.

----

===== Installierte Pakete anzeigen =====

Eine Übersicht der installierten Composer-Pakete:

<code>
composer show
</code>

Informationen zu einem bestimmten Paket:

<code>
composer show hersteller/paket
</code>

----

===== Veraltete Pakete anzeigen =====

Mit:

<code>
composer outdated
</code>

kann geprüft werden, für welche installierten Pakete neuere Versionen verfügbar sind.

Das bedeutet jedoch nicht automatisch, dass alle angezeigten Pakete sofort aktualisiert werden sollten.

Vor Aktualisierungen sollten insbesondere Kompatibilität und Auswirkungen auf die Anwendung geprüft werden.

----

===== Autoloading =====

Composer stellt einen Autoloader für PHP-Klassen bereit.

Dadurch müssen Klassen nicht einzeln mit ''require'' oder ''include'' eingebunden werden.

Laravel verwendet dieses Verfahren intensiv.

Die Zuordnung der eigenen Anwendungsklassen wird unter anderem in ''composer.json'' beschrieben.

Typisch für Laravel:

<code json>
"autoload": {
    "psr-4": {
        "App\\": "app/",
        "Database\\Factories\\": "database/factories/",
        "Database\\Seeders\\": "database/seeders/"
    }
}
</code>

Dadurch kann beispielsweise:

<code>
App\Models\Objekt
</code>

automatisch der entsprechenden PHP-Datei unter ''app/'' zugeordnet werden.

----

===== Autoloader neu erzeugen =====

Nach bestimmten Änderungen an Klassen oder Autoload-Konfigurationen kann der Autoloader neu aufgebaut werden:

<code>
composer dump-autoload
</code>

Normalerweise ist dieser Schritt bei der täglichen Laravel-Entwicklung nicht nach jeder Änderung erforderlich.

----

===== Composer-Diagnose =====

Bei Problemen mit der Composer-Installation oder Umgebung kann eine Diagnose durchgeführt werden:

<code>
composer diagnose
</code>

Composer prüft dabei verschiedene Aspekte der lokalen Konfiguration.

----

===== composer validate =====

Die ''composer.json'' und teilweise auch der zugehörige Lock-Stand können geprüft werden mit:

<code>
composer validate
</code>

Dies ist insbesondere nach manuellen Änderungen an ''composer.json'' sinnvoll.

----

===== Composer und PHP =====

Composer selbst benötigt PHP.

Deshalb hängen Composer-Probleme häufig auch mit der verwendeten PHP-Version oder fehlenden PHP-Extensions zusammen.

PHP-Version prüfen:

Geladene Extensions anzeigen:

Verwendete PHP-Konfiguration anzeigen:

Weitere Informationen:

[[werkzeuge:php:start|PHP]]

----

===== Composer und Laravel =====

Laravel wird über Composer verwaltet.

Die Laravel-Komponenten und weitere PHP-Abhängigkeiten eines Projekts befinden sich im ''vendor''-Verzeichnis.

Artisan lädt diese Abhängigkeiten über den von Composer erzeugten Autoloader.

Fehlt ''vendor/'', funktionieren Laravel-Befehle deshalb nicht.

In diesem Fall werden die Abhängigkeiten normalerweise wiederhergestellt mit:

<code>
composer install
</code>

Weitere Informationen:

[[werkzeuge:laravel:start|Laravel]]

----

===== Composer und Git =====

Bei einem mit Composer verwalteten Anwendungsprojekt werden normalerweise versioniert:

<code>
composer.json
composer.lock
</code>

Nicht versioniert wird:

<code>
vendor/
</code>

Damit speichert Git die **Definition des Paketstands**, aber nicht tausende installierte Fremddateien.

Weitere Informationen:

[[werkzeuge:git:start|Git]]

----

===== Praxis: RoWaBase =====

Im RoWaBase-Projekt befinden sich im Stammverzeichnis:

<code>
composer.json
composer.lock
</code>

Das Verzeichnis:

<code>
vendor/
</code>

wird dagegen über ''.gitignore'' von der Versionsverwaltung ausgeschlossen.

Damit lässt sich die PHP-Umgebung eines RoWaBase-Projektstands grundsätzlich wiederherstellen:

<code>
composer install
</code>

Composer liest ''composer.lock'' und installiert die dort festgelegten Abhängigkeiten erneut.

----

===== Typischer Arbeitsablauf bei einem neuen Paket =====

<code>
composer require hersteller/paket
git status
</code>

Danach werden die Änderungen und ihre Auswirkungen geprüft.

Typischerweise haben sich mindestens folgende Dateien geändert:

<code>
composer.json
composer.lock
</code>

Erst wenn das neue Paket in der Anwendung getestet wurde, sollte der gesamte fachlich zusammengehörige Stand mit Git gesichert werden.

----

===== Nützliche Befehle =====

<code>
composer --version
composer install
composer require hersteller/paket
composer require --dev hersteller/paket
composer remove hersteller/paket
composer show
composer outdated
composer dump-autoload
composer validate
composer diagnose
</code>

----

===== Merksatz =====

<WRAP info>
**''composer.json'' beschreibt, was das Projekt benötigt.**

**''composer.lock'' hält fest, welche Versionen tatsächlich zum Projektstand gehören.**

**''vendor/'' enthält die daraus installierten Pakete und wird normalerweise nicht mit Git gespeichert.**
</WRAP>

Zusammenfassung