Jaka jest nowa struktura katalogów w Symfony 3?

90

Właśnie utworzyłem nowy projekt Symfony 2.5 za pomocą zwykłego polecenia Composer:

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

Terminal pyta mnie:

Czy chciałbyś użyć struktury katalogów Symfony 3?

Jaka jest ta struktura katalogów w Symfony 3? Nigdy wcześniej go nie widziałem ... Czy jest nowy od 2.5?

Jakie są korzyści z jej używania?

Czy istnieje sposób na odtworzenie tej struktury katalogów?

Ousmane
źródło
3
Zauważ, że w międzyczasie to pytanie zostało usunięte z instalatora, ponieważ powodowało pewien stopień zamieszania wśród użytkowników. Więcej informacji: github.com/symfony/symfony-standard/issues/674
Corneliu
@Corneliu rzeczywiście ma. Jednak nadal można wywołać pytanie, ustawiając zmienną środowiskową przed uruchomieniem Composera. Zobacz to pytanie i odpowiedź, które opublikowałem: stackoverflow.com/q/24956881/1001110
Nic Wortel

Odpowiedzi:

176

Chcę użyć nowej struktury katalogów Symfony 3, ale nie widzę pytania?

Pytanie Would you like to use Symfony 3 directory structure?zostało usunięte podczas tworzenia nowego projektu z powodu zamieszania, jakie spowodowało. Możesz wymusić użycie struktury katalogów, wykonując następujące czynności:

Jeśli wolisz nową strukturę, możesz dodać zmienną środowiskową SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREdo swojej .bashrclub .bash_profilepodobnej:

Niech wszystkie przyszłe projekty wymagają nowej struktury

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

Zrób TYLKO TEN projekt z pytaniem, czy chcemy użyć nowej struktury.

Jeśli chcesz go tylko dla konkretnego projektu (jednorazowego), możesz użyć:

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

Jeśli zmienna środowiskowa SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREjest ustawiona i ustawiona na true, composerzapyta, czy chcesz użyć nowej struktury katalogów.

Kontynuuj czytanie poniżej, aby zapoznać się ze wszystkimi zmianami między strukturą katalogów Symfony2i Symfony3.


Jaka jest nowa struktura katalogów w Symfony 3?

(i jak to wpływa na mnie i mój przepływ pracy)

Przyjrzałem się temu, tworząc 2 projekty, jeden ze symfony-2.5.0strukturą katalogów, drugi z symfony-3(tylko zmiana struktury katalogów).

Zrób jeden z każdego projektu:

# 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

Więc teraz mamy 2 różne katalogi, które chcemy porównać.


Znajdź diffróżnicą

Możesz diffmiędzy 2 katalogami za pomocą:

$ 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
*/

Pokazuje pliki, które różnią się w 2 wersjach.


Podział diff

Oto zestawienie wszystkiego w różnicy.

# 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

Korzyści ze struktury katalogów Symfony 3

Nowa struktura katalogów ma wiele zalet, z których wszystkie są niewielkie i mogą wymagać minimalnych zmian w przepływie pracy.

PHPUnit

phpunit można uruchomić z katalogu głównego projektu bez konieczności jawnego określania ścieżki do pliku konfiguracyjnego.

# Symfony2
phpunit -c app/phpunit.xml

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

Binarne pliki wykonywalne

Wszystkie binarne pliki wykonywalne są teraz zlokalizowane w jednym miejscu - binkatalogu (podobnie jak w systemie operacyjnym typu unix) .

# 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

Nowy /varkatalog

Nowy /varkatalog zawiera pliki, do których system zapisuje dane w trakcie swojej pracy (podobnie jak w systemie unixopodobnym) .

Ułatwia to także dodawanie uprawnień, /varserwer WWW powinien mieć możliwość zapisu w całym katalogu. Możesz śledzić przewodnik Symfony2 do ustawiania uprawnień (zastępując app/cache&& app/logsz var), wszelkie inne pliki, które chcesz napisać lokalnie może również znajdować się tutaj.

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

Sprawdzenie wymagań Symfony

Uruchomienie symfony_requirementsspowoduje wyświetlenie obowiązkowych i opcjonalnych konfiguracji środowiska.
na przykład:

********************************
* '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)
'

Wniosek

Wygląda na to, że Sensio Labs dobrze posprzątał, wszystkie powyższe zmiany mają sens, powinny być łatwe do wdrożenia podczas aktualizacji z 2.5do 3.x, to prawdopodobnie będzie najmniejszy z twoich problemów!

Przeczytaj dokumentację

Symfony 2.x => 3.0 Upgrade docs tutaj
Symfony 3.0 Architektura

Data wydania Symfony 3

Spojrzenie na proces wydania wydaje się dalekie (warte przeczytania) :

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

Zaktualizowany proces wydawania Symfony
(źródło: symfony.com )

Indygowiec
źródło
Dziękuję za pomoc, tak mam nadzieję, że migracja z wersji 2. * do 3.0 będzie możliwa i łatwa.
Ousmane
Teraz myślę, że dlaczego polecenie nie działa, ponieważ kompozytor przeniósł się z aplikacji do bin.
Parixit,
1
Od wczoraj usunęliśmy pytanie o strukturę katalogów „3.0”, ponieważ wprowadzało to w błąd ludzi i nie ma jeszcze żadnych korzyści z używania tej struktury. 3.0 to jeszcze dawno, ale kiedy już tam dotrzemy, na pewno będą szczegóły jak uaktualnić :).
weaverryan
1
@MarcelBurkhard Zaktualizowałem swoją odpowiedź, aby pokazać, jak wymusić nową strukturę katalogów, po prostu dodajesz zmienną środowiskową SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true(zobacz górę mojej odpowiedzi, aby uzyskać szczegółowe informacje)
Anil
1
Powinieneś zaktualizować odpowiedź i zauważyć, że usunęli tę opcję z instalatora.
Pinoniq
38

Oto lista zmian między starą a nową strukturą katalogów:

  • Zostaje varwprowadzony nowy folder
  • app/console jest przeniesiony do bin/console
  • app/check.php został przeniesiony / zmieniono jego nazwę na bin/symfony_requirements
  • app/phpunit.xml.dist zostanie przeniesiony do folderu głównego
  • app/SymfonyRequirements.php jest przeniesiony do var/SymfonyRequirements.php
  • app/cachei app/logsfoldery zostały przeniesione do var/cachei var/logs, odpowiednio,

(Obecnie wydaje się, że nie wszystkie stare pliki zostały usunięte, więc warto zrobić to ręcznie przed przekazaniem wszystkich plików do kontroli wersji. Zobacz ten problem )

Więc jakie są korzyści?

Zmiany te mają kilka zalet. Po pierwsze, wszystkie pliki i foldery, które powinny być zapisywalne dla Symfony, są teraz w varfolderze. Powinno to znacznie ułatwić konfigurowanie uprawnień: po prostu zapewnij dostęp do zapisu w varfolderze i gotowe. Jest to sugerowane w tym poście na blogu - jeszcze tego nie próbowałem.

Po drugie, wszystkie pliki wykonywalne, w tym console, są teraz w binfolderze. To pozwala użytkownikom Bash na przykład dodać to do swojego .profilepliku:

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

Teraz bin/consolepo prostu nie musisz już pisaćconsole wystarczy (pamiętaj, że musiałem zrestartować komputer, aby to zadziałało).

Istnieją również inne ulepszenia. app/check.phpjest teraz plikiem wykonywalnym, więc możesz go wywołać używając bin/symfony_requirementszamiast php app/check.php. (Używając .profilesztuczki, którą opisałem wcześniej, po prostu też symfony_requirementswystarczy)

I wreszcie, nie musisz już określać lokalizacji pliku konfiguracyjnego podczas uruchamiania PHPUnit. Więc zamiast phpunit -c appciebie możesz po prostu wykonaćphpunit .

Czy mogę również uaktualnić istniejące projekty do nowej struktury?

Domyślnie podczas tworzenia nowego projektu (przy użyciu pliku.) Pojawi się tylko pytanie „Czy chcesz użyć nowej struktury katalogów”? composer create-project symfony/framework-standard-edition path/ "2.5.*" ) .

Jest jednak możliwe zaktualizowanie istniejącej aplikacji Symfony, ale jest to nieco hakerskie rozwiązanie. Udało mi się to teraz zrobić z wieloma aplikacjami i możesz przeczytać kroki w tym skrócie . Ponieważ jednak nie został do tego zaprojektowany, nie mogę zagwarantować, że zawsze będzie działał.

Aktualizacja

Okazuje się, że Symfony nie pyta Cię już, czy chcesz użyć nowej struktury katalogów podczas tworzenia nowej aplikacji Symfony za pomocą Composera. Jednak nadal jest możliwe tworzenie projektów Symfony z nową strukturą katalogów, przy użyciu zmiennej środowiskowej. Aby uzyskać więcej informacji, zobacz Jak mogę utworzyć nowy projekt Symfony z nową strukturą katalogów?

Nic Wortel
źródło
6
Nie musisz ponownie uruchamiać komputera po zmianie .profile, możesz po prostu zresetować plik w bieżącej powłoce lub zakończyć i uruchomić nową powłokę. Uruchomienie . ~/.profilespowoduje ponowne źródło pliku (zwróć uwagę na początkową spację).
Drarok,