PHP自动加载autoload和命名空间 namespace 及导入 use 的用法

朴灿烈づ我的快乐病毒、 2022-03-26 14:18 390阅读 0赞

最近在研究别人项目的时候，看到了namespace 及use的使用，一头雾水，所以查了不少资料，做如下几个总结；

### 命名空间： ###

命名空间一个最明确的目的就是解决重名问题，PHP中不允许两个函数或者类出现相同的名字，否则会产生一个致命的错误。

**需要注意的是: 命名空间的命名方式需要和文件夹文件名称对应；**

**使用namespace的目的：**

团队合作项目时，避免与团队其它成员新建的类发生冲突；个人负责项目时，避免前后新建的类发生冲突；用到所需要的类时，需要先require或include引入，所以会发生类重定义的错误的前提是：两个相同命名的类都有被引入。目前有些php框架会自动加载（即include）所有新建的model类，所以为了避免你新建的model类和项目框架原生的核心类发生重名冲突，采用了namespace。（想了想，与团队成员新建的类产生冲突应该通过沟通避免，即使事发后也应该重新调整类名即时维护，避免后期造成因为对类的理解混淆而带来维护上的复杂度提高）

在引入一个命名空间的时候，使用到use这个关键词的时候。

### 自动加载： ###

**1. 自动加载的原理以及\_\_autoload的使用**

自动加载的原理，就是在我们实例化一个 class 的时候，PHP如果找不到这个类，就会去自动调用本文件中的 \_\_autoload($class\_name) 方法，我们new的这个class\_name 就成为这个方法的参数。所以我们就可以在这个方法中根据我们需要new class\_name的各种判断和划分就去require对应的路径类文件，从而实现自动加载。

我们先来看下 \_\_autoload() 的自动调用，举个栗子：

index.php

<?php
    
    $db = new Db();

如果我们不手动导入Db类，程序可能会报错，说找不到这个类：

Fatal error: Uncaught Error: Class 'DB' not found in D:\\web\\helloweba\\demo\\2017\\autoload\\index.php:2 Stack trace: \#0 \{main\} thrown in D:\\web\\helloweba\\demo\\2017\\autoload\\index.php on line 2

那么，我们现在加入 \_\_autoload() 这个方法再看看：

$db = new DB();
    
    function __autoload($className) {
    
     echo $className;
    
     exit();
    
    }

**2. spl\_autoload\_register自动加载**根据上面自动加载机制的描述，会输出：Db， 也就是我们需要new 的类的类名。所以，这个时候我们就可以在 \_\_autoload() 方法里，根据需要去加载类库文件了。

如果是小项目，用 \_\_autoload() 就能实现基本的自动加载了。但是如果一个项目很大，或者需要不同的自动加载来加载不同路径的文件，这个时候\_\_autoload就杯具了，因为一个项目中只允许有一个 \_\_autoload() 函数，因为 PHP 不允许函数重名了，也就是说你不能声明2个 \_\_autoload() 函数文件，否则会报致命错误。那怎么办呢？放心，你想到的，PHP大神早已经想到。 所以 spl\_autoload\_register() 这样又一个牛逼函数诞生了，并且取而代之它。它执行效率更高，更灵活。

先看下它如何使用，在index.php中加入以下代码。

<?php
    
    spl_autoload_register(function($className){
    
     if (is_file('./Lib/' . $className . '.php')) {
    
     require './Lib/' . $className . '.php';
    
     }
    
    });
    
    $db = new Db();
    
    $db::test();

在Lib\\Db.php文件中加入以下代码：

<?php
    
    class Db
    
    {
    
     public static function test()
    
     {
    
     echo 'Test';
    
     }
    
    }

也就是说， spl\_autoload\_register 是可以多次重复使用的，这一点正是解决了 \_\_autoload 的短板，那么如果一个页面有多个 spl\_autoload\_register ，执行顺序是按照注册的顺序，一个一个往下找，如果找到了就停止。运行index.php后，当调用 new Db() 时， spl\_autoload\_register 会自动去lib/目录下查找对应的Db.php文件，成功后并且能够执行 $db::test(); 。同样如果在Lib\\目录下有多个php类文件，都可以在index.php中直接调用，而不需要使用 require 多个文件。

**3. spl\_autoload\_register自动加载和namespace命名空间**

对于非常复杂的系统，其目录结构也会非常复杂，规范的命名空间解决了复杂路径下大量文件、函数、类重名的问题。而自动加载现在是PHP现代框架的基石，基本都是 spl\_autoload\_register 来实现自动加载。所以spl\_autoload\_register + namespace 就成为了一个主流。

根据PSR系列规范，namespace命名已经非常规范化，所以根据namespace就能找到详细的路径，从而找到类文件。

我们用最简单的例子来说明复杂系统如何自动加载类文件。

首先，我们准备系统目录结构：

`----/Lib ``// 类目录`

`--Db.php `

`--Say.php`

`----autoload.php``// 自动加载函数`

`----index.php``// 首页`

以上是一个基本的系统目录，我们要实现的是，使用命名空间和自动加载，直接在首页index.php调用Lib目录下的多个类。

我们准备两个列文件：

Db.php
    <?php
    
    namespace Lib;
    
    class Db
    
    {
    
     public function __construct()
    
     {
    
     //echo 'Hello Db';
    
     }
    
     public static function test()
    
     {
    
     echo 'Test';
    
     }
    
    }
    
    Say.php
    
    <?php
    
    namespace Lib;
    
    class Say
    
    {
    
     public function __construct()
    
     {
    
     //echo 'Hello';
    
     }
    
     public function hello()
    
     {
    
     echo 'say hello';
    
     }
    
    }

上两个普通的类文件，添加了命名空间： namespace Lib; 表示该类文件属于Lib\\目录名称下的，当然你可以随便取个不一样的名字来表示你的项目名称。

现在我们来看autoload.php：

<?php
    
    spl_autoload_register(function ($class) {
    
     $prefix = 'Lib\\';
    
     $base_dir = __DIR__ . '/Lib/';
    
     // does the class use the namespace prefix?
    
     $len = strlen($prefix);
    
     if (strncmp($prefix, $class, $len) !== 0) {
    
     // no, move to the next registered autoloader
    
     return;
    
     }
    
     $relative_class = substr($class, $len);
    
     // 兼容Linux文件找。Windows 下（/ 和 \）是通用的
    
     $file = $base_dir . str_replace('\\', '/', $relative_class) . '.php';
    
     if (file_exists($file)) {
    
     require $file;
    
     }
    
    });

好了，现在我们在首页index.php这样调用:以上代码使用函数 spl\_autoload\_register() 首先判断是否使用了命名空间，然后验证要调用的类文件是否存在，如果存在就 require 类文件。

?php
    
    use Lib\Db;
    
    use Lib\Say;
    
    require './autoload.php';
    
    $db = new Db();
    
    $db::test();
    
    $say = new Say;
    
    $say->hello();

接下来就直接调用Lib/目录下的各种类文件了，你可以在Lib/目录下放置多个类文件尝试下。我们只需使用一个require将autoload.php加载进来，使用 use 关键字将类文件路径变成绝对路径了，当然你也可以在调用类的时候把路径都写上，如： new Lib\\Db(); ，但是涉及到多个类互相调用的时候就会很棘手，所以我们还是在文件开头就使用 use 把路径处理好。

运行index.php看看是不是如您所愿。

**结束语**

该文简单介绍了自动加载以及命名空间的使用，实际开发中，我们很少去关注autoload自动加载的问题，因为大多数现代PHP框架都已经处理好了文件自动加载的问题。开发者只需关注业务代码，使用规范的命名空间就可以了。当然，如果你想自己开发个项目不依赖大型框架亦或者自己开发php框架，那你就得熟悉下autoload自动加载这个好东西了，毕竟它可以让我们“偷懒”，省事多了。

现代php里，我们经常使用 Composer 方式安装的组件，都可以通过autoload实现自动加载，所以还是一个“懒”字给我们带来了极好的开发效率。