1. Magneto 2 模块开发 - 简单的 Hello World 模块

Magento 2 模块开发基础部分 - 目录

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

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

基础部分主要内容有

  • 创建控制器(Controller)
  • 创建模型(Model)
  • 创建视图(View)
  • 后台菜单(Admin Menu)
  • 参数配置(Configuration)
  • 后台网格(Grid)

创建 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。下一部分内容了解如何创建完整的控制器

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354

推荐阅读更多精彩内容