新的Symfony 3目录结构是什么?


90

我刚刚使用常规的composer命令创建了一个新的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

@Corneliu确实如此。但是,仍然可以通过在运行Composer之前设置环境变量来触发问题。请参阅我发布的以下问题和答案:stackoverflow.com/q/24956881/1001110
Nic Wortel 2014年

Answers:


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设置为truecomposer将询问您是否要使用新的目录结构。

继续阅读下面的Symfony2Symfony3目录结构之间的所有更改。


新的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

因此,现在我们有两个要比较的目录。


找到difference

您可以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的os)

# 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的os)

这也使添加权限变得更加容易,整个/var目录应可由您的Web服务器写入。您可以按照Symfony2的指南设置权限(代app/cache&& app/logsvar),你想要写在本地也设在这里的任何其他文件。

# 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 2014年

现在我认为为什么命令不起作用是因为作曲家从应用程序移到了bin。
Parixit 2014年

1
截至昨天,我们已经删除了“ 3.0”目录结构问题,因为它使人们感到困惑,并且使用此结构并没有真正的好处。3.0仍然有很长的路要走,但是当我们到达那里时,肯定会有更多有关如何升级的细节:)。
weaverryan 2014年

1
@MarcelBurkhard我已经更新了答案,以显示如何强制使用新的目录结构,您只需添加环境变量SENSIOLABS_ENABLE_NEW_DIRECTORY_STRUCTURE=true(有关详细信息,请查看答案的顶部)
Anil 2014年

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/cacheapp/logs文件夹已移至var/cachevar/logs分别

(当前似乎并非所有旧文件都已删除,因此您可能需要在将所有文件提交到版本控制之前手动进行删除。请参阅此问题

那有什么好处呢?

这些更改有很多好处。首先,Symfony应该可写的所有文件和文件夹现在都在var文件夹中。这应该使配置权限变得容易得多:只需确保对该var文件夹具有写访问权限即可完成操作。这篇博客文章建议这样做 -我自己还没有尝试过。

其次,所有可执行文件(包括console)现在都在bin文件夹中。例如,这允许Bash用户将其添加到他们的.profile文件中:

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

现在,您甚至不必键入任何内容bin/consoleconsole就足够了(请注意,我必须重新启动才能正常工作)。

还有其他一些改进。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应用程序,但这是一个有点棘手的解决方案。我现在已经设法通过许多应用程序来做到这一点,您可以阅读本要点中的步骤。但是,由于它不是为此设计的,因此我无法保证它始终可以正常工作。

更新资料

事实证明,在通过Composer创建新的Symfony应用程序时,Symfony不再询问您是否要使用新的目录结构。但是,仍然可以通过使用环境变量来创建具有新目录结构的Symfony项目。有关更多信息,请参见如何使用新目录结构创建新的Symfony项目?


6
更改后.profile,您无需重新启动,只需在当前Shell中重新获得文件的源,或退出并启动新的Shell。运行. ~/.profile将重新获得文件的源(请注意前导的点空间)。
Drarok 2014年
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.