Zend Framework 2 模块的正确或首选目录结构是什么?


What is the correct or preferred directory structure for a Zend Framework 2 module?

我想通过将其用于一个小项目来掌握 Zend Framework 2。我已经浏览了各种博客文章,文档,当然还有Akrabat(Rob Allen)的精彩教程。

然而,在我所有的阅读中,我没有遇到任何关于Zend Framework 2所期望的模块的正确或首选目录结构的解释。

在 Akrabat 教程中,Rob Allen 的示例模块使用了单个模型和控制器。他选择的目录结构是:

/module
    /Album
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
        /view
            /album
                /album

这一切都很好,但是如果一个模块有多个控制器和模型,就像您在具有多个页面/部分的站点中所期望的那样呢?我是否将所有控制器放在/src/Album/Controller 目录中,还是为每个附加模型和相关控制器和视图创建另一组/src/xxx/目录?

在/view 目录中,我是否将其分解为各种控制器使用的每组视图的子目录?

我认为我的困惑来自于这样一个事实,即在 Rob 的示例中,他的主控制器/模型与模块同名。所以他的相册模块有一个目录,其中包含更多用于模型、控制器和视图的相册目录。如果我将他的模块从相册重命名为 MyModule,那么目录结构会变成:

/module
    /MyModule
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
        /view
            /MyModule
                /album

然后,是否会以这种方式组织一个额外的模型、艺术家和相关控制器:

/module
    /MyModule
        /config
        /src
            /Album
                /Controller
                /Form
                /Model
            /Artist
                /Controller
                /Form
                /Model
        /view
            /MyModule
                /album
                /artist

如果不是上述内容,那么它会是什么结构?

当然,这一切都是假设 ZF2 期望一个严格的结构。如果不是这种情况,那么显然我可以按照我想要的方式组织它。

快速回答您的最后一个问题 - ZF2 确实不关心目录结构。或者我应该说 - 它没有预定义的结构。这就是它具有自动加载器配置和类映射的原因(取决于您选择使用的方法)。

您可以在大多数示例中找到的"默认"自动加载器(请参阅模块.php)仅假设您的 ModuleName 类将在./src/ModuleName目录中找到:

// ./modules/ModuleName/Module.php
public function getAutoloaderConfig()
{
    return array(
        'Zend'Loader'StandardAutoloader' => array(
            'namespaces' => array(
                __NAMESPACE__ => __DIR__ . '/src/' . __NAMESPACE__,
            ),
        ),
    );
}

我想你知道这就是这些__NAMESPACE__部分的含义。

因此,如果您有一个名为 Cat ,它的类应该在 ./modules/Cat/src/Cat 中找到。

如果您决定在应用程序中添加一些新功能,则可以添加另一个名为 Dog 的模块并将其类文件放在 ./Dog/src/Dog 中。

但是,这绝不意味着您必须这样做。您还可以将所有与动物相关的类放在一个模块中,例如 Animals .您必须修改自动加载器,使其如下所示:

// ./modules/Animals/Module.php
public function getAutoloaderConfig()
{
    return array(
        'Zend'Loader'StandardAutoloader' => array(
            'namespaces' => array(
                'Cat' => __DIR__ . '/src/Cat',
                'Dog' => __DIR__ . '/src/Dog',
            ),
        ),
    );
}

。并将您的类放在 ./modules/Animal/src/Cat/Persian.php./modules/Animal/src/Dog/Collie.php 等文件中。

不过,我建议的一件事是将模块视为单独的实体,对其他模块一无所知。作为一个"现实生活"的例子 - 我有一个具有前端(html,css等)和API功能的应用程序。

我有 3 个模块:

  • Application - 包含数据库配置、数据库表类、映射器、模型、身份验证类等。 基本上是任何其他模块可能需要的所有内容。
  • Api - 控制器期望以特定格式请求并将其输出为例如 JSON(即不需要视图)。此模块中的类使用应用程序模块中的类,因为我仍然需要所有数据库功能,但将它们全部分开可以让我将应用程序范围的逻辑与 API 逻辑分离。我可以把这个模块撕掉我想要的,它不会破坏其他任何东西。
  • Website - 仅负责呈现页面的模块。再一次,它使用应用程序中的类,因为我希望能够从数据库中呈现数据并让用户对其进行编辑,但我不希望仅在此模块中使用该功能,因为 API 也需要它。

我的./config/application.config.php按以下顺序加载它们:

return array(
    'modules' => array(
        'Application',
        'Api',
        'Website',
    ),
    // all other entries
);

这意味着我可以从所有其他模块访问应用程序类。如果我想出于某种原因禁用我的 API,我只需删除 Api 目录,我的前端仍然可以工作。

希望这有帮助! :)

博士您可以按照任何您想要的方式构建文件,只是不要忘记正确配置自动加载器。