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

Question

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

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

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

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

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

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

我认为我的困惑是因为在 Rob 的示例中，他的主控制器/模型与模块同名。所以他的 Album 模块有一个目录，其中有更多的 Album 目录用于模型、控制器和视图。如果我将他的模块从 Album 重命名为 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 需要一个严格的结构。如果不是这种情况，那么显然我可以按照我想要的方式组织它。

Answer 1

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

您可以在大多数示例中找到的“默认”自动加载器（参见 Module.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（即不需要视图）。这个模块中的类使用来自 Application 模块的类，因为我仍然需要所有的数据库功能，但是将它们全部分开可以让我将应用程序范围的逻辑与 API 逻辑分开。我可以按照自己的意愿撕掉这个模块，它不会破坏其他任何东西。
• Website - 只负责渲染页面的模块。再一次，它使用应用程序中的类，因为我希望能够呈现数据库中的数据并让用户对其进行编辑，但我不希望仅在此模块中提供该功能，因为 Api 也需要它。

我的./config/application.config.php 按此顺序加载它们：

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

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

希望这会有所帮助！ :)

TL;DR 您可以按照自己的方式构建文件，只是不要忘记正确配置自动加载器。