美文网首页PHP很简单
ThinkPHP5.1学习笔记 - 行为

ThinkPHP5.1学习笔记 - 行为

作者: 四月不见 | 来源:发表于2019-04-29 17:20 被阅读0次

    一、简介

    你可以把行为理解成是“在程序执行过程中的某一个位置会调起一个或一类事件”的动作。行为发生作用的位置我们称之为钩子,当应用程序运行到这个钩子的时候,就会被拦截下来,统一执行相关的行为。

    类似于AOP编程中的“切面”的概念,给某一个钩子绑定相关行为就成了一种类AOP编程的思想。

    一个完整的行为事件包括以下三项:
    1)行为定义
    2)行为绑定
    3)监听钩子

    ThinkPHP关于行为的核心方法都定义于核心文件thinkphp\library\think\Hook.php中。

    二、行为定义

    行为类一般放置于模块目录下的behavior目录里,当然这不是硬性要求,你也可以按照你的喜好自定义目录。

    行为类的定义很简单,一般来说只需要定义一个行为入口方法run即可。如,我需要给我的后台管理系统做一个用户登录行为检测:

    namespace app\admin\behavior;
    
    /**
     * Test: Use to learn ThinkPHP-Hook.
     *
     * Email: 123nosee@gmial.com
     * Author: Chan
     */
    class MyHook
    {
        public function run($params){
            echo '<b>自定义钩子的行为</b>';
        }
    
    }
    

    行为的入口方法名称支持自定义,如果需要更改在应用公共文件(common.php)中添加下面的代码即可:

    Hook::portal('portal');
    

    一个钩子可以注册多个行为,执行到某个钩子位置后,会按照注册的顺序依次执行相关的行为。但在某些特殊的情况下,你可以设置某个钩子只能执行一次行为,又或者你可以在一个钩子的某个行为中返回false来强制终止后续的行为执行;一个行为可以同时注册到多个不同的钩子上,完全看应用的需求来设计。

    可以在行为方法中使用依赖注入,例如:

    namespace app\index\behavior;
    
    use think\Request;
    
    class Test 
    {
        public function run(Request $request, $params)
        {
            // 行为逻辑
        }
    }
    

    三、行为绑定

    行为定义完成后,就需要绑定到某个标签位置(钩子)才能生效,否则是不会执行的。

    1、通过配置文件

    我们可以直接在应用目录下面或者模块的目录下面定义tags.php文件来统一定义行为,定义格式如下:

    // 应用行为扩展定义文件
    return [
        // 模块初始化
        'module_init'  => ['app\\admin\\behavior\\Login'],
        // 操作开始执行
        'action_begin' => [],
        // 视图内容过滤
        'view_filter'  => [],
        // 日志写入
        'log_write'    => [],
        // 应用结束
        'app_end'      => [],
    
        //自定义钩子  =>   绑定相应的行为
        'my_hook'      => ['app\\admin\\behavior\\MyHook'],
    ];
    

    2、使用think\facade\Hook类的add方法注册行为

    Hook::add('my_hook','app\\admin\\behavior\\MyHook');
    

    注意:
    1)Hook::add要执行在Hook::listen之前,否则不会绑定成功。
    2)Hook::add要么调用run方法要么调用当前钩子名称(驼峰法)的方法。

    如果需要使用Hook::add调用其它方法,可以定义静态方法(app\index\behavior\CheckAuth::hello)或者使用闭包。

    四、监听钩子

    钩子的位置必须是事先设计好的,无论是框架还是应用的,要设置一个钩子,只需要在相关的位置添加一行代码(事先需要引入think\facade\Hook类),语法如下:

    Hook::listen('钩子名称','参数','是否只有一次有效返回值');
    

    1、系统钩子
    系统钩子就是框架已经默认设置好的,开发者可以直接使用。

    钩子 描述 参数
    app_init 应用初始化标签位
    app_dispatch 应用调度标签位
    app_begin 应用开始标签位
    module_init 模块初始化标签位
    action_begin 控制器开始标签位 当前的callback参数
    view_filter 视图输出过滤标签位 当前模板渲染输出内容
    app_end 应用结束标签位 当前响应对象实例
    log_write 日志write方法标签位 当前写入的日志信息
    log_level 日志写入标签位 包含日志类型和日志信息的数组(V5.1.25+)
    response_send 响应发送标签位 当前响应对象
    response_end 输出结束标签位 当前响应对象实例

    2、自定义钩子

    use think\facade\Hook;
    
    Hook::listen('module_init'); //监听系统钩子 module_init
    Hook::listen('my_hook'); //监听自定位钩子 my_hook
    

    五、闭包支持

    可以不用定义行为直接把闭包函数绑定到某个标签位,例如:

    Hook::add('hook_function',function($params){
        var_dump($params);
    });
    Hook::listen('hook_function','Hi nosee!');
    

    六、直接执行行为

    如果需要,你也可以不绑定行为标签,直接调用某个行为,使用:

    // 执行 app\index\behavior\CheckAuth行为类的run方法 并引用传入params参数
    $result = Hook::exec('app\\index\\behavior\\CheckAuth',$params);
    

    直接执行行为的时候,执行的是run方法,如果需要执行行为类的其它方法,可以使用

    // 执行 app\index\behavior\CheckAuth行为类的hello方法 并引用传入params参数
    $result = Hook::exec(['app\\index\\behavior\\CheckAuth','hello'], $params);
    

    参考

    官方手册:https://www.kancloud.cn/manual/thinkphp5_1/354129

    相关文章

      网友评论

        本文标题:ThinkPHP5.1学习笔记 - 行为

        本文链接:https://www.haomeiwen.com/subject/pwzenqtx.html