Какова новая структура каталогов Symfony 3?

90

Я только что создал новый проект Symfony 2.5 с помощью обычной команды композитора:

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

Терминал меня спрашивает:

Хотели бы вы использовать структуру каталогов Symfony 3?

Что это за структура каталогов Symfony 3? Раньше не видел ... Новенькая с 2.5?

Какие преимущества от его использования?

Есть ли способ воспроизвести эту структуру каталогов?

Усман
источник
3
Обратите внимание, что тем временем этот вопрос был удален из установщика, поскольку он вызывал определенную путаницу среди пользователей. Дополнительная информация: github.com/symfony/symfony-standard/issues/674
Корнелиу,
@Corneliu это действительно так. Тем не менее, все еще можно вызвать вопрос, установив переменную среды перед запуском Composer. См. Этот вопрос и ответ, который я опубликовал: stackoverflow.com/q/24956881/1001110
Nic Wortel

Ответы:

176

Я хочу использовать новую структуру каталогов Symfony 3, но не вижу вопроса?

Вопрос Would you like to use Symfony 3 directory structure?был удален при создании нового проекта из-за возникшей путаницы. Вы можете принудительно использовать структуру каталогов, используя следующее:

Если вы предпочитаете новую структуру, вы можете добавить переменную среды SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREв свой .bashrcили .bash_profileтак:

Сделайте так, чтобы все будущие проекты требовали новой структуры

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

Заставьте ТОЛЬКО ЭТОТ проект спрашивать, хотим ли мы использовать новую структуру.

Если вы хотели это только для определенного проекта (разового), вы можете использовать:

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

Если переменная среды SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTUREустановлена ​​и имеет значение true, composerвас спросят, хотите ли вы использовать новую структуру каталогов.

Продолжайте читать ниже обо всех изменениях между структурой каталогов Symfony2и Symfony3.


Какова новая структура каталогов Symfony 3?

(и как это влияет на меня и мой рабочий процесс)

Я изучил это, создав 2 проекта, один со symfony-2.5.0структурой каталогов, другой с symfony-3(только изменение структуры каталогов).

Сделайте по одному из каждого проекта:

# 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

Итак, теперь у нас есть 2 разных каталога, которые мы хотим сравнить.


Найдите diffточку

Вы можете diffпереключаться между двумя каталогами, используя:

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

Здесь показаны файлы, которые отличаются в двух версиях.


Разбивка по 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

Преимущества структуры каталогов Symfony 3

Новая структура каталогов имеет ряд преимуществ, все из которых незначительны и могут потребовать минимальных изменений в рабочем процессе.

PHPUnit

phpunit может быть запущен из корня проекта без необходимости явно указывать путь к файлу конфигурации.

# Symfony2
phpunit -c app/phpunit.xml

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

Бинарные исполняемые файлы

Все двоичные исполняемые файлы теперь все расположены в одном месте - binкаталоге (аналогично 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

Новый /varкаталог

Новый /varкаталог содержит файлы, в которые система записывает данные в ходе своей работы (аналогично unix-подобной ОС) .

Это также упрощает добавление разрешений, весь /varкаталог должен быть доступен для записи вашему веб-серверу. Вы можете следовать руководству Symfony2 по настройке разрешений (заменяя app/cache&& app/logsна var), любые другие файлы, которые вы хотите записать локально, также могут быть расположены здесь.

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

Проверка требований Symfony

При запуске symfony_requirementsбудут выведены обязательные и необязательные конфигурации среды.
например:

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

Вывод

Похоже, Sensio Labs сделала хорошую уборку, все вышеперечисленные изменения имеют смысл, их должно быть легко реализовать при обновлении с 2.5на 3.x, это, вероятно, будет наименьшей из ваших проблем!

Читать документы

Symfony 2.x => 3.0 Обновите документы здесь
Symfony 3.0 Архитектура

Дата выхода Symfony 3

Это выглядит далеким от процесса выпуска (стоит прочитать) :

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

Обновленный процесс выпуска Symfony
(источник: symfony.com )

Анил
источник
Спасибо за вашу помощь, да, я надеюсь, что переход с 2. * на 3.0 будет возможным и легким.
Ousmane
Теперь я думаю, почему команда не работает, потому что композитор перешел из приложения в корзину.
Parixit
1
Со вчерашнего дня мы удалили вопрос о структуре каталогов «3.0», потому что это сбивало людей с толку, и пока нет реальной пользы от использования этой структуры. До версии 3.0 еще далеко, но когда мы доберемся до нее, мы обязательно расскажем, как ее обновить :).
weaverryan
1
@MarcelBurkhard Я обновил свой ответ, чтобы показать, как заставить новую структуру каталогов, вы просто добавляете переменную окружения SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true(подробности смотрите в верхней части моего ответа)
Анил
1
Вы должны обновить ответ и отметить, что они удалили эту опцию из установщика.
Pinoniq
38

Вот список изменений между старой и новой структурой каталогов:

  • Представлена ​​новая varпапка
  • app/console перемещен в bin/console
  • app/check.php перемещен / переименован в bin/symfony_requirements
  • app/phpunit.xml.dist перемещается в корневую папку
  • app/SymfonyRequirements.php перемещен в var/SymfonyRequirements.php
  • app/cacheи app/logsпапки были перемещены var/cacheи var/logs, соответственно ,

(В настоящее время не все старые файлы, похоже, удалены, поэтому вы можете сделать это вручную, прежде чем передавать все файлы в систему контроля версий. См. Эту проблему )

Так в чем же польза?

Эти изменения дают несколько преимуществ. Прежде всего, все файлы и папки, которые должны быть доступны для записи для Symfony, теперь находятся в varпапке. Это должно значительно упростить настройку разрешений: просто обеспечьте доступ для записи в varпапку, и все готово. Это предлагается в этом сообщении в блоге - я еще не пробовал это делать.

Во-вторых, все исполняемые файлы, в том числе console, теперь находятся в binпапке. Это позволяет пользователям Bash, например, добавить это в свой .profileфайл:

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

Теперь вам даже не нужно bin/consoleбольше печатать , consoleдостаточно (обратите внимание, что мне пришлось перезагрузиться, чтобы это сработало).

Есть и другие улучшения. app/check.phpтеперь является исполняемым файлом, поэтому вы можете вызывать его, используя bin/symfony_requirementsвместо php app/check.php. (Воспользовавшись .profileприемом, который я описал ранее, этого symfony_requirementsбудет достаточно)

И, наконец, что не менее важно, вам больше не нужно указывать расположение файла конфигурации при запуске PHPUnit. Так что вместо phpunit -c appвас можно просто выполнить phpunit.

Могу ли я обновить существующие проекты до этой новой структуры?

По умолчанию вы получите только вопрос «Хотите ли вы использовать новую структуру каталогов» при создании нового проекта (использовании composer create-project symfony/framework-standard-edition path/ "2.5.*").

Однако можно обновить существующее приложение Symfony, но это несколько хакерское решение. Сейчас мне удалось сделать это с рядом приложений, и вы можете прочитать шаги в этой сущности . Однако, поскольку он не предназначен для этого, я не могу гарантировать, что он всегда будет работать.

Обновить

Оказывается, Symfony больше не спрашивает вас, хотите ли вы использовать новую структуру каталогов при создании нового приложения Symfony через Composer. Тем не менее, все еще возможно создавать проекты Symfony с новой структурой каталогов, используя переменную среды. Для получения дополнительной информации см. Как я могу создать новый проект Symfony с новой структурой каталогов?

Ник Вортель
источник
6
Вам не нужно перезагружаться после изменения вашего .profile, вы можете просто повторно использовать файл в текущей оболочке или выйти и запустить новую оболочку. Запуск . ~/.profileприведет к повторному исходному файлу (обратите внимание на начальную точку).
Drarok