深入理解magento.docx

1、深入理解magentoMagento模块开发教程第一章Magento强大的配置系统Magento的配置系统就像是Magento的心脏，支撑着Magento的运行。这套 配置系统掌管着几乎所有“module/model/class /template/etc”。它把整个 Magento系统抽象出来，用一个配置文件来描述。这里的“配置文件”并不是一 个物理上存在的文件，而是Magento根据当前的系统状态动态生成的一段XML。 大多数的PHP开发者并不习惯于这样抽象层，因为它增加的编程的复杂性。但是 这样的抽象提供了无与伦比的灵活性，允许你覆盖几乎任何系统的默认行为。首先，让我们写一个简单的插件来

2、看看这个所谓的“配置文件”长什么样。虽然 我已经提供的现成的代码，但是还是建议你自己建立这个插件，把整个流程走一 遍有助于你的理解。设置插件的目录结构我们将要创建一个Magento的模块【注：Magento的插件不叫plug-in,叫 module,翻译成模块】。Magento的模块由php和xml文件组成，目的是扩展或 者覆盖系统的行为，比如为订单增加数据模型，更改一个类的方法，或者增加 一个全新的功能。【注：Magento自带的那些功能也都是基于模块的，比如用户 注册，商品展示，结账流程等等。Magento给我的感觉就是一切皆模块，和 Eclipse的插件体系结构有点像】大多数Magent

3、o的系统模块的结构和我们将要构建的插件的结构是一样的。 Magento的系统模块在以下目录 app/code/core/Mage每一个子目录都是一个单独的模块。这些模块是由Magento官方开发的。我们安 装完Magento以后，所使用的功能就是来自这些模块。我们自己创建的模块应该 放在如下目录app/code/local/Packagename“Packagename”应该是一个唯一的字符串，用来标识你的代码。通常人们使用 公司名字作为Packagename,比如 app/code/local/Microsoft由于我在做我自己的Magento项目，我将使用我自己的域名 “Alanstorm

4、dotcom”。然后，我们要创建以下目录结构 app/code/local/Alanstormdotcom/Configviewer/Blockapp/code/local/Alanstormdotcom/Configviewer/controllers app/code/local/Alanstormdotcom/Configviewer/etc app/code/local/Alanstormdotcom/Configviewer/Helper app/code/local/Alanstormdotcom/Configviewer/Model app/code/local/Alanstor

5、mdotcom/Configviewer/sql你的插件并不一定需要包含以上所有的目录，但是为了以后开发方便，我们还是 在一开始就把目录创建好。接下来我们要创建两个文件，一个是config. xml， 放在etc目录下面app/code/local/Alanstormdotcom/Configviewer/etc/config. xml 文件内容如下 modules0. 1. 0/modules第二个文件需要在如下位置创建app/etc/modules/Alanstormdotcom_Configviewer. xml第二个文件应该遵循如下命名规则“Packagename_Modulename

6、. xml”，文件内容 如下modulestruelocal/modules我们先不管这些文件是干什么的，以后会解释。建立好这两个文件以后，你的模 块的骨架就己经完成了。Magento己经知道你的模块存在，但是现在你的模块不 会做任何事情。我们来确认一下Magento确实装载了你的模块 1.清空Magento缓存2. 在后台管理界面，进入 System-Configuration-Advanced3. 展开 “Disable Modules Output”4. 确认 “Alanstormdotcom_Configviewer” 显示出来了如果你看到“Alanstormdotcom_Config

7、viewer”，那么恭喜你，你己经成功创建 了你第一个Magento模块！创建模块逻辑我们之前创建的模块不会做任何事情，下面我们来为这个模块加入逻辑1. 检查showConfig查询字符串是否存在2. 如果showConfig存在，那么检查showConfigFormat查询字符串是否存在3. 如果showConfigFormat存在，那么输出指定格式的配置信息，否则输出默认格式的配置 信息4. 终止执行流程首先更改我们的config.xml文件 modules. . . controller_front_init_routersobservers singletonAlanstormdotc

8、om_Configviewer_Model_ObservercheckForConfigRequest /observers然后创建如下文件Alanstormdotcom/Configviewer/Model/Observer. php 输入以下内容 request = $observer-getEvent () -getData ( front) -getRequest ();if ($this-request-self:FLAG_SHOW_CONFIG = true，) $this-setHeader();$thi s-outputConf i g ();private function

9、setHeader() $format =isset($this-request-self:FLAG_SHOW_CONFIG_FORMAT) ?$this-request-self:FLAG_SHOW_CONFIG_FORMAT:switch($format) case texty :header(Content-Type: text/plain); break; default:header (Content-Type: text/xml）;private function outputConfigO die (Mage: :app () -getConfig() -getNode () -

10、asXML();好了，代码编辑结束。清空你的Magento缓存，输入如下URL http:/magento. example, com/?showConfig=true【注：根据文中的配置，不难看出任何指向Magento的URL加了?showConfig=true以后,都会输出同样的内容，正常的执行流程会被终止。】配置文件分析打开上述URL，你应该看到一个巨大的XML文件。这个文件描述了当前 Magento系统的状态。它列出了所有的模块，数据模型，类，事件，监听器等等。 举个例子，如果你搜索如下字符串 Configviewer_Model_0bserver你会发现刚刚Y尔创建1那个类被列出来了

11、。Magento会解析每个模块的 config. xml,并把它们包含在这个全局配置中。这个配置文件有啥用？到目前为止，我们所作的事情似乎没什么意义，但是这个配置文件却是理 解Magento的关键因素。你创建的每一个模块都会被加到这个配置文件中，任何 时候，你需要调用一个系统功能的时候，Magento都会通过这个配置文件来查 询相应的模块和功能。举个简单的例子，如果你懂MVC的话，你应该和“helper class”之类概念的打过交道$helper_salesrule = new Mage_SalesRule_Helper();Magento抽象了 PHP的类声明方式。在Magento系统中，

12、上面的代码等同于 $helper_salesrule = Mage:helper( salesrule);Magento将通过以下逻辑来处理这行代码1. 在配置文件中查找helpers /标签2. 在helpers /里面查找salesrule /标签3. 在sales /里面查找class /标签4. 实例化从#3 找到的类（Mage_SalesRule_Helper)Magento总是通过配置文件来获得类名，这个逻辑看起来有些复杂，但这样做的 优点也很明显，我们可以不需要更改Magento的代码就能更改Magento的核心功 倉泛。【注：在这个例子中，我们可以通过修改配置文件用我们自己的

13、SalesRule_Helper类来替换原来那个】这种高度抽象的编程方式在php中并不 常见，但是它可以让你清晰的扩展或者替换系统的某一部分。第二章Magento请求分发与控制器Model-View-Controller (MVC),模型-视图-控制器，源于Smalltalk编程语言 和Xerox Parc。现在有很多系统是基于MVC架构的，不同的系统MVC的实现也 略有不同，但都体现了 MVC的精髓，分离数据，业务逻辑和显示逻辑。最常见的 PHP MVC框架是这样的1. URL请求被一个PHP文件拦截，通常称为前端控制器（Front Controller)2. 这个PHP文件分析这个URL,

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

15、默认设置往往导致大量的重构Magento创造了一个更抽象的MVC来解决上述问题。Magento MVC Flow Created By 1. Magento Application is instantiated 2. Request and Response objects are stored on the static Mage , class, and referenced throughout the dispatching process Mage:app() E Response Reque3. Front Controller is instantiated and initO

16、dFront Controller Object4. During Initialization, Front Controller checks global config at global/web/routers for any routers, instantiates them, and stores them as internal propertiesRouter(s)5. During Front Controller dispatch, the Front Controller iterates over each of its routers, and attempts t

17、o match against the request. When a match is found, an Action Controller is instantiated and its action method is calledAction Controller is created from second part of URI path. Its Action Method is created from the third.http :/example .com/first/ second/thirdWhile matching for an Action Controlle

18、r and Action，the $request object is checked first, before the URLAction Controller7. Each individual Action Controller is responsible for loading a layout (loadLayout method), and then rendering that layoutController manipulates Models based on requestLayout8. Each request will have a number of hand

19、les (defau It，THEME 一 frontend-default一barefoot， checkout_cartndex，etc.). The global combined layout we be searched for these handles, and their innerXML will be combined to create an XML layout file for a particular requestY/fT /flI1. URL请求被一个PHP拦截2. 这个PHP文件实例化一个Magento对象3. Magento对象实例化前端控制器4. 前端控制

20、器实例化全局配置中指定的路由对象，可以是多个5. 路由对象会逐个与请求URL匹配6. 如果发现匹配，那么可以获得一个执行控制器和一个执行方法的名字7. 实例化#6获得的执行控制器，并调用相应的执行方法8. 执行方法中处理业务逻辑，模型数据9. 控制器实例化布局对象（Layout)10. 布局对象根据请求的参数，系统配置创建一个块对象（Block)列表，并 实例化11. 布局对象会调用块对象的output方法生成HTML。这是一个递归的过程， 因为块对象可以嵌套块对象12. 每一个块对象都和一个模板文件（Template File)对应。块对象包含了 显示逻辑，模板文件包含了 HTML和PHP输

21、出代码13. 块对象直接从模型那里获得数据，换句话说，在Magento的MVC架构中， 控制器并不直接把数据传给视图这里很复杂，我们以后会详细解释每一个部分。我们先关注“前端控制器_路由 对象_执行控制器”部分。创建magento模块Hello World 示例我们讲了太多理论，现在让我们来实践一下，通过实践来加深理解。下面是我们 将要做的事情1. 创建一个Hello World模块2. 为这个模块配置路由3. 为这个模块创建执行控制器创建Hello World模块首先，我们要创建一个模块的目录结构，这个我们以前已经做过了，就不再熬述app/code/local/Alanstormdotcom

22、/Helloworld/Block app/code/local/Alanstormdotcom/Helloworld/controllers app/code/local/Alanstormdotcom/Helloworld/etcapp/code/local/Alanstormdotcom/Helloworld/Helper app/code/local/Alanstormdotcom/Helloworld/Model app/code/local/Alanstormdotcom/Helloworld/sql 下面是config. xml的内容PATH: app/code/local/Al

23、anstormdotcom/Helloworld/etc/config. xml modulesA1an s tormdotcom_He11oworld0. 1. 0/modules然后我们要创建一个系统配置文件来激活这个模块 PATH: app/etc/modules/Alanstormdotcom_Helloworld. xml modulesA1an s tormdotcom_He11oworldtruelocal/modules最后，让我们检查一下模块是不是己经被激活1. 清空Magento缓存2. 在管理后台，进入 System-Configuration-Advanced3. 展开

24、Disable Modules Output4. 确认 Alanstormdotcom_Helloworld 显不出来了配置路由下面，我们要配置一个路由。路由是用来把一个URL请求转换成一个执行控制器 和方法。和传统的PHPMVC不同的是，你需要在Magento的全局配置中显式的定 义你的路由。我们继续上面的例子，在config. xml中，添加如下代码standardmo du 1 e A1 an s tormdo t c om_He 11 owor ld/module helloworld在这里，我们有很多新名词要解释。什么是 ?frontend/标签指向一个Magento区（Area)，

25、比如“frontend”就是指网站 的前台，“admin”是指网站的后台，“install”是指Magento的安装程序。 【注：这个有点像磁盘分区，区和区之间是相互独立的，但是都归操作系统能够 管理，在这里归Magento管理。默认的Magento安装没有“install”这个区， frontend区接管了，全局配置中的以下代码可以解释这一点 installstandardMage_Installinstall/install)什么是routers /?Phil Karlton有一句很著名的话“在计算机领域只有两件事是困难的：缓存和 命名”。Magento引入了很多新概念，无疑存在很多命名问

26、题，这里就是一个例 子。routers标签有时候包含的是路由对象的定义，有时候包含的是路径的定 义。路由对象是进行路由操作的实体，而路径仅仅是路由对象的一个参数。【注: 如果你仔细看过那个全局配置xml的话，你会发现有两处地方出现routers， 处是 “ -routers”，另外一处是 “frontend-routers”。 你再仔细看看会发现两处routers包含的内容不一样。第一处包含的是路由对 象的定义，第二处包含的是路径的定义。】什么是?这个标签的内容应该是一个模块的全名，Packagename_Modulename，在这里是 “Alanstormdotcom_Helloworld”

27、。Magento用这个名字来定位你的模块文件。什么是?当一个router解析一个URL的时候，它是按照如下规则进行的 http:/www. efish. tk/frontName/actionContro11erName/actionMethod/所以，当我们在frontName标签里定义了 “helloworld”以后，Magento会把 如下的URL请求交给我们的模块“Alanstormdotcom_Helloworld”来处理 http:/www. efish. tk/he11oworId/*有些人容易把frontName和前端控制器（Front Controller)混淆起来。它们 是两个不同的概念，frontName只跟路由相关。【注：根据我们前面讲过的 Magento的MVC流程，前端控制器是用来实例化所有路由的，而这里的 frontName只是路由过程中的一个参数】什么是 ?这个标签的名字应该是模块名字的小写版本。我们的模块名字是 “Helloworld”，所以这里我们用“helloworld”。你应该也己经注意到我们 定义的“frontName”也是和我们的模块相匹配的。这是一个不成文的规定，但 不是强制