2. 如何创建 Magento 2 控制器

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

控制器(Controller)在模块开发和 PHP MVC 框架中都很重要。主要功能是接收请求、处理逻辑并显示页面。

Magento 2 模块的控制器目录包含有一个或多个动作类(Action Class)文件,动作类有一个 execute 方法。控制器主要有两种 前端控制器后台控制器, 它们工作流都一样,后台控制器有一些小区别,多一个检测权限的方法。

控制器如何工作的?

控制器接收来自终端(浏览器或控制台)的请求,如:

http://example.com/route_name/controller/action
  • route_name 是在 routes.xml 文件中配置的唯一名称
  • controllerController 目录下的文件夹名称
  • action 是包含 execute 方法的类来处理请求

Magento 系统里有一个很重要的类 FrontController (Magento\Framework\App\FrontController),它主要接收请求然后通过 route_name 路由到指定控制器和动作,如下代码:

foreach ($this->_routerList as $router) {
    try {
        $actionInstance = $router->match($request);
    ...
}

如果有匹配的控制器动作类,则会调用动作类的 execute() 方法。

如何在 Magento 2 创建控制器

创建控制器需要如下几步

  • 1 创建 routes.xml 文件
  • 2 创建控制器文件
  • 3 创建控制器布局文件(Layout)
  • 4 创建控制器区块文件(Block)
  • 5 创建控制器模板文件(Template)
  • 6 清除缓存
  • 7 测试新增的控制器

要创建控制器,要在模块的 Controller 文件夹添加目录并增加动作类文件。 如: 我们为 Aqrun_HelloWorld 模块添加一个 index 控制器和一个 index 动作。

第一步:添加 routes.xml 文件

文件: app/code/Aqrun/HelloWorld/etc/frontend/routes.xml

<?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>

在上一章节的如何创建模块中,我们已经添加过 routes.xml 文件,如何做过了这一步可以跳过。

第二步:增加控制器文件

文件: app/code/Aqrun/HelloWorld/Controller/Index/Index.php

<?php
namespace Aqrun\HelloWorld\Controller\Index;

class Index 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()
    {
        return $this->_pageFactory->create();
    }
}

如你所见,所有的控制器都必要继承自 \Magento\Framework\App\Action\Action 类,这个类会分发动作并调用动作类的 execute() 方法。此例我们所有的控制器逻辑都在这个 execute() 方法中,并给请求返回响应。

第三步:创建布局文件(Layout)

文件:app/code/Aqrun/HeloWorld/view/frontend/layout/helloworld_index_index.xml

<?xml version="1.0"?>
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" layout="1column" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <referenceContainer name="content">
        <block class="Aqrun\HelloWorld\Block\Index" name="helloworld_index_index" template="Aqrun_HelloWorld::index.phtml" />
    </referenceContainer>
</page>

第四步: 创建区块文件

文件: app/code/Aqrun/HelloWorld/Block/Index.php

<?php
namespace Aqrun\HelloWorld\Block;

class Index extends \Magento\Framework\View\Element\Template
{

}

第五步:创建模板文件

文件:app/code/Aqrun/HelloWorld/view/frontend/templates/index.phtml

<h2>欢迎你我的朋友!</h2>

关于视图(布局、区块、模板)的更多内容查看这里

第六步:刷新缓存

查看如何清除Magento缓存

第七步:运行测试

浏览器访问:

http://mage.dev/helloworld/index/index

http://mage.dev/helloworld/

权限控制 - ACL

在后台控制器有权限检测的方法。如:

protected function _isAllowed()
{
    return $this->_authorization->isAllowed('Magento_AdminNotification::show_list');
}

这段代码会检测当前用户是否有权限执行这个动作,更多内容查看后台权限控制

Magento 2 控制器的其它方法

_forward()_redirect() 方法

\Magento\Framework\App\Action\Action 类给我们提供了2个重要的方法: _forward_redirect

Forward 方法

_forward() 方法会修改请求转发到另一个控制器动作,但不会改变请求的URL。如,我们有2个方法 Forward 和 Hello World:

namespace Aqrun\HelloWorld\Controller\Test;

class Forward extends \Magento\Framework\App\Action\Action
{
    public function execute()
    {
        $this->_forward('hello');
    }
}

如果请求 http://mage.dev/route_name/test/forward, 页面就会显示:

欢迎你我的朋友!

你也可以在转发时改变控制器、模块并传递请求参数,详细查看函数定义:

protected function _forward($action, $controller=null, $module=null, array $params=null)
{
    $request = $this->getRequest();
    $request->initForward();

    if (isset($params)) {
        $request->setParams($params);
    }

    if (isset($controller)) {
        $request->setControllerName($controller);

        // Module should only be reset if controller has been specified
        if (isset($module)) {
            $request->setModuleName($module);
        }
    }

    $request->setActionName($action);
    $request->setDispatched(false);
}

Redirect 方法

这个方法会转发到另一个控制器动作类,并且改变响应头和请求的URL。上例中如果我们把 _forward() 改成 _redirect() 方法:

    $this->_rediect('*/*/hello');

现在访问链接 http://mage.dev/route_name/test/forward, URL会变为 http://mage.dev/route_name/test/hello, 页面也会显示 “欢迎你我的朋友!”。

到这里控制器部分就完结了,下一章节了解如何创建模型

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

推荐阅读更多精彩内容