CodeIgniter源码分析 6 - 钩子

一般请求一个页面时，只需要通过$this->load-view('test')去加载相应的视图就行了，对于具体怎么解析视图，这个我们不需要关心，交给框架系统就行了。

但现在有个需求，由于加载的页面是html的，我想在render该页面时将其变成纯文本格式，也就是去掉其中的html标签该怎么办？

我们知道，对于render一个页面，一般到了load->view()这一步已经是最后一步，如果再想将render出来的html页面变成纯文本的，我们只能去扒框架底层的源代码，只有了解清楚框架底层render页面的机制，才能在对应的源码处做出修改进而满足我们刚刚的这个需求。

那么，能不能不去扒源码的同时又能参与到框架底层的运行流程中呢？ 答案是能，通过 钩子。

CI框架中的钩子

什么是钩子？

钩子是框架提供的一种在不修改系统底层源码的前提下，能够介入框架底层运行流程，扩展框架底层的一种手段。通过钩子，我们能够劫持系统底层执行过程中各个环节的数据。

要想使用钩子，就需要了解系统执行过程中的经历的环节有哪些，在CI框架中把这些所谓的环节叫做 挂钩点；而在某个环节处介入系统底层运行的这种行为就叫做 挂钩。

挂钩点的类型

根据文档中描述，CI框架中定义的挂钩点有如下几种

• pre_system 在系统执行的早期调用，这个时候只有 基准测试类 和 钩子类 被加载了， 还没有执行到路由或其他的流程。
• pre_controller 在你的控制器调用之前执行，所有的基础类都已加载，路由和安全检查也已经完成。
• post_controller_constructor 在你的控制器实例化之后立即执行，控制器的任何方法都还尚未调用。
• post_controller 在你的控制器完全运行结束时执行。 display_override 覆盖 _display() 方法，该方法用于在系统执行结束时向浏览器发送最终的页面结果。 这可以让你有自己的显示页面的方法。注意你可能需要使用 $this->CI =� get_instance() 方法来获取 CI 超级对象，以及使用 $this->CI->output->get_output() 方法来 获取最终的显示数据。
• cache_override 使用你自己的方法来替代 输出类中的 _display_cache() 方法，这让你有自己的缓存显示机制。
• post_system 在最终的页面发送到浏览器之后、在系统的最后期被调用。

埋挂钩点的位置

我们知道CI框架是在引导文件 CodeIgniter.php 中完成系统调度的，既然这些挂钩点和系统运行有关，那么容易想到这些挂钩在是被埋在引导文件中的。

image.png

有点这些埋点后，只需要定义好钩子，挂到相应的挂钩点处，让系统运行到挂钩点时运行钩子就行了。

定义钩子

关于如何定义钩子，直接看文档的截图。

image.png

从文档的描述可以看出：

钩子本质上就是个函数，一旦在挂钩点处检测到钩子，系统会将数据扔给这个函数(钩子)。

定义好钩子以后，现在就需要看看系统对于钩子处理的细节了。

调用钩子的源码。

按照惯例还是先看构造方法。

构造方法

public function __construct()
{
        //加载config对象用来读取系统配置
        $CFG =& load_class('Config', 'core');
        log_message('info', 'Hooks Class Initialized');

        //要使用钩子必须先在配置文件配置enable_hooks=true
        if ($CFG->item('enable_hooks') === FALSE)
        {
            return;
        }

        //读取定义了钩子的文件
        if (file_exists(APPPATH.'config/hooks.php'))
        {
            include(APPPATH.'config/hooks.php');
        }

        if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/hooks.php'))
        {
            include(APPPATH.'config/'.ENVIRONMENT.'/hooks.php');
        }

        //所有的钩子都是挂在$hook这个数组下的，如果$hook不合法，那么就直接返回
        if ( ! isset($hook) OR ! is_array($hook))
        {
            return;
        }

        //最后将钩子数组挂在属性hooks上
        $this->hooks =& $hook;
        $this->enabled = TRUE;
 }

可以看到构造方法只做了一件事就是读取定义好的钩子并附着到hooks属性上。那么对于我们在引导文件 CodeIgniter.php 看到的钩子调用原函数 call_hooks() 来说就是传入相应的挂钩点，然后执行下面的钩子函数就行了。

call_hooks()

public function call_hook($which = '')
{
        //判断配置项是否开启，并且挂钩点是否定义
        if ( ! $this->enabled OR ! isset($this->hooks[$which]))
        {
            return FALSE;
        }

        //由于钩子的定义有三种格式：匿名函数，一维数组和二维数组，所以这里做了一下区分
        if (is_array($this->hooks[$which]) && ! isset($this->hooks[$which]['function']))
        {
            foreach ($this->hooks[$which] as $val)
            {
                $this->_run_hook($val);
            }
        }
        else
        {
            $this->_run_hook($this->hooks[$which]);
        }

        return TRUE;
}

call_hooks() 函数中我们看到，对于具体的调用处理是在 run_hook()函数中进行的，看下该函数。

_run_hook()

protected function _run_hook($data)
    {
        //处理匿名函数和一维组数格式的钩子函数
        if (is_callable($data))
        {
            is_array($data)
                ? $data[0]->{$data[1]}()
                : $data();

            return TRUE;
        }
        elseif ( ! is_array($data))
        {
            return FALSE;
        }


        //如果多个挂钩点调用了同一钩子函数，只需要执行一遍就可以了，参数_in_progress就是用来控制这个的
        if ($this->_in_progress === TRUE)
        {
            return;
        }


        if ( ! isset($data['filepath'], $data['filename']))
        {
            return FALSE;
        }

        //判断钩子文件是否存在
        $filepath = APPPATH.$data['filepath'].'/'.$data['filename'];

        if ( ! file_exists($filepath))
        {
            return FALSE;
        }

        //解析出钩子文件中的类，方法，以及参数
        $class      = empty($data['class']) ? FALSE : $data['class'];
        $function   = empty($data['function']) ? FALSE : $data['function'];
        $params     = isset($data['params']) ? $data['params'] : '';

        if (empty($function))
        {
            return FALSE;
        }

        // 标志该钩子函数被执行过
        $this->_in_progress = TRUE;

        //区分有没有类名
        if ($class !== FALSE)
        {
            // 考虑到性能，执行过的钩子对象都会被存储到_objects中防止重复实例化
            if (isset($this->_objects[$class]))
            {
                //调用钩子函数，如果调用失败将_in_progress置为未执行
                if (method_exists($this->_objects[$class], $function))
                {
                    $this->_objects[$class]->$function($params);
                }
                else
                {
                    return $this->_in_progress = FALSE;
                }
            }
            else
            {
                //如果钩子对象未被实例过，那么实例化后调用钩子函数
                class_exists($class, FALSE) OR require_once($filepath);

                if ( ! class_exists($class, FALSE) OR ! method_exists($class, $function))
                {
                    return $this->_in_progress = FALSE;
                }

                // Store the object and execute the method
                $this->_objects[$class] = new $class();
                $this->_objects[$class]->$function($params);
            }
        }
        else
        {
            //钩子函数有可能所在的文件只是个简单函数，如果是就直接调用该函数
            function_exists($function) OR require_once($filepath);

            if ( ! function_exists($function))
            {
                return $this->_in_progress = FALSE;
            }

            $function($params);
        }

        $this->_in_progress = FALSE;
        return TRUE;
    }

钩子调用的源码分析就到这里了，接下来我们看下示例。

钩子调用示例

现在有这么一个需求，对于我们系统的任何输出，我们都希望它的类型是json， 我们都知道在php中的要输出json使用 header() 函数就可以，问题是 header() 放在哪了？总不能一个方法一个方法的在方法体中加 header() 吧，那么这时候钩子就配上用场了。

我们定义一个输出函数

image.png

现在调试查看下 content-type

未使用钩子

image.png

使用钩子后

image.png

可以看到我们通过在挂钩点 post_controller 处定义了一个 header() 函数后，这样系统所有的输出类型都会变成json，钩子让这一切变得很容易；

再比如 rest api 中的 ajax 请求一般都会有跨域的问题，那么借助钩子我们就可以处理相应的跨域问题等等；

总之一句话，钩子能让我们不修改源码的情况下，参与到系统底层运行流程中