Magento 2 开发内容目录

本文主要描述如何创建一个最简单的模块。

模块 (Module) 也就是一个包含特定业务子目录(区块blocks控制器controllers模型models帮助文件helper配置相关etc)的文件夹。etc 目录包含有后台权限控制(admin acl)、后台菜单配置、其它配置文件。模块一般在 app/code 目录,全路径: app/code/<Vendor>/<ModuleName>, Vendor 是企业名称如 Baidu。下面创建一个可以执行的模块并显示 “Hello World”。

基础部分主要内容有

创建 Hello World 模块

创建模块需要完成如下几步:

  1. 创建模块目录
  2. 添加 etc/module.xml 文件
  3. 添加 etc/registration.php 文件
  4. 启用模块

第一步: 新建模块文件夹

模块命名格式 VendorName_ModuleName。前一部分是公司名后面是模块名:如:Magento_HelloWorldAqrun_PdfInvoice。我们创建如下目录:

app/code/Aqrun/HelloWorld

第二步:添加 etc/module.xml 文件

然后需要新建 etc 目录并添加 module.xml 文件

app/code/Aqrun/HelloWorld/etc/module.xml

内容:

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Aqrun_HelloWorld" setup_version="1.0.0">
    </module
</config>

第三步:添加 etc/registration.php 文件

这一步添加 registration.php 文件

app/code/Aqrun/HelloWorld/registration.php

内容:

<?php
use Magento\Framework\Component\ComponentRegistrar;

ComponentRegistrar::register(
    ComponentRegistrar::MODULE,
    'Aqrun_HelloWorld',
    __DIR__
);

第四步:启用模块

完成第三步时我们已经创建了 HelloWorld 模块,这一步我们启用它。

使用如下命令可以查看到我们模块处于未启用(Disabled)列表

php bin/magento module:status

未启用模块列表会显示出: Aqrun_HelloWorld

启用指定模块运行:

php bin/magento module:enable Aqrun_HelloWorld

另一种启用模块的方式是编辑 app/etc/config.php 文件, 把你的模块加到这个文件的列表里:

...
'Aqrun_HelloWorld' => 1,
...

完成这一步之后浏览器打开你的网站或许会显示错误信息,可以运行如下命令更新模块

php bin/magento setup:upgrade

刷新浏览器如果页面内容错乱没有样式或以执行静态内容发布命令

php bin/magento setup:static-content:deploy

接下来添加一个控制器测试模块

添加控制器之前需要还要给模块增加一个路由配置

Magento的路由格式有三个部分:前端名称(Frontname)、控制器(Controller)、动作(Action)。如下:

http://mag.dev/index.php/frontname/controller/action

路由配置信息在 routes.xml 文件中 app/code/Aqrun/HelloWorld/etc/frontend/routes.xml

这是前端由配置在 frontend/ 目录,后台路由在 adminhtml/ 目录

内容如下:

<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:App/etc/routes.xsd">
    <router id="standard">
        <route frontName="helloworld" id="helloworld">
            <module name="Aqrun_HelloWorld"/>
        </route>
    </router>
</config>

这个路由配置的URL路径就会是 http://mag.dev/helloworld/*

然后继续添加控制器和动作

新建路径及文件:app/code/Aqrun/HelloWorld/Controller/Index/Test.php

代码:

namespace Aqrun\HelloWorld\Controller\Index;

class Test extends \Magento\Framework\App\Action\Action
{
    protected $_pageFactory;

    public function __construct(
        \Magento\Framework\App\Action\Context $context,
        \Magento\Framework\View\Result\PageFactory $pageFactory
    ){
        $this->_pageFactory = $pageFactory;
        return parent::__construct($context);
    }

    public function execute()
    {
        echo "Hello World";
        exit;
    }
}

然后执行 php bin/magento cache:clean

浏览器打开链接 http://mag.dev/helloworld/index/test 测试结果

就会显示 Hello World。下一部分内容了解如何创建完整的控制器