【PHP高级特性】自动加载

怎甘沉沦 提交于 2019-12-24 10:45:25

前言:

include 和 require 是PHP中引入文件的两个基本方法。在小规模开发中直接使用 include 和 require 没哟什么不妥,但在大型项目中会造成大量的 include 和 require 堆积。这样的代码既不优雅,执行效率也很低,而且维护起来也相当困难。

为了解决这个问题,部分框架会给出一个引入文件的配置清单,在对象初始化的时候把需要的文件引入。但这只是让代码变得更简洁了一些,引入的效果仍然是差强人意。PHP5 之后,随着 PHP 面向对象支持的完善,__autoload 函数才真正使得自动加载成为可能。

 

* include 和 require 功能是一样的,它们的不同在于 include 出错时只会产生警告,而 require 会抛出错误终止脚本。

* include_once 和 include 唯一的区别在于 include_once 会检查文件是否已经引入,如果是则不会重复引入。

 

1、自动加载__autoload(废弃)

实现自动加载最简单的方式就是使用 __autoload 魔术方法。当需要使用的类没有被引入时,这个函数会在PHP报错前被触发,未定义的类名会被当作参数传入。至于函数具体的逻辑,这需要用户自己去实现。

首先创建一个 autoload.php 来做一个简单的测试:

// 类未定义时,系统自动调用function __autoload($class)
{
    /* 具体处理逻辑 */echo $class;// 简单的输出未定义的类名}

new HelloWorld();

/**
 * 输出 HelloWorld 与报错信息
 * Fatal error: Class 'HelloWorld' not found
 */

通过这个简单的例子可以发现,在类的实例化过程中,系统所做的工作大致是这样的:

/* 模拟系统实例化过程 */function instance($class)
{
    // 如果类存在则返回其实例if (class_exists($class, false)) {
        return new $class();
    }
    // 查看 autoload 函数是否被用户定义if (function_exists('__autoload')) {
        __autoload($class); // 最后一次引入的机会    }
    // 再次检查类是否存在if (class_exists($class, false)) {
        return new $class();
    } else { // 系统:我实在没辙了throw new Exception('Class Not Found');
    }
}

明白了 __autoload 函数的工作原理之后,那就让我们来用它去实现自动加载。

首先创建一个类文件(建议文件名与类名一致),代码如下:

class [ClassName] 
{
    // 对象实例化时输出当前类名function __construct()
    {
        echo '<h1>' . __CLASS__ . '</h1>';
    }
}

(我这里创建了一个 HelloWorld 类用作演示)接下来我们就要定义 __autoload 的具体逻辑,使它能够实现自动加载:

function __autoload($class)
{
    // 根据类名确定文件名$file = $class . '.php';

    if (file_exists($file)) {
        include $file; // 引入PHP文件    }
}

new HelloWorld();

/**
 * 输出 <h1>HelloWorld</h1>
 */

 

2、spl_autoload_register(推荐)

接下来让我们要在含有命名空间的情况下去实现自动加载。这里我们使用 spl_autoload_register() 函数来实现,这需要你的 PHP 版本号大于 5.12。

spl_autoload_register 函数的功能就是把传入的函数(参数可以为回调函数或函数名称形式)注册到 SPL __autoload 函数队列中,并移除系统默认的 __autoload() 函数。

一旦调用 spl_autoload_register() 函数,当调用未定义类时,系统就会按顺序调用注册到 spl_autoload_register() 函数的所有函数,而不是自动调用 __autoload() 函数。

注意:实例化一个类时,需要先引用这个类文件,才能被正确实例化成对象。

<?php
//用法一:自动捕捉到类名
​
//spl_autoload_register([$this,'my_autoloader']);   //my_autoloader是一个类中的方法时
spl_autoload_register('my_autoloader');  //my_autoloader是一个函数时
​
function my_autoloader($class) {   //自动捕捉到报错的类名
    include 'classes/' . $class . '.class.php';
}
​
​
// 用法二:自 PHP 5.3.0 起可以使用一个匿名函数
spl_autoload_register(function ($class) {    //自动捕捉到报错的类名
    include 'classes/' . $class . '.class.php';
});
​
?>

这里我们使用了一个数组去保存类名与文件路径的关系,这样当类名传入时,自动加载器就知道该引入哪个文件去加载这个类了。但是一旦文件多起来的话,映射数组会变得很长,这样的话维护起来会相当麻烦。如果命名能遵守统一的约定,就可以让自动加载器自动解析判断类文件所在的路径。接下来要介绍的PSR-4 就是一种被广泛采用的约定方式。

 

3、PSR-4规范(推荐)

PSR-4 是关于由文件路径自动载入对应类的相关规范,规范规定了一个完全限定类名需要具有以下结构:

*****命名空间和文件名的对应关系*****
\顶级命名空间\子命名空间\类名     <=======>   \文件基目录\相对路径\文件名 

PSR-4 规范中必须要有一个顶级命名空间,它的意义在于表示某一个特殊的目录(文件基目录)。

子命名空间代表的是类文件相对于文件基目录的这一段路径(相对路径),类名则与文件名保持一致(注意大小写的区别)。

举个例子:在全限定类名 \app\view\news\Index 中,如果 app 代表 C:\Baidu,那么这个类的路径则是 C:\Baidu\view\news\Index.php

我们就以解析 \app\view\news\Index 为例,编写一个简单的 Demo:

 
$class = 'app\view\news\Index';
​
/* 顶级命名空间路径映射 */
$vendor_map = array(
    'app' => 'C:\Baidu',
);
​
/* 解析类名为文件路径 */
//substr(string,start,length)截取字符并返回
//strpos() 函数查找字符串在另一字符串中第一次出现的位置。
$vendor = substr($class, 0, strpos($class, '\\')); // 取出顶级命名空间[app]
$vendor_dir = $vendor_map[$vendor]; // 文件基目录[C:\Baidu]
// 相对路径[/view/news] 。dirname返回路径的目录部分。strlen获取字符串长度
$rel_path = dirname(substr($class, strlen($vendor))); 
//basename() 函数返回路径中的文件名部分。
$file_name = basename($class) . '.php'; // 文件名[Index.php]
​
/* 输出文件所在路径 */
// DIRECTORY_SEPARATOR兼容的目录分隔符
echo $vendor_dir . $rel_path . DIRECTORY_SEPARATOR . $file_name;

通过这个 Demo 可以看出限定类名转换为路径的过程。那么现在就让我们用规范的面向对象方式去实现自动加载器吧。

 

演示:实例化未引用的类,会自动将_类名 + 命名空间_转化成绝对路径,再次尝试引用。

首先我们创建一个文件 Index.php,它处于 \app\mvc\view\home 目录中:

namespace app\mvc\view\home;

class Index
{
    function __construct()
    {
        echo '<h1> Welcome To Home </h1>';
    }
}

接着我们在创建一个加载类(不需要命名空间),它处于 \ 目录中:

class Loader
{
    /* 路径映射 */
    public static $vendorMap = array(
        'app' => __DIR__ . DIRECTORY_SEPARATOR . 'app',
    );
​
    /**
     * 自动加载器
     */
    public static function autoload($class)
    {
        $file = self::findFile($class);
        if (file_exists($file)) {
            self::includeFile($file);
        }
    }
​
    /**
     * 解析文件路径
     */
    private static function findFile($class)
    {
        $vendor = substr($class, 0, strpos($class, '\\')); // 顶级命名空间
        $vendorDir = self::$vendorMap[$vendor]; // 文件基目录
        $filePath = substr($class, strlen($vendor)) . '.php'; // 文件相对路径
        return strtr($vendorDir . $filePath, '\\', DIRECTORY_SEPARATOR); // 文件标准路径
    }
​
    /**
     * 引入文件
     */
    private static function includeFile($file)
    {
        if (is_file($file)) {
            include $file;
        }
    }
}

最后,将 Loader 类中的 autoload 注册到 spl_autoload_register 函数中:

include 'Loader.php'; // 引入加载器
spl_autoload_register('Loader::autoload'); // 注册自动加载
​
new \app\mvc\view\home\Index(); // 实例化未引用的类
​
/**
 * 输出: <h1> Welcome To Home </h1>
 */

示例中的代码其实就是 ThinkPHP 自动加载器源码的精简版,它是 ThinkPHP 5 能实现惰性加载的关键。

至此,自动加载的原理已经全部讲完了,如果有兴趣深入了解的话,可以参考下面的 ThinkPHP 源码。

易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!