PHP - 命名空间（namespace）概述及实例说明

淡淡的烟草味﹌ 2022-12-01 03:55 162阅读 0赞

## 什么是命名空间 ##

> 从广义上来说，命名空间是一种封装事物的方法，在很多地方都可以见到这种抽象概念。

例如，在操作系统中目录用来将相关文件分组，对于目录中的文件来说，它就扮演了命名空间的角色。

具体举个例子，文件 `foo.txt` 可以同时在目录 `/home/greg` 和 `/home/other` 中存在，但在同一个目录中不能存在两个 `foo.txt` 文件。

另外，在目录 `/home/greg` 外访问 `foo.txt` 文件时，我们必须将目录名以及目录分隔符放在文件名之前得到 `/home/greg/foo.txt` ，这个原理应用到程序设计领域就是命名空间的概念。

## PHP中的命名空间 ##

> 说白了，就是解决命名冲突，这其中包括 `PHP` 内部类 / 框架类 / 同事创建的类等，就像上面所说的一样，**它们处在 “不同文件夹” 一样。** 所以不会互相影响。

在 `PHP`中，命名空间用来解决在编写类库或应用程序时创建可重用的代码如类或函数时碰到的两类问题：

1.  用户编写的代码与 `PHP` 内部的类/函数/常量或第三方类/函数/常量之间的名字冲突。
2.  为很长的标识符名称(通常是为了缓解第一类问题而定义的)创建一个别名（或简短）的名称，提高源代码的可读性。

## 定义命名空间 ##

> 虽然任意合法的 `PHP` 代码都可以包含在命名空间中，但只有以下类型的代码受命名空间的影响，它们是：类（包括抽象类和 `traits`）、接口、函数和常量。

命名空间通过关键字 **namespace** 来声明，但要注意，如果一个文件中包含命名空间，它必须在其它所有代码之前声明命名空间（除了 `declare` 关键字）。

<?php
    // 头部 "<?php" 前不能有任何代码
    // 命名空间声明必须在第一行
    
    // @PHP命名空间也允许指定层次化的命名空间的名称
    // @就像文件层次结构一样(目录与文件关系)
    
    namespace apples\server;
    
    /** * @下面的view类就好像在apples\server文件夹内 * @即便外面再有相同的名称也不会冲突 * @因为它们不在同一文件夹内 */
    class view
    { 
        public function index()
        { 
            //...
        }
    }
    ?>

## 准备 ##

有了理论概念基础，我们来动手准备以下环境，首先创建如下图这样一个目录结构：  
![在这里插入图片描述][20200826145450561.png_pic_enter]  
假设我们的项目根目录为 `apples`，客户端目录为 `client`，服务端目录为 `server`。

## 完成实例 ##

接下来，我们利用所学命名空间来完成一个实例。

**编写后端接口（server / api.php）**

## api.php
    
    <?php
    
    // 自定义命名空间(最好与文件夹层次结构同名)
    namespace apples\server;
    
    /** * 界面显示隐藏开关接口 * @show: 显示方法 * @hide: 隐藏方法 * @return null; */
    class api 
    { 
        public static function show()
        { 
            echo '开启显示';
        }
    
        public static function hide()
        { 
            echo '开启隐藏';
        }
    }
    
    ?>

**客户端使用接口（client / view.php）**

<?php
    
    namespace apples\client;
    
    # 引用命名空间(导入)
    use apples\server\api;
    include '../server/api.php';//这里可以实现自动导入(不用写)文本暂不讨论
    
    // 调用开关 -> 显示
    api::show();//开启显示
    
    // 调用开关 -> 关闭
    api::hide();//开启隐藏
    
    ?>

**客户端结果：**  
![在这里插入图片描述][20200826175123124.png_pic_cnter]

## 写在后面 ##

本文只是冰山一角，用简单的语言描述而已，如果你想深入了解，请访问官方文档。

> [https://www.php.net/manual/zh/language.namespaces.php][https_www.php.net_manual_zh_language.namespaces.php]

[20200826145450561.png_pic_enter]: /images/20221123/e478559e77e749da95614a74ebbc78dc.png
[20200826175123124.png_pic_cnter]: /images/20221123/a5f741a7800e454b9c984efe1752e1d6.png
[https_www.php.net_manual_zh_language.namespaces.php]: https://www.php.net/manual/zh/language.namespaces.php