首页 文章

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

提问于
浏览
89

我刚刚使用常规的composer命令创建了一个新的Symfony 2.5项目:

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

终端问我:

您想使用Symfony 3目录结构吗?

这个Symfony 3目录结构是什么?我以前从未见过它......自2.5以来它是新的吗?

使用它有什么好处?

有没有办法复制这个目录结构?

2 回答

  • 175

    我想使用新的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
    

    所以现在我们有两个不同的目录要比较 .


    找出差异

    您可以使用以下两个目录之间的 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
    */
    

    这显示了2个版本中不同的文件 .


    差异细分

    这是差异中所有内容的细分 .

    # 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 guide for setting permissions(用 app/cache 替换 app/cache && app/logs ),你想在本地写的任何其他文件也可以在这里找到 .

    # 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 Upgrade docs here
    Symfony 3.0 The Architecture

    Symfony 3的发布日期

    它看起来很远看发布过程(值得一读):

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

    Updated Symfony release Process

  • 37

    以下是旧目录结构和新目录结构之间的更改列表:

    • 引入了新的 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

    (目前并非所有旧文件都被删除,因此您可能希望在将所有文件提交到版本控制之前手动执行此操作 . 请参阅this issue

    那有什么好处?

    这些变化有几个好处 . 首先,Symfony应该可写的所有文件和文件夹现在都在 var 文件夹中 . 这应该使配置权限变得更加容易:只需确保对 var 文件夹的写访问权限即可完成 . 这在this blog post中提出 - 我自己还没有尝试过 .

    其次,所有可执行文件(包括 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 而不是 phpunit -c app .

    我可以将现有项目升级到这个新结构吗?

    默认情况下,'ll only get the '您是否要在创建新项目时使用新目录结构'问题(使用 composer create-project symfony/framework-standard-edition path/ "2.5.*" ) .

    但是,可以升级现有的Symfony应用程序,但这是一个有点hacky的解决方案 . 我现在已经设法使用了许多应用程序,您可以阅读步骤in this gist . 但是,由于它不是为此而设计的,我无法保证它将始终有效 .

    更新

    事实证明,当通过Composer创建新的Symfony应用程序时,Symfony不再询问您是否要使用新的目录结构 . 但是,仍然可以使用环境变量使用新目录结构创建Symfony项目 . 有关更多信息,请参阅How can I create a new Symfony project with the new directory structure?

相关问题