magento教程第二章请求分发与控制器.docx

1、magento教程第二章请求分发与控制器深入理解Magento作者：Alan Storm翻译：zhlmmc第二章 - Magento请求分发与控制器Model-View-Controller (MVC) ，模型-视图-控制器，源于Smalltalk编程语言和Xerox Parc。现在有很多系统是基于MVC架构的，不同的系统MVC的实现也略有不同，但都体现了MVC的精髓，分离数据，业务逻辑和显示逻辑。最常见的 PHP MVC框架是这样的1 URL请求被一个PHP文件拦截，通常称为前端控制器（Front Controller）2 这个PHP文件分析这个URL，获得一个执行控制器（Action Co

2、ntroller）的名字和一个执行方法（Action Method）的名字，这个过程通常称为路由（Routing）3 实例化#2获得的执行控制器4 调用执行控制器的执行方法5 执行方法中处理业务逻辑，比如获取数据6 执行控制器负责把数据传递给显示逻辑7 显示逻辑生成HTML这个架构相对于传统的“每个php都是一个页面”来讲已经是一个巨大的飞跃，但还是有人抱怨【译者注： CodeIgniter就是这样一个MVC框架】 前端控制器仍然以全局的方式运行 基于配置的惯例导致了系统不够模块化 o URL Routing不够灵活o 控制器往往和视图绑定o 更改默认设置往往导致大量的重构Magento创造了

3、一个更抽象的MVC来解决上述问题。1 URL请求被一个PHP拦截2 这个PHP文件实例化一个Magento对象3 Magento对象实例化前端控制器4 前端控制器实例化全局配置中指定的路由对象，可以是多个5 路由对象会逐个与请求URL匹配6 如果发现匹配，那么可以获得一个执行控制器和一个执行方法的名字7 实例化#6获得的执行控制器，并调用相应的执行方法8 URL请求被一个PHP拦截9 这个PHP文件实例化一个Magento对象10 Magento对象实例化前端控制器11 前端控制器实例化全局配置中指定的路由对象，可以是多个12 路由对象会逐个与请求URL匹配13 如果发现匹配，那么可以获得一个

4、执行控制器和一个执行方法的名字14 实例化#6获得的执行控制器，并调用相应的执行方法15 执行方法中处理业务逻辑，模型数据16 控制器实例化布局对象（Layout）17 布局对象根据请求的参数，系统配置创建一个块对象（Block）列表，并实例化18 布局对象会调用块对象的output方法生成HTML。这是一个递归的过程，因为块对象可以嵌套块对象19 每一个块对象都和一个模板文件（Template File）对应。块对象包含了显示逻辑，模板文件包含了HTML和PHP输出代码20 块对象直接从模型那里获得数据，换句话说，在Magento的MVC架构中，控制器并不直接把数据传给视图这里很复杂，我们以

5、后会详细解释每一个部分。我们先关注“前端控制器-路由对象-执行控制器”部分。Hello World示例我们讲了太多理论，现在让我们来实践一下，通过实践来加深理解。下面是我们将要做的事情21 创建一个Hello World模块22 为这个模块配置路由23 为这个模块创建执行控制器 创建Hello World模块首先，我们要创建一个模块的目录结构，这个我们以前已经做过了，就不再熬述app/code/local/Alanstormdotcom/Helloworld/Block app/code/local/Alanstormdotcom/Helloworld/controllers app/code

6、/local/Alanstormdotcom/Helloworld/etc app/code/local/Alanstormdotcom/Helloworld/Helper app/code/local/Alanstormdotcom/Helloworld/Model app/code/local/Alanstormdotcom/Helloworld/sql下面是config.xml的内容PATH: app/code/local/Alanstormdotcom/Helloworld/etc/config.xml 源码打印？24 25 26 27 0.1.0 28 29 30 然后我们要创建一个

7、系统配置文件来激活这个模块 PATH: app/etc/modules/Alanstormdotcom_Helloworld.xml源码打印？31 32 33 34 true 35 local 36 37 38 最后，让我们检查一下模块是不是已经被激活39 清空Magento缓存40 在管理后台，进入 System-Configuration-Advanced41 展开“Disable Modules Output”42 确认Alanstormdotcom_Helloworld显示出来了 配置路由下面，我们要配置一个路由。路由是用来把一个URL请求转换成一个执行控制器和方法。和传统的PHP M

8、VC不同的是，你需要在Magento的全局配置中显式的定义你的路由。我们继续上面的例子，在config.xml中，添加如下代码源码打印？43 44 . 45 46 47 48 standard 49 50 Alanstormdotcom_Helloworld 51 helloworld 52 53 54 55 56 . 57 在这里，我们有很多新名词要解释。 什么是？标签指向一个Magento区（Area），比如“frontend”就是指网站的前台，“admin”是指网站的后台，“install”是 指Magento的安装程序。【译者注：这个有点像磁盘分区，区和区之间是相互独立的，但是都归操作

9、系统能够管理，在这里归Magento管理。默认的 Magento安装没有“install”这个区，frontend区接管了，全局配置中的以下代码可以解释这一点源码打印？58 59 . 60 61 standard 62 63 Mage_Install 64 install 65 66 67 . 68 】什么是？Phil Karlton有一句很著名的话“在计算机领域只有两件事是困难的：缓存和命名”。Magento引入了很多新概念，无疑存在很多命名问题，这里就是一个 例子。标签有时候包含的是路由对象的定义，有时候包含的是路径的定义。路由对象是进行路由操作的实体，而路径仅仅是路由对 象的一个参数。【

10、译者注： 如果你仔细看过那个全局配置xml的话，你会发现有两处地方出现，一处是“ - ”，另外一处是“ - ”。你再仔细看看会发现两处包含的内容不一样。第一处包含的是路由对象的定义，第二处包含 的是路径的定义。】 什么是？这个标签的内容应该是一个模块的全名，Packagename_Modulename，在这里是“Alanstormdotcom_Helloworld”。Magento用这个名字来定位你的模块文件。什么是？当一个router解析一个URL的时候，它是按照如下规则进行的所以，当我们在标签里定义了“helloworld”以后，Magento会把如下的URL请求交给我们的模块“Alans

11、tormdotcom_Helloworld”来处理有些人容易把和前端控制器（Front Controller）混淆起来。它们是两个不同的概念，只跟路由相关。【译者注： 根据我们前面讲过的Magento的MVC流程，前端控制器是用来实例化所有路由的，而这里的“frontName”只是路由过程中的一个参数】什么是 ？这个标签的名字应该是模块名字的小写版本。我们的模块名字是“Helloworld”，所以这里我们用“helloworld”。你应该也已经注意到我们 定义的“frontName”也是和我们的模块相匹配的。这是一个不成文的规定，但不是强制要求。事实上，一个模块可以定义多 个，也就是可以有多个

12、“frontName”。为路由创建执行控制器还记得Magento的MVC流程吗？路由会把控制权交给执行控制器。上面我们定义了路由，现在我们来定义我们的执行控制器。首先创建文件app/code/local/Alanstormdotcom/Helloworld/controllers/IndexController.php模块的控制器应该放在模块的子目录“controllers”（小写c）里面。这是规定，Magento会在这个目录寻找模块的控制器文件。我们的第一个控制器包含以下内容源码打印？69 class Alanstormdotcom_Helloworld_IndexController ex

13、tends Mage_Core_Controller_Front_Action 70 public function indexAction() 71 echo Hello World!; 72 73 清空Magento缓存，请求如下URL如果你看到一个空白页面上面写着“Hello World”，那么恭喜你，你已经成功创建了你的第一个Magento控制器！如何命名执行控制器？还记得config.xml的标签吗？Alanstormdotcom_Helloworld执行控制的名字的构成如下74 以标签的内容开始 （Alanstormdotcom_Helloworld）75 紧接一个下划线 （Ala

14、nstormdotcom_Helloworld_）76 加上我们给控制器取的名字“Index”(Alanstormdotcom_Helloworld_Index)77 最后加上关键词“Controller” （Alanstormdotcom_Helloworld_IndexController）我们自己定义的属于frontend区的执行控制器都应该继承Mage_Core_Controller_Front_Action。URL里面的index/index是什么意思？正如前文所述，Magento默认的路由的规则如下所以在我们请求的URL其 中“helloworld”是“frontName”，第一个

15、“index”是执行控制器（Action Controller）的名字，第二个“index”是执行方法的名字。对比我们写的执行控制器代码，我们不难发现执行方法的定义是执行方法名字加上 “Action”关键字public function indexAction().Magento根据命名规则找到执行控制器文件并实例化，然后再根据命名规则调用指定的执行方法。如果URL没有给出执行控制器名字或者执行方法，Magento会用默认的“index”来替代，所以下面三个URL是等价的我们再来看一个例子。如果URL如下Magento的执行步骤如下78 查询全局配置，找到frontName “checkout

16、”对应的模块，Mage_Checkout79 找到执行控制器 “Mage_Checkout_CartController”80 调用执行控制器的“addAction”方法进一步理解执行控制器下面我们来为我们的执行控制器添加一个执行方法。添加如下代码到IndexController.php源码打印？81 public function goodbyeAction() 82 echo Goodbye World!; 83 请求URL这 次你应该看到“Goodbye World!”。因为我们继承了“Mage_Core_Controller_Front_Action”，我们可以使用一些父类已经定义好的

17、方法和变 量。比如父类会把URL后面跟的参数转换成key/value的数组。添加如下代码到我们的执行控制器源码打印？84 public function paramsAction() 85 echo ; 86 foreach($this-getRequest()-getParams() as $key=$value) 87 echo Param: .$key.; 88 echo Value: .$value.; 89 90 echo ; 91 请求如下URL你应该看到如下输出Param: foo Value: barParam: baz Value: eof最后，让我们再写一个执行控制器，用来

18、处理一下URL这里的执行控制器名字是“messages”，所以我们要创建如下文件app/code/local/Alanstormdotcom/Helloworld/controllers/MessagesController.php执行控制器的类名应该是Alanstormdotcom_Helloworld_MessagesController添加执行方法源码打印？92 public function goodbyeAction() 93 94 echo Another Goodbye; 95 好了，Magento的MVC架构大概就是这样了。它比传统的PHP MVC要复杂一点，但是Magento的这个高度灵活的MVC架构能让你创造出几乎所有你能想到的URL结构。