Thinkphp5.1 behavior 钩子的使用

根据下面的讲解一步一步理解钩子的使用方式，这里只做静态调用展示，动态调用请参考 Thinkphp5.1钩子和行为

相关文件及路径

• application\tags.php //静态钩子的配置文件
• application\模块\controller\Test.php //搞一个控制器类
• application\模块\behavior\Order.php //搞一个钩子类（这里名字与配置文件相同即可，自己定义）

配置静态钩子

这里我定义了三个钩子做测试

<?php
/** @Author: Alfred* @Date: 2021-11-04 15:53:09* @LastAuthor: Alfred* @LastTime: 2021-11-18 10:40:52* @Description:*/
// +----------------------------------------------------------------------
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006~2018 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: liu21st <liu21st@gmail.com>
// +----------------------------------------------------------------------// 应用行为扩展定义文件
return [// 应用初始化'app_init' => [],// 应用开始'app_begin' => [],// 模块初始化'module_init' => [],// 操作开始执行'action_begin' => [],// 视图内容过滤'view_filter' => [],// 日志写入'log_write' => [],// 应用结束'app_end' => [],//自定义的钩子关系 钩子名称=>钩子关联的钩子文件 application\模块\behavior\Order.php'order_status' => ['app\\web\\behavior\\Order'],'order_log' => ['app\\web\\behavior\\Order'],'test_end'=>['app\\web\\behavior\\Test'],];

【测试1】 默认钩子会访问行为控制器中的run方法

1. application\web\controller\Test.php

<?php
/** @Author: Alfred* @Date: 2021-11-11 13:51:15* @LastAuthor: Alfred* @LastTime: 2021-11-18 10:59:41* @Description:*/namespace app\web\controller;use think\facade\Hook;class Test {
    public function test1() {
    echo 'test1' . PHP_EOL;//行为触发Hook::listen('order_status');}

2. application\tags.php

'order_status' => ['app\\web\\behavior\\Order'],

3. application\web\behavior\Order.php 只有一个run方法

<?php
/** @Author: Alfred* @Date: 2021-11-18 10:28:32* @LastAuthor: Alfred* @LastTime: 2021-11-18 10:45:44* @Description:*/namespace app\web\behavior;class Order {
    //行为逻辑 如果没有orderStatus() 方法，自动执行 run()public function run($param = []) {
    echo "Order run 入口：" . $param['name'] . PHP_EOL;}

结果：

test1
Order run 入口：

总结：控制器调用配置好的钩子，行为默认执行run方法

【测试2】 行为传参

1. application\web\controller\Test.php

    public function test2() {
    $param = ['name' => '测试'];echo 'test2' . PHP_EOL;//Hook::listen('order_status', $param);}

2. application\web\behavior\Order.php 只有一个run方法

	//行为逻辑 如果没有orderStatus() 方法，自动执行 run()public function run($param = []) {
    echo "Order run 入口：" . $param['name'] . PHP_EOL;}

结果：

test2
Order run 入口：测试

【测试3】 钩子行为的执行循序及return Exception

1. application\web\controller\Test.php

    public function test3() {
    $param = ['name' => '测试'];echo 'test3' . PHP_EOL;Hook::listen('order_status', $param);echo 'test3 end' . PHP_EOL;}

结果：

test3
Order run 入口：测试
test3 end

总结：执行顺序是线性的，所以实际完成业务逻辑的时候要注意放置的位置
钩子中的 return 是没有效果的
try catch 捕获异常也是不好用的，程序会输出错误阻断后续的逻辑运行，但是不会抛出异常
下面的是钩子行为中出现异常

test3
{
    "code":0,"msg":"syntax error, unexpected '}'","data":[]}

【测试4】 方法中调用两个钩子行为

1. application\web\controller\Test.php

    public function test4() {
    $param = ['name' => '测试'];echo 'test4' . PHP_EOL;Hook::listen('order_status', $param);echo 'test4 end' . PHP_EOL;Hook::listen('order_log', $param);}

结果：

test4
Order run 入口：测试
test4 end
Order run 入口：测试

总结：默认调用run()方法 因为行为控制器中未定义orderStatus() orderLog()，所以run()方法被调用了两次

【测试5】 方法中调用不同行为中的钩子

1. application\web\controller\Test.php

    $param = ['name' => '测试'];echo 'test5' . PHP_EOL;Hook::listen('order_status', $param);echo 'test5 end' . PHP_EOL;Hook::listen('order_log', $param);Hook::listen('test_end', $param);

2. application\web\behavior\Test.php 只有一个run方法

    public function run($param = []) {
    echo "test run 入口：" . $param['name'] . PHP_EOL;}

结果：

test5
Order run 入口：测试
test5 end
Order run 入口：测试
test run 入口：测试

【测试6】 在钩子中定义orderStatus() orderLog() 方法后不再调用run() 方法

1. application\web\controller\Test.php

    $param = ['name' => '测试'];echo 'test5' . PHP_EOL;Hook::listen('order_status', $param);echo 'test5 end' . PHP_EOL;Hook::listen('order_log', $param);Hook::listen('test_end', $param);

2. application\web\behavior\Order.php

    public function run($param = []) {
    echo "Order run 入口：" . $param['name'] . PHP_EOL;}public function orderStatus($param = []) {
    echo "orderStatus 入口：" . $param['name'] . PHP_EOL;}public function orderLog($param = []) {
    echo "orderLog 入口：" . $param['name'] . PHP_EOL;}

结果：

test6
orderStatus 入口：测试
test6 end
orderLog 入口：测试
test run 入口：测试

总结：行为代码中定义了指定的方法，就不会再去调用默认的run方法了

【测试7】 行为代码中有 exit 可以阻断后续的逻辑运行

2. application\web\behavior\Order.php

    public function run($param = []) {
    echo "Order run 入口：" . $param['name'] . PHP_EOL;}public function orderStatus($param = []) {
    echo "orderStatus 入口：" . $param['name'] . PHP_EOL;//阻断exit;}public function orderLog($param = []) {
    echo "orderLog 入口：" . $param['name'] . PHP_EOL;}

结果：

test6
orderStatus 入口：测试

Ps:我自己的理解

实际业务中可以实现功能的动态调用，比如：微信活动给用户加积分，后期要根据加多少积分进行不同文案推送，就可以使用钩子，在钩子中实现具体的逻辑，以后如果不用推送直接把钩子注释掉就可以了