Was ist die neue Symfony 3-Verzeichnisstruktur?

90

Ich habe gerade ein neues Symfony 2.5-Projekt mit einem regulären Composer-Befehl erstellt:

php composer.phar create-project symfony/framework-standard-edition path/ 2.5.0

Das Terminal fragt mich:

Möchten Sie die Symfony 3-Verzeichnisstruktur verwenden?

Was ist diese Symfony 3-Verzeichnisstruktur? Ich habe es noch nie gesehen ... Ist es seit 2.5 neu?

Was sind die Vorteile der Verwendung?

Gibt es eine Möglichkeit, diese Verzeichnisstruktur zu replizieren?

Ousmane
quelle
3
Beachten Sie, dass diese Frage in der Zwischenzeit aus dem Installationsprogramm entfernt wurde, da sie bei den Benutzern zu einer gewissen Verwirrung führte. Weitere Informationen: github.com/symfony/symfony-standard/issues/674
Corneliu
@ Corneliu hat es in der Tat. Es ist jedoch weiterhin möglich, die Frage auszulösen, indem Sie eine Umgebungsvariable festlegen, bevor Sie Composer ausführen. Siehe diese Frage und Antwort, die ich gepostet habe: stackoverflow.com/q/24956881/1001110
Nic Wortel

Antworten:

176

Ich möchte die neue Symfony 3-Verzeichnisstruktur verwenden, sehe aber die Frage nicht?

Die Frage Would you like to use Symfony 3 directory structure?wurde beim Erstellen eines neuen Projekts aufgrund der dadurch verursachten Verwirrung entfernt. Sie können die Verwendung der Verzeichnisstruktur folgendermaßen erzwingen:

Wenn Sie die neue Struktur bevorzugen, können Sie die Umgebungsvariable SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREzu Ihrer .bashrcoder einer .bash_profileähnlichen hinzufügen :

Lassen Sie alle zukünftigen Projekte nach der neuen Struktur fragen

# .bash_profile
# ALL new composer installs will ask `Would you like to use the new Symfony3 strucure?`
export SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true

Lassen Sie NUR DIESES Projekt fragen, ob wir die neue Struktur verwenden möchten.

Wenn Sie es nur für ein bestimmtes Projekt (einmalig) wollten, können Sie Folgendes verwenden:

SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true composer create-project symfony/framework-standard-edition path/ "2.5.*"

Wenn die Umgebungsvariable SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREfestgelegt und festgelegt ist true, composerwerden Sie gefragt, ob Sie die neue Verzeichnisstruktur verwenden möchten.

Lesen Sie weiter unten alle Änderungen zwischen der Verzeichnisstruktur Symfony2und Symfony3.


Was ist die neue Symfony 3-Verzeichnisstruktur?

(und wie wirkt es sich auf mich und meinen Workflow aus)

Ich habe dies untersucht, indem ich zwei Projekte erstellt habe, eines mit symfony-2.5.0Verzeichnisstruktur und eines mit symfony-3(nur Änderung der Verzeichnisstruktur).

Machen Sie eines von jedem Projekt:

# say `N` to `Would you like to use Symfony 3 directory structure?`
$ composer create-project symfony/framework-standard-edition symfony-2.5.0/ 2.5.0

# say `Y` to `Would you like to use Symfony 3 directory structure?`
$ composer create-project symfony/framework-standard-edition symfony-3/ 2.5.0

Jetzt haben wir also die 2 verschiedenen Verzeichnisse, die wir vergleichen möchten.


Finde die diffErence

Sie können diffzwischen den beiden Verzeichnissen wechseln, indem Sie:

$ diff -rq symfony-2.5.0/ symfony-3/
/** (Returned from the diff)
Files symfony-2.5.0/.gitignore and symfony-3/.gitignore differ
Files symfony-2.5.0/.travis.yml and symfony-3/.travis.yml differ
Only in symfony-2.5.0/app: bootstrap.php.cache
Only in symfony-2.5.0/app: cache
Only in symfony-2.5.0/app: console
Only in symfony-2.5.0/app: logs
Only in symfony-2.5.0/app: phpunit.xml.dist
Only in symfony-3/bin: console
Only in symfony-3/bin: symfony_requirements
Files symfony-2.5.0/composer.json and symfony-3/composer.json differ
Only in symfony-3/: phpunit.xml.dist
Only in symfony-3/: var
Files symfony-2.5.0/vendor/autoload.php and symfony-3/vendor/autoload.php differ
Files symfony-2.5.0/vendor/composer/autoload_real.php and symfony-3/vendor/composer/autoload_real.php differ
Files symfony-2.5.0/web/app.php and symfony-3/web/app.php differ
Files symfony-2.5.0/web/app_dev.php and symfony-3/web/app_dev.php differ
*/

Dies zeigt die Dateien, die sich in den beiden Versionen unterscheiden.


Aufschlüsselung von diff

Hier ist eine Aufschlüsselung von allem im Diff.

# These files still exist in both versions (with different content)
.gitignore
.travis.yml
composer.json
vendor/autoload.php
vendor/composer/autoload_real.php
web/app.php
web/app_dev.php

# The following files have been removed from 2.5.0
# {RemovedFile2.5}      |  {ReplacedWith3.0}
app/cache               |  var/cache
app/logs                |  var/log
app/bootstrap.php.cache |  var/bootstrap.php.cache
app/console             |  bin/console
app/phpunit.xml.dist    |  phpunit.xml.dist

# The following files are new in 3.0
bin/symfony_requirements # run via CLI

Vorteile der Symfony 3-Verzeichnisstruktur

Die neue Verzeichnisstruktur bietet eine Reihe von Vorteilen, die alle geringfügig sind und möglicherweise nur minimale Änderungen an Ihrem Workflow erfordern.

PHPUnit

phpunit kann vom Projektstamm aus ausgeführt werden, ohne den Pfad der Konfigurationsdatei explizit angeben zu müssen.

# Symfony2
phpunit -c app/phpunit.xml

# Symfony3 (no need to specify the configuration file location)
phpunit

Binäre ausführbare Dateien

Alle ausführbaren Binärdateien befinden sich jetzt alle an einem einzigen Speicherort - dem binVerzeichnis (ähnlich einem Unix-ähnlichen Betriebssystem) .

# you can update your `PATH` to include the `bin` directory
PATH="./bin:$PATH"

# From your project root you can now run executables like so:
console
symfony_requirements
doctrine

# else with no `PATH` update
bin/console
bin/symfony_requirements
bin/doctrine

Das neue /varVerzeichnis

Das neue /varVerzeichnis enthält die Dateien, in die das System während des Betriebs Daten schreibt (ähnlich einem Unix-ähnlichen Betriebssystem ) .

Dies erleichtert auch das Hinzufügen von Berechtigungen. Das gesamte /varVerzeichnis sollte von Ihrem Webserver beschreibbar sein. Sie können dem Symfony2-Handbuch zum Festlegen von Berechtigungen folgen (Ersetzen von app/cache&& app/logsdurch var). Alle anderen Dateien, die Sie lokal schreiben möchten, befinden sich möglicherweise auch hier.

# default symfony3 `var` directory
var/bootstrap.php.cache
var/cache
var/logs

Überprüfung der Symfony-Anforderungen

Beim Ausführen symfony_requirementswerden obligatorische und optionale Umgebungskonfigurationen ausgegeben.
z.B:

********************************
* 'Symfony requirements check' *
********************************

* Configuration file used by PHP: /usr/local/php5/lib/php.ini

/** ATTENTION **
*  The PHP CLI can use a different php.ini file
*  than the one used with your web server.
*  To be on the safe side, please also launch the requirements check
*  from your web server using the web/config.php script.
*/

** Mandatory requirements **
'
 OK       PHP version must be at least 5.3.3 (5.5.11 installed)
 OK       PHP version must not be 5.3.16 as Symfony wont work properly with it
 OK       Vendor libraries must be installed
 OK       var/cache/ directory must be writable
 OK       var/logs/ directory must be writable
 OK       date.timezone setting must be set
 OK       Configured default timezone "Europe/London" must be supported by your installation of PHP
 OK       json_encode() must be available
 OK       session_start() must be available
 OK       ctype_alpha() must be available
 OK       token_get_all() must be available
 OK       simplexml_import_dom() must be available
 OK       APC version must be at least 3.1.13 when using PHP 5.4
 OK       detect_unicode must be disabled in php.ini
 OK       xdebug.show_exception_trace must be disabled in php.ini
 OK       xdebug.scream must be disabled in php.ini
 OK       PCRE extension must be available
'
** Optional recommendations **
'
 OK       xdebug.max_nesting_level should be above 100 in php.ini
 OK       Requirements file should be up-to-date
 OK       You should use at least PHP 5.3.4 due to PHP bug #52083 in earlier versions
 OK       When using annotations you should have at least PHP 5.3.8 due to PHP bug #55156
 OK       You should not use PHP 5.4.0 due to the PHP bug #61453
 OK       When using the logout handler from the Symfony Security Component, you should have at least PHP 5.4.11 due to PHP bug #63379 (as a workaround, you can also set invalidate_session to false in the security logout handler configuration)
 OK       You should use PHP 5.3.18+ or PHP 5.4.8+ to always get nice error messages for fatal errors in the development environment due to PHP bug #61767/#60909
 OK       PCRE extension should be at least version 8.0 (8.34 installed)
 OK       PHP-XML module should be installed
 OK       mb_strlen() should be available
 OK       iconv() should be available
 OK       utf8_decode() should be available
 OK       posix_isatty() should be available
 OK       intl extension should be available
 OK       intl extension should be correctly configured
 OK       intl ICU version should be at least 4+
 OK       a PHP accelerator should be installed
 OK       short_open_tag should be disabled in php.ini
 OK       magic_quotes_gpc should be disabled in php.ini
 OK       register_globals should be disabled in php.ini
 OK       session.auto_start should be disabled in php.ini
 OK       PDO should be installed
 OK       PDO should have some drivers installed (currently available: mysql, sqlite, dblib, pgsql)
'

Fazit

Sieht nach einer guten Aufräumaktion von Sensio Labs aus. Alle oben genannten Änderungen sind absolut sinnvoll. Sie sollten beim Upgrade von 2.5auf einfach zu implementieren sein. 3.xDies sind wahrscheinlich die geringsten Probleme!

Lesen Sie die Dokumente

Symfony 2.x => 3.0 Aktualisieren Sie die Dokumente hier.
Symfony 3.0 Die Architektur

Veröffentlichungsdatum für Symfony 3

Es sieht weit entfernt aus, den Release-Prozess zu betrachten (eine Lektüre wert) :

http://symfony.com/doc/current/contributing/community/releases.html

Aktualisierter Symfony-Release-Prozess
(Quelle: symfony.com )

Anil
quelle
Vielen Dank für Ihre Hilfe. Ja, ich hoffe, dass die Migration von 2. * auf 3.0 möglich und einfach ist.
Ousmane
Jetzt denke ich, warum der Befehl nicht funktioniert, weil der Komponist von App zu Bin gewechselt ist.
Parixit
1
Seit gestern haben wir die Frage nach der Verzeichnisstruktur "3.0" entfernt, da sie die Leute verwirrte und die Verwendung dieser Struktur noch keinen wirklichen Vorteil bringt. 3.0 ist noch eine lange Zeit entfernt, aber wenn wir dort ankommen, wird es sicherlich Details darüber geben, wie man ein Upgrade durchführt :).
Weber
1
@MarcelBurkhard Ich habe meine Antwort aktualisiert, um zu zeigen, wie die neue Verzeichnisstruktur erzwungen wird. Sie fügen einfach die Umgebungsvariable hinzu SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true( siehe oben in meiner Antwort für weitere Details)
Anil
1
Sie sollten die Antwort aktualisieren und beachten, dass diese Option aus dem Installationsprogramm entfernt wurde.
Pinoniq
38

Hier ist eine Liste der Änderungen zwischen der alten und der neuen Verzeichnisstruktur:

  • Ein neuer varOrdner wird eingeführt
  • app/console wird verschoben nach bin/console
  • app/check.php wird verschoben / umbenannt in bin/symfony_requirements
  • app/phpunit.xml.dist wird in den Stammordner verschoben
  • app/SymfonyRequirements.php wird verschoben nach var/SymfonyRequirements.php
  • die app/cacheund app/logsOrdner verschoben wurden zu var/cacheund var/logsjeweils

(Derzeit scheinen nicht alle alten Dateien entfernt zu sein. Sie können dies daher manuell tun, bevor Sie alle Dateien in die Versionskontrolle übernehmen. Siehe dieses Problem. )

Was ist der Vorteil?

Diese Änderungen bieten einige Vorteile. Zunächst befinden sich jetzt alle Dateien und Ordner im Ordner, die für Symfony beschreibbar sein sollten var. Dies sollte die Konfiguration von Berechtigungen erheblich vereinfachen: Stellen Sie einfach den Schreibzugriff auf den varOrdner sicher, und Sie sind fertig. Dies wird in diesem Blog-Beitrag vorgeschlagen - ich habe es selbst noch nicht versucht.

Zweitens consolebefinden sich jetzt alle ausführbaren Dateien, einschließlich bin. So können Bash-Benutzer dies beispielsweise zu ihrer .profileDatei hinzufügen :

# set PATH so it includes current bin folder
PATH="./bin:$PATH"

Jetzt müssen Sie nicht einmal mehr tippen bin/console, es reicht einfach consoleaus (beachten Sie, dass ich neu starten musste, damit dies funktioniert).

Es gibt noch einige andere Verbesserungen. app/check.phpist jetzt eine ausführbare Datei, sodass Sie sie mit bin/symfony_requirementsanstelle von aufrufen können php app/check.php. (Mit dem .profilezuvor beschriebenen Trick wird auch einfach symfony_requirementsausreichen)

Und zu guter Letzt müssen Sie beim Ausführen von PHPUnit nicht mehr den Speicherort der Konfigurationsdatei angeben. Also statt phpunit -c appSie können einfach ausführen phpunit.

Kann ich auch vorhandene Projekte auf diese neue Struktur aktualisieren?

Standardmäßig wird beim Erstellen eines neuen Projekts (mit composer create-project symfony/framework-standard-edition path/ "2.5.*") nur die Frage "Möchten Sie die neue Verzeichnisstruktur verwenden?" Angezeigt .

Es ist zwar möglich, eine vorhandene Symfony-Anwendung zu aktualisieren, dies ist jedoch eine etwas hackige Lösung. Ich habe es jetzt mit einer Reihe von Anwendungen geschafft, und Sie können die Schritte in dieser Übersicht lesen . Da es jedoch nicht dafür entwickelt wurde, kann ich nicht garantieren, dass es immer funktioniert.

Aktualisieren

Es stellt sich heraus, dass Symfony Sie beim Erstellen einer neuen Symfony-Anwendung über Composer nicht mehr fragt, ob Sie die neue Verzeichnisstruktur verwenden möchten. Es ist jedoch weiterhin möglich, Symfony-Projekte mit der neuen Verzeichnisstruktur mithilfe einer Umgebungsvariablen zu erstellen. Weitere Informationen finden Sie unter Wie kann ich ein neues Symfony-Projekt mit der neuen Verzeichnisstruktur erstellen?

Nic Wortel
quelle
6
Sie müssen nach dem Ändern Ihrer .profileDatei nicht neu starten. Sie können die Datei in Ihrer aktuellen Shell einfach neu beziehen oder eine neue Shell beenden und starten. Durch Ausführen . ~/.profilewird die Datei erneut als Quelle bereitgestellt (beachten Sie den führenden Punktbereich).
Drarok