行為
概述
版本 | 新增功能 |
---|---|
5.0.4 | 行為類的方法采用駝峰法命名 |
行為綁定支持綁定到類的方法 |
行為(Behavior)是ThinkPHP擴(kuò)展機(jī)制中比較關(guān)鍵的一項(xiàng)擴(kuò)展,行為既可以獨(dú)立調(diào)用,也可以綁定到某個(gè)標(biāo)簽中進(jìn)行偵聽,在官方提出的CBD模式中行為也占了主要的地位,可見行為在ThinkPHP框架中意義非凡。
這里指的行為是一個(gè)比較抽象的概念,你可以把行為想象成在應(yīng)用執(zhí)行過程中的一個(gè)動(dòng)作或者處理。在框架的執(zhí)行流程中,例如路由檢測(cè)是一個(gè)行為,靜態(tài)緩存是一個(gè)行為,用戶權(quán)限檢測(cè)也是行為,大到業(yè)務(wù)邏輯,小到瀏覽器檢測(cè)、多語言檢測(cè)等等都可以當(dāng)做是一個(gè)行為,甚至說你希望給你的網(wǎng)站用戶的第一次訪問彈出Hello,world!這些都可以看成是一種行為,行為的存在讓你無需改動(dòng)框架和應(yīng)用,而在外圍通過擴(kuò)展或者配置來改變或者增加一些功能。
而不同的行為之間也具有位置共同性,比如,有些行為的作用位置都是在應(yīng)用執(zhí)行前,有些行為都是在模板輸出之后,我們把這些行為發(fā)生作用的位置稱之為標(biāo)簽(位),當(dāng)應(yīng)用程序運(yùn)行到這個(gè)標(biāo)簽的時(shí)候,就會(huì)被攔截下來,統(tǒng)一執(zhí)行相關(guān)的行為,類似于AOP編程中的“切面”的概念,給某一個(gè)切面綁定相關(guān)行為就成了一種類AOP編程的思想。
行為標(biāo)簽位
在定義行為之前,我們先來了解下系統(tǒng)有哪些標(biāo)簽位,系統(tǒng)核心提供的標(biāo)簽位置包括下面幾個(gè)(按照?qǐng)?zhí)行順序排列):
標(biāo)簽位 | 描述 |
---|---|
app_init | 應(yīng)用初始化標(biāo)簽位 |
app_begin | 應(yīng)用開始標(biāo)簽位 |
module_init | 模塊初始化標(biāo)簽位 |
action_begin | 控制器開始標(biāo)簽位 |
view_filter | 視圖輸出過濾標(biāo)簽位 |
app_end | 應(yīng)用結(jié)束標(biāo)簽位 |
log_write | 日志write方法標(biāo)簽位 |
log_write_done |
日志寫入完成標(biāo)簽位(V5.0.10+ ) |
response_send |
響應(yīng)發(fā)送標(biāo)簽位(V5.0.10+ ) |
response_end |
輸出結(jié)束標(biāo)簽位(V5.0.1+ ) |
在每個(gè)標(biāo)簽位置,可以配置多個(gè)行為定義,行為的執(zhí)行順序按照定義的順序依次執(zhí)行。除非前面的行為里面中斷執(zhí)行了(某些行為可能需要中斷執(zhí)行,例如檢測(cè)機(jī)器人或者非法執(zhí)行行為),否則會(huì)繼續(xù)下一個(gè)行為的執(zhí)行。
除了這些系統(tǒng)內(nèi)置標(biāo)簽之外,開發(fā)人員還可以在應(yīng)用中添加自己的應(yīng)用標(biāo)簽。
添加行為標(biāo)簽位
可以使用\think\Hook
類的listen
方法添加自己的行為偵聽位置,例如:
Hook::listen('action_init');
可以給偵聽方法傳入?yún)?shù)(僅能傳入一個(gè)參數(shù)),該參數(shù)使用引用傳值,因此必須使用變量,例如:
Hook::listen('action_init',$params);
偵聽的標(biāo)簽位置可以隨意放置。
行為定義
行為類的定義很簡單,定義行為的執(zhí)行入口方法run
即可,例如:
namespace app\index\behavior;
class Test
{
public function run(&$params)
{
// 行為邏輯
}
}
行為類并不需要繼承任何類,相對(duì)比較靈活。
如果行為類需要綁定到多個(gè)標(biāo)簽,可以采用如下定義:
namespace app\index\behavior;
class Test
{
public function app_init(&$params)
{
}
public function app_end(&$params)
{
}
}
綁定到app_init
和app_end
后 就會(huì)調(diào)用相關(guān)的方法。
V5.0.4+
版本以上,行為類的方法需要采用駝峰法命名,上面的行為類需要改成:
namespace app\index\behavior;
class Test
{
public function appInit(&$params)
{
}
public function appEnd(&$params)
{
}
}
行為綁定
行為定義完成后,就需要綁定到某個(gè)標(biāo)簽位置才能生效,否則是不會(huì)執(zhí)行的。
使用Hook類的add方法注冊(cè)行為,例如:
// 注冊(cè) app\index\behavior\CheckLang行為類到app_init標(biāo)簽位
Hook::add('app_init','app\\index\\behavior\\CheckLang');
//注冊(cè) app\admin\behavior\CronRun行為類到app_init標(biāo)簽位
Hook::add('app_init','app\\admin\\behavior\\CronRun');
如果要批量注冊(cè)行為的話,可以使用:
Hook::add('app_init',['app\\index\\behavior\\CheckAuth','app\\index\\behavior\\CheckLang','app\\admin\\behavior\\CronRun']);
當(dāng)應(yīng)用運(yùn)行到app_init
標(biāo)簽位的時(shí)候,就會(huì)依次調(diào)用app\index\behavior\CheckAuth
、app\index\behavior\CheckLang
和app\admin\behavior\CronRun
行為。如果其中一個(gè)行為中有中止代碼的話則后續(xù)不會(huì)執(zhí)行,如果返回false
則當(dāng)前標(biāo)簽位的后續(xù)行為將不會(huì)執(zhí)行,但應(yīng)用將繼續(xù)運(yùn)行。
我們也可以直接在APP_PATH
目錄下面或者模塊的目錄下面定義tags.php
文件來統(tǒng)一定義行為,定義格式如下:
return [
'app_init'=> [
'app\\index\\behavior\\CheckAuth',
'app\\index\\behavior\\CheckLang'
],
'app_end'=> [
'app\\admin\\behavior\\CronRun'
]
]
如果APP_PATH
目錄下面和模塊目錄下面的tags.php
都定義了app_init的行為綁定的話,會(huì)采用合并模式,如果希望覆蓋,那么可以在模塊目錄下面的tags.php
中定義如下:
return [
'app_init'=> [
'app\\index\\behavior\\CheckAuth',
'_overlay'=>true
],
'app_end'=> [
'app\\admin\\behavior\\CronRun'
]
]
如果某個(gè)行為標(biāo)簽定義了'_overlay' =>true
就表示覆蓋之前的相同標(biāo)簽下面的行為定義。
閉包支持
可以不用定義行為直接把閉包函數(shù)綁定到某個(gè)標(biāo)簽位,例如:
Hook::add('app_init',function(){
echo 'Hello,world!';
});
如果標(biāo)簽位有傳入?yún)?shù)的話,閉包也可以支持傳入?yún)?shù),例如:
Hook::listen('action_init',$params);
Hook::add('action_init',function($params){
var_dump($params);
});
直接執(zhí)行行為
如果需要,你也可以不綁定行為標(biāo)簽,直接調(diào)用某個(gè)行為,使用:
// 執(zhí)行 app\index\behavior\CheckAuth行為類的run方法 并引用傳入params參數(shù)
$result = Hook::exec('app\\index\\behavior\\CheckAuth','run',$params);