thinkphp 行为扩展以及插件机制介绍

首先行为扩展这个概念是TP架构的核心组成之一,关于行为的解释我就粗略的概括一下吧:
TP在从接受到HTTP请求到最终将视图输出,期间经历的很多步骤,这些步骤大家可以在http://document.thinkphp.cn/manual_3_2.html#system_process 这里面看到,这里就不再详细叙述了,那么行为扩展实际上就是在这些流程里埋下了一个钩子,你可以往钩子里添加你自己的业务逻辑,当程序执行到某个钩子位置时将自动触发你的业务逻辑,关于系统预置的一些钩子可以参考:
http://document.thinkphp.cn/manual_3_2.html#behavior_extend

本文的主要目的是教大家如何使用行为扩展和插件,这里为什么要提到"插件"这个词呢?因为在3.2里,有了一个插件的概念,和行为共用一个Hook类,所以放在一起说,原理上并无太大区别。

一、行为扩展篇
1.TP内置行为钩子
我们知道TP中预留了一些行为钩子,比如 action_begin,这个钩子是在动作开始执行时触发,预置的钩子大家通过配置文件注册行为类,大家在Application/Common/Conf目录下创建一个tags.php,这个和3.1是一样的,返回一个数组,数组格式是 "钩子名"=>array("行为类1","行为类2"......)
这里我给一个例子:
Application/Common/Conf/tag.php:
<?php
return array(
"action_begin" => array("Behaviors\\test")
);
?>
可以看到,我往action_begin这个钩子里面注册了一个行为,这个行为就是Behaviors\\test 这里的写法是命名空间写法,其对应的类文件路径是:
Application/Behaviors/testBehavior.class.php
注意实际类文件名需要加上Behavior后缀,以及用.class.php作为文件扩展名。
Application/Behaviors/testBehavior.class.php:
<?php
namespace Behaviors;
class testBehavior{
function run($arg){
echo "这是一个行为扩展".$arg;
}
}
?>
千万要注意第一行的命名空间,对于命名空间不理解的请自行查阅php手册。另外对于TP的自动加载机制,参考手册:
http://document.thinkphp.cn/manual_3_2.html#autoload
行为的执行入口是 run()方法,触发钩子时会自动执行行为类里的run()方法。

2.动态添加钩子和注册行为
通过上面的例子大家才是了解了行为大概是个什么东西,但是对于其执行流程可能还不清楚,这里我来介绍下动态添加钩子和注册行为,使大家对行为执行机制有一个比较清晰的理解。
首先,行为钩子添加和注册行为类,以及触发行为,都是通过Hook类来实现的,Hook类在TP核心包里的ThinkPHP目录下,Hook.class.php.
>>添加钩子以及注册行为:\Think\Hook::add(‘钩子名‘,‘行为‘)
>>埋设/监听/触发钩子:\Think\Hook::listen(‘钩子名‘,‘传递给run的参数,必须是个变量‘);
假设我们需要在访问index.php/Public/login.html的时候触发login钩子里的行为,那么首先我们需要在login方法中监听钩子,也就是把钩子埋在login方法里,当访问login方法时就会自动触发,有点像猎人的陷阱不是吗?
function login(){
\Think\Hook::listen(‘login‘);//监听一个名为login的钩子
...其他代码略...
}
好了,我们在login方法里监听了login钩子,那么接下来我们往这个钩子里添加一些行为,这样访问login的时候会自动触发这些行为,执行行为类的run方法。
行为在哪里注册呢?
当然得在触发之前注册,1.你可以通过tags.php注册,上面提到过了,只不过把action_begin换成login。2.动态添加,假如你这个钩子只在Public控制器中使用,那么你可以在PublicController的_initialize()初始化方法中动态添加钩子。
function _initialize(){
\Think\Hook::add(‘login‘,‘Behaviors\\test‘);
}
这里就往login这个钩子里添加了一个test行为,比较懒直接从上面复制过来了,大家理解这个意思就可以。
添加多个行为的话可以这样
\Think\Hook::add(‘login‘,array(‘Behaviors\\test‘,‘Behaviors\\test1‘...));
就是第二个参数变成一个数组,数组里每个元素对应一个行为类,注意,当钩子被触发时,这里面的所有行为都会依次执行。

3.带参数的行为
上面我们知道了行为是通过run()方法执行的,那么我们想传递一些参数进去怎么办呢?
答案是 \Think\Hook::listen(); 的第二个参数。
注意listen方法定义如下:
static public function listen($tag, &$params=NULL)
可以看到第二个参数是一个引用传递的参数,也就是说,第二个参数必须是一个变量,不能是值,下面的使用方法是错误的:
\Think\Hook::listen(‘login‘,"hello"); // x
这样才是正确的
$hello = "hello";
\Think\Hook::listen(‘login‘,$hello);//√
关于引用传递的知识这里不作介绍,请自行翻阅PHP手册。

这样我们在行为类里面run方法可以指定一个参数来接收$hello
function run($arg){
echo $arg;//输出 hello
}
当然你也可以
function run(&$arg){
echo $arg;//输出hello
$arg = "bye";
}
这样参数设定为引用类型,你可以在run里面改变原始变量的值。

二、插件
看了上面的行为,我们可以总结出一个模式:
定义不同的行为,执行同一个方法run
而插件呢?
它是可以定义run的,并且相当于在一个行为类里面可以有多个入口,这些入口在不同的条件下触发。
假设我们在tags.php里面添加了这样一个钩子
‘showflash‘ => array(‘test‘),
注意与行为的区别,注册行为需要包含命名空间也就是反斜杠 \\,当没有反斜杠,只有一个单词的时候将认为是一个插件。
插件定义在 Application/Addons/插件名/插件名Addon.class.php
比如上面的test插件就是 Application/Addons/test/testAddon.class.php
插件类的定义:
<?php
namespace Addons\test;
class testAddon{
function showflash(){
echo "这是插件执行入口";
}
}
?>
可以看到一个明显的区别,就是run入口变成了 showflash,和钩子名相同。
有人疑问这样有什么用吗?请继续往下看:

上面我们只定义了一个插件钩子 showflash,假如我们再来一个钩子:

‘clearflash‘=>array(‘test‘);

看到没?这个钩子里面同样注册了一个test插件,而这个test还是上面那个testAddon类,不同的是,你需要为这个clearflash定义一个入口方法,于是testAddon类变成了:
<?php
namespace Addons\test;
class testAddon{
function showflash(){
echo "这是插件执行入口";
}

function clearflash(){
echo "这是另外一个插件钩子入口";
}
}
?>
这样当你不同的钩子注册了同一个插件类时,你需要在插件类里面为这些钩子分别定义入口方法。
而行为类则不是,行为类不管你是不是同一个钩子,它只认准run方法。
这就是行为和插件的区别。

注:

1、需新增TP配置项

‘AUTOLOAD_NAMESPACE‘       =>  array(‘Addons‘ => ‘./Addons/‘), //扩展模块列表
时间: 2024-10-12 23:22:02

thinkphp 行为扩展以及插件机制介绍的相关文章

行为扩展以及插件机制

在thinkPHP中的行为扩展和插件机制. 首先行为扩展这个概念是TP框架的核心组成之一,关于行为的解释我就粗略的概括一下吧: TP在从接受到HTTP请求到最终将试图输出,期间经历的很多步骤,这些步骤大家可以在http://document.thinkphp.cn/manual_3_2.html#system_process这里面看到. 那么行为扩展实际上就是在这些流程里面买下了一个钩子,你可以往钩子里添加你自己的业务逻辑 当程序执行到某些钩子位置时将自动触发你的业务逻辑,http://docu

基于接口的插件机制

一.前言 插件,意味着可扩展,且宿主程序不依赖于插件,即插即用.这种软件设计方式可以使我们的应用程序最大化地获得可扩展性.适应性和稳定性,而且便于软件的维护和升级.在什么场景下使用插件呢?例如在本篇文章中,我个人有一个小需求就是希望记事本带行号,于是我自己写了一个极简易的编辑器(CodeEditor),以这个编辑器为例,主体程序功能包括常见的新建.复制.查找.保存等已经完成,但是在使用的过程中发现需要用到 格式化 这个功能,但是我还不想再去改主程序,这种情形下就可以通过插件来实现,这样以后在使用

php中的钩子(hook插件机制)

对"钩子"这个概念其实不熟悉,最近看到一个php框架中用到这种机制来扩展项目,所以大概来了解下. hook插件机制的基本思想: 在项目代码中,你认为要扩展(暂时不扩展)的地方放置一个钩子函数,等需要扩展的时候,把需要实现的类和函数挂载到这个钩子上,就可以实现扩展了. 思想就是这样听起来比较笼统,看一个网上的实现的例子. 整个插件机制包含三个部分: 1.hook插件经理类:这个是核心文件,是一个应用程序全局Global对象.它主要有三个职责 1>监听已经注册了的所有插件,并实例化这

ImitateLogin新增插件机制以及又一个社交网站的支持

我的文章里已经多次介绍 imitate-login ,这是我最近一直在维护的一个使用c#模拟社交网站登录的开源项目,现在新增了对插件的支持以及一个新的网站(由于某种原因,会在文章结束部分介绍:而且仅会出现在博客中).希望喜欢的读者可以通过 Star & fork 来支持我,我也会据此来决定时间的分配. imitate-login 现在已经提供了对插件的支持:目前有两个部分使用到了插件机制,登录自身实现以及登录过程中的验证码识别过程:其中登录过程仅支持 MEF(Managed Extensibil

Atitit&#160;插件机制原理与设计微内核&#160;c#&#160;java&#160;的实现attilax总结

Atitit 插件机制原理与设计微内核 c# java 的实现attilax总结 1. 微内核与插件的优点1 2. 插件的注册与使用2 2.1. Ioc容器中注册插件2 2.2. 启动器微内核启动3 3. 插件的俩种执行策略3 3.1. 必须手动接续,否则自动终止(推荐)3 3.2. 必须手动throw  stop ex终止,负责自动接续..4 4. 插件链的生成原理4 5. -------code4 6. 参考7 1. 微内核与插件的优点 但凡有生命力的产品,都是在扩展性方面设计的比较好的,因

php中的插件机制原理和实例

PHP中的插件机制原理和实例 投稿:junjie 字体:[增加 减小] 类型:转载 这篇文章主要介绍了PHP中的插件机制原理和实例,文中例子主要借鉴了网上一些网友的方式做了稍微的改造,需要的朋友可以参考下 PHP项目中很多用到插件的地方,更尤其是基础程序写成之后很多功能由第三方完善开发的时候,更能用到插件机制,现在说一下插件的实现.特点是无论你是否激活,都不影响主程序的运行,即使是删除也不会影响. 从一个插件安装到运行过程的角度来说,主要是三个步骤: 1.插件安装(把插件信息收集进行采集和记忆的

深入解读PHP插件机制原理

深入解读PHP插件机制原理 PHP插件机制是指一类特定的功能模块,主要特点有:可以随时激活删除使用,灵活性较强.大家可以在文章中获得这一机制的相关知识. AD:51CTO移动APP安全沙龙!马上要爆满,手慢没座位! 我们在这篇文章中主要向大家讲了一些PHP插件机制的实现方法.希望大家可以通过本问介绍的内容初步了解对PHP插件机制的认识. PHP函数restore()重置PHP配置环境 PHP数据缓存类必要性分析 PHP创建PPT文档范例解析 总结各种不同PHP控制语句 PHP INCLUDE语句

微信开发学习日记(八):7步看懂weiphp插件机制,核心目标是响应微信请求

又经过了几个小时的梳理.回顾,截至目前,终于对weiphp这个框架的机制搞明白了些.想要完全明白,自然还需要大把的时间.第1步:   配置微信公众号,http://weiphp.jiutianniao.com/ ... .html  从上面这个配置可以看出,微信请求呗weiphp的入口文件index.php接收了,可能会被/home/weixin/index/这个action响应.第2步:   index.php入口文件,校验了是否是微信请求.   /** * 微信接入验证 * 在入口进行验证而

从npm tips到express插件机制设计

大部分时间,我们只用到npm的install,init,publish等功能,但它设计的非常好,有很多是我们不了解的 一起看一下 全局命令 用nodejs来写cli工具是非常爽的,我干了不少这样的事儿 kp =kill by port je = json editor mh = start mongo here 核心就是在package.json里配置 "preferGlobal": "true", "bin": { "mh"