Magento 2 开发内容目录
控制器(Controller)在模块开发和 PHP MVC 框架中都很重要。主要功能是接收请求、处理逻辑并显示页面。
Magento 2 模块的控制器目录包含有一个或多个动作类(Action Class)文件,动作类有一个 execute
方法。控制器主要有两种 前端控制器 和 后台控制器, 它们工作流都一样,后台控制器有一些小区别,多一个检测权限的方法。
控制器如何工作的?
控制器接收来自终端(浏览器或控制台)的请求,如:
route_name
是在 routes.xml
文件中配置的唯一名称
controller
是 Controller
目录下的文件夹名称
action
是包含 execute
方法的类来处理请求
Magento 系统里有一个很重要的类 FrontController
(Magento\Framework\App\FrontController
),它主要接收请求然后通过 route_name
路由到指定控制器和动作,如下代码:
如果有匹配的控制器动作类,则会调用动作类的 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
在上一章节的如何创建模块中,我们已经添加过 routes.xml 文件,如何做过了这一步可以跳过。
第二步:增加控制器文件
文件: app/code/Aqrun/HelloWorld/Controller/Index/Index.php
如你所见,所有的控制器都必要继承自 \Magento\Framework\App\Action\Action
类,这个类会分发动作并调用动作类的 execute()
方法。此例我们所有的控制器逻辑都在这个 execute()
方法中,并给请求返回响应。
第三步:创建布局文件(Layout)
文件:app/code/Aqrun/HeloWorld/view/frontend/layout/helloworld_index_index.xml
第四步: 创建区块文件
文件: app/code/Aqrun/HelloWorld/Block/Index.php
第五步:创建模板文件
文件:app/code/Aqrun/HelloWorld/view/frontend/templates/index.phtml
关于视图(布局、区块、模板)的更多内容查看这里
第六步:刷新缓存
查看如何清除 Magento 缓存
第七步:运行测试
浏览器访问:
或
权限控制 - ACL
在后台控制器有权限检测的方法。如:
这段代码会检测当前用户是否有权限执行这个动作,更多内容查看后台权限控制
Magento 2 控制器的其它方法
_forward()
和 _redirect()
方法
\Magento\Framework\App\Action\Action
类给我们提供了 2 个重要的方法: _forward
和 _redirect
。
Forward 方法
_forward()
方法会修改请求转发到另一个控制器动作,但不会改变请求的 URL。如,我们有 2 个方法 Forward 和 Hello World:
如果请求 http://mage.dev/route_name/test/forward
, 页面就会显示:
你也可以在转发时改变控制器、模块并传递请求参数,详细查看函数定义:
Redirect 方法
这个方法会转发到另一个控制器动作类,并且改变响应头和请求的 URL。上例中如果我们把 _forward()
改成 _redirect()
方法:
现在访问链接 http://mage.dev/route_name/test/forward
, URL 会变为 http://mage.dev/route_name/test/hello
, 页面也会显示 “欢迎你我的朋友!”。
到这里控制器部分就完结了,下一章节了解如何创建模型