PHP自动加载机制。

Posted 2020-12-14 kakasaber

本文实例讲述了php自动加载机制。分享给大家供大家参考，具体如下：

在php中，我们一般使用 require, requre_once, include, include_once 这四个命令来加载其他php文件，这在一般小型的php文件中是没有任何问题的，相信每个初学者都会遇到这样的应用场景：使用一个 Db.php 来定义数据库连接，在其他文件中直接引用这个文件，达到代码复用的效果。

再让我们考虑这样一个应用场景，如果我们使用一个框架，或者一个第三方包，里面一般有成百上千个类文件，而我们通常是不用自己去加载这些文件的，此时用的便是php的自动加载机制。

定义一种自动加载模式

在传统的应用中，通常自定义 __autoload()。如下

1 2 3 4 5

define("DIR", "/var/www/myWeb/myClass/"); function __autoload($classname) {   require DIR.$classname.‘.class.php‘; } $book = new Book();

上述代码运作过程如下：

1. 自定义 __autoload 函数，它定义了类文件的加载方式
2. 当我们 new 一个 Book 实例时，它首先看当前是否包含了这个类，如果不存在则自动调用 __autoload 函数并将类名 Book 作为参数传递给这个函数。这实际上就是一种动态加载的方式，只有我们需要的类文件才会被加载。
3. 找到 __autoload 函数后，发现定义好的加载动作 require DIR.$classname.‘.class.php‘; 这时候它就会去 DIR 目录下查找 Book.class.php 文件，如果存在这个文件则加载。
4. 关于类 Book.class.php 的定义必须满足如下条件：类名和文件名一致；一个文件只定义一个类。

Book.class.php 文件如下

1 2 3 4 5

class Book {   public function __construct() {     echo "this is Book‘s construct ";   } }

注册多种加载模式

对于我们自己的简单应用，一种加载模式可能够用了，但是对于较大型的应用，上面的方式存在明显的缺陷：__autoload函数不能重复定义，也就是说我们只能定义一种加载文件的模式，最终的结果就是我们的类只能放在一个地方，这显然是不符合实际要求的。因此php使用了函数 spl_autoload_register 来代替 __autolaod。

代码如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

define("MODEL_DIR", "/var/www/myWeb/myModel/"); define("CONTROLLER_DIR", "/var/www/myWeb/myController/"); // 定义Model类加载方式 function loadModel($classname) {   $filename = MODEL_DIR.$classname.‘.php‘;   if (file_exists($filename))     require $filename; } // 定义Controller加载方式 function loadController($classname) {   $filename = CONTROLLER_DIR.$classname.‘.php‘;   if (file_exists($filename))     require $filename; } // 注册两个加载函数 spl_autoload_register("loadModel"); spl_autoload_register("loadController"); // 自动加载类文件 $bookMode = new BookMode(); $bookController = new BookController();

在上面的代码中，我们可以看到：

1. 可以使用任意函数名定义多个加载函数
2. 在 spl_autoload_register 对加载函数进行注册，实际上应该是添加到一个类似双向队列的数据结构中。
3. 当我们 new 的对象不存在于当前文件时，它会自动从我们的加载函数中查找，并且是按照我们使用 spl_autoload_register 注册的顺序进行的。
4. 需要注意的是，此时如果我们定义了 __autoload 方法，也必须进行注册，否则会被忽略。

spl_autoload_register有三种注册函数的方式：

1 2 3

spl_autoload_register(funName); // 直接注册一个普通加载函数 spl_autoload_register(obj::method); // 注册一个静态加载方法 spl_autoload_regitser(array(obj, method)); // 当obj为类字符串时，只能加载静态方法。否则都可以。

实例

在各种php框架中，也大量用到了自动加载机制，我们通过laravel的一个小例子来看下。

laravel通过 Ioc 容器帮我们管理依赖，让我们可以通过函数参数的方式愉快地获得了类实例，但我们也发现，我们并没有require文件，那容器又是如何找到我们的文件地址的？下面我们就来解决这个问题。

通过入口文件 index.php 我们一步步搜索，可以找到 /vendor/composer/ClassLoader.php 文件。

部分代码如下

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30

public static function loadClassLoader($class) {   if (‘ComposerAutoloadClassLoader‘ === $class) {     require __DIR__ . ‘/ClassLoader.php‘;   } } public static function getLoader() {   if (null !== self::$loader) {     return self::$loader;   }   spl_autoload_register(array(‘obj‘, ‘loadClassLoader‘), true, true);   // 通过命名空间的方式使用注册的加载类   self::$loader = $loader = new ComposerAutoloadClassLoader();   spl_autoload_unregister(array(‘obj‘, ‘loadClassLoader‘));   if (PHP_VERSION_ID >= 50600) {     // 该文件定义了包类和用户类的命名空间和实体文件的映射     // 以及其他一些东西     require_once __DIR__ . ‘/autoload_static.php‘;     // 初始化$loader一些属性。     // 我们关注autoload_static.php文件的类映射     // 被赋值在了 $loader的$classMap属性         call_user_func(ComposerAutoloadComposerStaticInit::getInitializer($loader));     // ...   }   // ...   $loader->register(true);   // ...   return $loader; }

它调用了 getLoader() 函数，并将 loadClassLoader 函数注册到加载函数注册队列。然后就可以通过命名空间的方式 self::$loader = $loader = new ComposerAutoloadClassLoader(); 实例化 ClassLoader 类。

紧接着，他载入了 /autoload_static.php 文件，大致内容如下

1 2 3 4 5 6

// 里面还定义了包类和psr的一些标准 public static $classMap = array (   ‘App\Common\Collection‘ => __DIR__ . ‘/../..‘ . ‘/app/Common/Collection.php‘,   ‘App\Common\MgDB‘ => __DIR__ . ‘/../..‘ . ‘/app/Common/MgDB.php‘,   ‘App\Common\Redis‘ => __DIR__ . ‘/../..‘ . ‘/app/Common/Redis.php‘, )

看到这里笔者兴奋了，因为上面的 Collection, Redis 正是笔者定义的类！
然后就是我们在laravel经常听到的一个名词 “register”。查看 ClassLoader 类的 register 方法如下：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

public function register($prepend = false) {   spl_autoload_register(array($this, ‘loadClass‘), true, $prepend); } public function loadClass($class) {   if ($file = $this->findFile($class)) {     includeFile($file);     return true;   } } public function findFile($class) {   // ...   // class map lookup   if (isset($this->classMap[$class])) {     return $this->classMap[$class];   }   // ... }

上面的register方法同样使用了自动加载机制。并将通过findFile函数和$classMap数组直接找到对应的类的具体位置。这也就是我们不用自己去加载类文件的原因 – 当我们实例化一个代码中找不到的类时，它便会在这里加载对应的类。

看到这里我们也发现了它的使用和我们之前讲的并不完全一致，我们是注册函数是为了通过文件夹来寻找类，而laravel注册函数是为了注册一个映射数组然后直接调用（整了个映射文件三千多行。。。）具体为什么要这么做得等下次通读加载源码部分后再写一篇博文（本来只想找一个框架的例子，蜜汁尴尬）

笔者实例

两年前负责学校某个协会线上部分时，主要是做微信开发，因为时不时就要加一个新功能，所以如果用一般的方式写起来是比较痛苦的，但是用框架又有点大材小用。因为就使用了下面这种简单的方式：

1 2 3 4 5 6 7 8 9 10 11 12 13

require "./basic/init.php"; define(‘WEB_PATH‘, ‘‘); //声明自动加载函数并注册，指示加载路径与加载方法   function wechatAutoload($class_name)   {     $file_road = ‘./function/‘.$class_name.‘.class.php‘;     if(file_exists($file_road))     {       require_once($file_road);     }   }   spl_autoload_register(‘wechatAutoload‘); //----------------------------------------------

初始化好配置之后，我们注册了一个加载函数，以后每一个新功能都只要在 function 文件夹下新增一个文件即可，其他部分的改动很少或者根本不用（根据业务场景）。