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

Question

我想通过将它用于一个小项目来掌握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的例子中,他的主要控制器/模型与模块的名称相同.所以他的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.

但是,这绝不意味着你必须这样做.您还可以将所有与动物相关的类放在一个名为eg的模块中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 - 包含数据库配置,db表类,映射器,模型,身份验证类等.基本上是任何其他模块可能需要的所有内容.
• Api - 让控制器期望以特定格式发出请求并将其输出为例如JSON(即不需要视图).这个模块中的类正在使用Application模块中的类,因为我仍然需要所有的数据库功能,但是将它们全部分开,这让我将应用程序范围的逻辑与API逻辑分开.我可以把我想要的模块拆掉,它不会破坏其他任何东西.
• Website - 仅负责渲染页面的模块.再一次,它使用了应用程序中的类,因为我希望能够从数据库中呈现数据并让用户编辑它,但我不希望仅在此模块中使用该功能,因为Api也需要它.

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

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

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

希望这可以帮助!:)

TL; DR您可以以任何方式构建文件,只是不要忘记正确配置自动装带器.