PHP勾點機制原理及詳解
2020-07-16 10:06:12
什麼是勾點？
大家想必聽過外掛，wordpress外掛特別多，這個就是用勾點機制實現的。
當程式碼在執行的過程中，我們預先在執行的幾個特殊點裡執行一些特殊方法：例如在執行方法（例如Blog::add的add方法）之前記錄輸入引數、執行方法之後記錄處理結果，這個執行方法之前、執行方法之後就是簡單的勾點(掛載點)，我們在這個勾點上放置勾點函數（記錄輸入引數、記錄處理結果），執行一些和程式執行不相關的任務。
<?php
class Blog extends Controller{
public function add(){
//some code
$res = $data;
return $res;
}
}
$obj = new Blog();
Log::write($_REQUEST);
$res = $obj->add();
Log::write(json_encode($res));如果在執行方法之前放置的是一個OnBeforeRunActionCallback()的方法，這個方法可能最開始的時候是空的，但我們以後就可以不去修改原有程式碼，直接在OnBeforeRunActionCallback()裡面加程式碼邏輯就可以了，例如記錄紀錄檔、引數過濾等等。
<?php
class Blog extends Controller{
public function add(){
//some code
$res = $data;
return $res;
}
}
$obj = new Blog();
OnBeforeRunActionCallback($_REQUEST);
$obj->add();
OnAfterRunActionCallback($res);
function OnBeforeRunActionCallback($param){
Log::write($param);
FilterParams($param);
}
function OnAfterRunActionCallback($res){
Log::write(json_encode($res));
}在專案程式碼中，你認為要擴充套件（暫時不擴充套件）的地方放置一個勾點函數，等需要擴充套件的時候，把需要實現的類和函數掛載到這個勾點上，就可以實現擴充套件了。
原理
實際的勾點一般設計為一個類Hook，該類提供註冊外掛到勾點(add_hook)、觸發勾點方法(trigger_hook)。註冊外掛的時候將外掛所要執行的可執行方法儲存到勾點對應的陣列裡面。
$_listeners = array(
'OnBeforeRunAction' => array(
'callback1',
'callback2',
'callback3',
),
);
//提前註冊外掛到勾點
add_hook('OnBeforeRunAction', 'callback4');
//特定地方執行勾點
trigger_hook('OnBeforeRunAction');當觸發勾點的時候，將遍歷OnBeforeRunAction裡註冊的回撥方法，執行對應的回撥方法，實現動態擴充套件功能。註冊的勾點方法一般是匿名函數:
function trigger_hook($hook, $data=''){
//檢視要實現的勾點，是否在監聽陣列之中
if (isset($this->_listeners[$hook]) && is_array($this->_listeners[$hook]) && count($this->_listeners[$hook]) > 0)
{
// 迴圈呼叫開始
foreach ($this->_listeners[$hook] as $listener)
{
if(is_callable()){
call_user_func($listener, $data);
}elseif(is_array($listener)){
// 取出外掛物件的參照和方法
$class =& $listener[0];
$method = $listener[1];
if(method_exists($class,$method))
{
// 動態呼叫外掛的方法
$class->$method($data);
}
}
}
}
}如何實現？
簡單的
1、外掛類Hook:提供註冊外掛和執行外掛的方法，實際是往一個陣列裡存掛載點對應的可執行方法。
2、在某個組態檔或者函數裡統一註冊外掛。
class Hook
{
//action hooks array
private static $actions = array();
/**
* ads a function to an action hook
* @param $hook
* @param $function
*/
public static function add_action($hook,$function)
{
$hook=mb_strtolower($hook,CHARSET);
// create an array of function handlers if it doesn't already exist
if(!self::exists_action($hook))
{
self::$actions[$hook] = array();
}
// append the current function to the list of function handlers
if (is_callable($function))
{
self::$actions[$hook][] = $function;
return TRUE;
}
return FALSE ;
}
/**
* executes the functions for the given hook
* @param string $hook
* @param array $params
* @return boolean true if a hook was setted
*/
public static function do_action($hook,$params=NULL)
{
$hook=mb_strtolower($hook,CHARSET);
if(isset(self::$actions[$hook]))
{
// call each function handler associated with this hook
foreach(self::$actions[$hook] as $function)
{
if (is_array($params))
{
call_user_func_array($function,$params);
}
else
{
call_user_func($function);
}
//cant return anything since we are in a loop! dude!
}
return TRUE;
}
return FALSE;
}
/**
* gets the functions for the given hook
* @param string $hook
* @return mixed
*/
public static function get_action($hook)
{
$hook=mb_strtolower($hook,CHARSET);
return (isset(self::$actions[$hook]))? self::$actions[$hook]:FALSE;
}
/**
* check exists the functions for the given hook
* @param string $hook
* @return boolean
*/
public static function exists_action($hook)
{
$hook=mb_strtolower($hook,CHARSET);
return (isset(self::$actions[$hook]))? TRUE:FALSE;
}
}
/**
* Hooks Shortcuts not in class
*/
function add_action($hook,$function)
{
return Hook::add_action($hook,$function);
}
function do_action($hook)
{
return Hook::do_action($hook);
}用法舉例：
//新增勾點
Hook::add_action('unique_name_hook','some_class::hook_test');
//或使用快捷函數新增勾點:
add_action('unique_name_hook','other_class::hello');
add_action('unique_name_hook','some_public_function');
//執行勾點
do_action('unique_name_hook');//也可以使用 Hook::do_action();帶安裝/解除安裝的
勾點類初始化的時候去註冊已經開啟的外掛（如資料庫記錄）；全域性合適的時候設定掛載點；執行到合適的時候觸發掛載點註冊的事件。
1、外掛類Hook:提供註冊外掛和執行外掛的方法，實際是往一個陣列裡存掛載點對應的可執行方法。
2、外掛類增加一個初始化的方法，去資料查詢已經安裝的外掛，執行外掛必須執行的註冊方法(reg)，註冊外掛方法註冊勾點到掛載點。
3、固定把外掛放在某個目錄，並安照一定規範寫組態檔。後台有外掛列表頁面，遍歷指定目錄下的外掛。當安裝的時候，將外掛資訊記錄到資料庫，解除安裝的時候刪除資料庫記錄資訊。
<?php
/**
* @file plugin.php
* @brief 外掛核心類
* @note 觀察者模式，註冊事件，觸發事件
*/
class plugin extends IInterceptorBase
{
//預設開啟的外掛列表
private static $defaultList = array("_verification","_goodsCategoryWidget","_authorization","_userInfo","_initData");
//已經註冊監聽
private static $_listen = array();
//載入外掛
public static function init()
{
$pluginDB = new IModel('plugin');
$pluginList = $pluginDB->query("is_open = 1","class_name","sort asc");
//載入預設外掛
foreach(self::$defaultList as $val)
{
$pluginList[]= array('class_name' => $val);
}
foreach($pluginList as $key => $val)
{
$className = $val['class_name'];
$classFile = self::path().$className."/".$className.".php";
if(is_file($classFile))
{
include_once($classFile);
$pluginObj = new $className();
$pluginObj->reg();
}
}
}
/**
* @brief 註冊事件
* @param string $event 事件
* @param object ro function $classObj 類範例 或者 匿名函數
* @param string $method 方法名字
*/
public static function reg($event,$classObj,$method = "")
{
if(!isset(self::$_listen[$event]))
{
self::$_listen[$event] = array();
}
self::$_listen[$event][] = array($classObj,$method);
}
/**
* @brief 顯示已註冊事件
* @param string $event 事件名稱
* @return array
*/
public static function get($event = '')
{
if($event)
{
if( isset(self::$_listen[$event]) )
{
return self::$_listen[$event];
}
return null;
}
return self::$_listen;
}
/**
* @brief 觸發事件
* @param string $event 事件
* @param mixed $data 資料
* @notice 可以呼叫匿名函數和方法
*/
public static function trigger($event,$data = null)
{
$result = array();
if(isset(self::$_listen[$event]))
{
foreach(self::$_listen[$event] as $key => $val)
{
list($pluginObj,$pluginMethod) = $val;
$result[$key] = is_callable($pluginObj) ? call_user_func($pluginObj,$data):call_user_func(array($pluginObj,$pluginMethod),$data);
}
}
return isset($result[1]) ? $result : current($result);
}
/**
* @brief 外掛物理路徑
* @return string 路徑字串
*/
public static function path()
{
return IWeb::$app->getBasePath()."plugins/";
}
/**
* @brief 外掛WEB路徑
* @return string 路徑字串
*/
public static function webPath()
{
return IUrl::creatUrl('')."plugins/";
}
/**
* @brief 獲取全部外掛
* @param string $name 外掛名字，如果為空則獲取全部外掛資訊
* @return array 外掛資訊 array(
"name" => 外掛名字,
"description" => 外掛描述,
"explain" => 使用說明,
"class_name" => 外掛ID,
"is_open" => 是否開啟,
"is_install" => 是否安裝,
"config_name" => 預設外掛引數結構,
"config_param"=> 已經儲存的外掛引數,
"sort" => 排序,
)
*/
public static function getItems($name = '')
{
$result = array();
$dirRes = opendir(self::path());
//遍歷目錄讀取組態檔
$pluginDB = new IModel('plugin');
while($dir = readdir($dirRes))
{
if($dir[0] == "." || $dir[0] == "_")
{
continue;
}
if($name && $result)
{
break;
}
if($name && $dir != $name)
{
continue;
}
$pluginIndex = self::path().$dir."/".$dir.".php";
if(is_file($pluginIndex))
{
include_once($pluginIndex);
if(get_parent_class($dir) == "pluginBase")
{
$class_name = $dir;
$pluginRow = $pluginDB->getObj('class_name = "'.$class_name.'"');
$is_open = $pluginRow ? $pluginRow['is_open'] : 0;
$is_install = $pluginRow ? 1 : 0;
$sort = $pluginRow ? $pluginRow['sort'] : 99;
$config_param = array();
if($pluginRow && $pluginRow['config_param'])
{
$config_param = JSON::decode($pluginRow['config_param']);
}
$result[$dir] = array(
"name" => $class_name::name(),
"description" => $class_name::description(),
"explain" => $class_name::explain(),
"class_name" => $class_name,
"is_open" => $is_open,
"is_install" => $is_install,
"config_name" => $class_name::configName(),
"config_param"=> $config_param,
"sort" => $sort,
);
}
}
}
if(!$name)
{
return $result;
}
return isset($result[$name]) ? $result[$name] : array();
}
/**
* @brief 系統內建的所有事件觸發
*/
public static function onCreateApp(){plugin::init();plugin::trigger("onCreateApp");}
public static function onFinishApp(){plugin::trigger("onFinishApp");}
public static function onBeforeCreateController($ctrlId){plugin::trigger("onBeforeCreateController",$ctrlId);plugin::trigger("[email protected]".$ctrlId);}
public static function onCreateController($ctrlObj){plugin::trigger("onCreateController");plugin::trigger("[email protected]".$ctrlObj->getId());}
public static function onFinishController($ctrlObj){plugin::trigger("onFinishController");plugin::trigger("[email protected]".$ctrlObj->getId());}
public static function onBeforeCreateAction($ctrlObj,$actionId){plugin::trigger("onBeforeCreateAction",$actionId);plugin::trigger("[email protected]".$ctrlObj->getId());plugin::trigger("[email protected]".$ctrlObj->getId()."@".$actionId);}
public static function onCreateAction($ctrlObj,$actionObj){plugin::trigger("onCreateAction");plugin::trigger("[email protected]".$ctrlObj->getId());plugin::trigger("[email protected]".$ctrlObj->getId()."@".$actionObj->getId());}
public static function onFinishAction($ctrlObj,$actionObj){plugin::trigger("onFinishAction");plugin::trigger("[email protected]".$ctrlObj->getId());plugin::trigger("[email protected]".$ctrlObj->getId()."@".$actionObj->getId());}
public static function onCreateView($ctrlObj,$actionObj){plugin::trigger("onCreateView");plugin::trigger("[email protected]".$ctrlObj->getId());plugin::trigger("[email protected]".$ctrlObj->getId()."@".$actionObj->getId());}
public static function onFinishView($ctrlObj,$actionObj){plugin::trigger("onFinishView");plugin::trigger("[email protected]".$ctrlObj->getId());plugin::trigger("[email protected]".$ctrlObj->getId()."@".$actionObj->getId());}
public static function onPhpShutDown(){plugin::trigger("onPhpShutDown");}
}
/**
* @brief 外掛基礎類別，所有外掛必須繼承此類
* @notice 必須實現3個抽象方法： reg(),name(),description()
*/
abstract class pluginBase extends IInterceptorBase
{
//錯誤資訊
protected $error = array();
//註冊事件介面，內部通過呼叫payment::reg(事件,物件範例,方法);
public function reg(){}
/**
* @brief 預設外掛引數資訊，寫入到plugin表config_param欄位
* @return array("欄位名" => array(
"name" => "文字顯示",
"type" => "資料型別【text,radio,checkbox,select】",
"pattern" => "資料校驗【int,float,date,datetime,require,正規表示式】",
"value" => "1,陣列：列舉資料【radio,checkbox,select】的預設值,array(名字=>資料); 2,字串：【text】預設資料",
))
*/
public static function configName()
{
return array();
}
/**
* @brief 外掛安裝
* @return boolean
*/
public static function install()
{
return true;
}
/**
* @brief 外掛解除安裝
* @return boolean
*/
public static function uninstall()
{
return true;
}
/**
* @brief 外掛名字
* @return string
*/
public static function name()
{
return "外掛名稱";
}
/**
* @brief 外掛功能描述
* @return string
*/
public static function description()
{
return "外掛描述";
}
/**
* @brief 外掛使用說明
* @return string
*/
public static function explain()
{
return "";
}
/**
* @brief 獲取DB中錄入的設定引數
* @return array
*/
public function config()
{
$className= get_class($this);
$pluginDB = new IModel('plugin');
$dataRow = $pluginDB->getObj('class_name = "'.$className.'"');
if($dataRow && $dataRow['config_param'])
{
return JSON::decode($dataRow['config_param']);
}
return array();
}
/**
* @brief 返回錯誤資訊
* @return array
*/
public function getError()
{
return $this->error ? join("rn",$this->error) : "";
}
/**
* @brief 寫入錯誤資訊
* @return array
*/
public function setError($error)
{
$this->error[] = $error;
}
/**
* @brief 外掛檢視渲染有布局
* @param string $view 檢視名字
* @param array $data 檢視裡面的資料
*/
public function redirect($view,$data = array())
{
if($data === true)
{
$this->controller()->redirect($view);
}
else
{
$__className = get_class($this);
$__pluginViewPath = plugin::path().$__className."/".$view;
$result = self::controller()->render($__pluginViewPath,$data);
if($result === false)
{
IError::show($__className."/".$view."外掛檢視不存在");
}
}
}
/**
* @brief 外掛檢視渲染去掉布局
* @param string $view 檢視名字
* @param array $data 檢視裡面的資料
*/
public function view($view,$data = array())
{
self::controller()->layout = "";
$this->redirect($view,$data);
}
/**
* @brief 外掛物理目錄
* @param string 外掛路徑地址
*/
public function path()
{
return plugin::path().get_class($this)."/";
}
/**
* @brief 外掛WEB目錄
* @param string 外掛路徑地址
*/
public function webPath()
{
return plugin::webPath().get_class($this)."/";
}
}以上就是PHP勾點機制原理及詳解的詳細內容，更多請關注TW511.COM其它相關文章！