PHP的namespace

环境

• Windows 11 专业版
• PHP 8.2.12

Java的package

在学习PHP的namespace之前，先来复习一下Java的package。

package关键字

Java使用 package 关键字来声明包，支持多级结构，各级之间以 . 分隔。

一般全部使用小写字母，使用倒序，比如： com.mycompany.myproject.mypackage 。

例如：

• MyClass1.java ：

package mypkg1.mysubpkg1; // 声明packagepublic class MyClass1() {
......
}

• MyClass2.java ：

package mypkg2.mysubpkg1; // 声明packageimport mypkg1.mysubpkg1.MyClass1; // 引入MyClass1public class MyClass2() {public static void main(String[] args) {var obj = new MyClass1();......}
......
}

包结构和目录结构

在Java里，包结构和实际文件的目录结构必须保持一致，如果不一致则编译报错。

比如包名是 com.mycompany.myproject.mypackage ，则实际目录结构必须是 com/mycompany/myproject/mypackage 。其中 com 目录是在Java源代码的根目录下。

此外，如果Java文件包含了public类（一个Java文件里最多只能有一个public类），则文件名必须与该类的命名一致，参见上面的例子。

访问权限

Java的包会影响访问权限。

我们知道，Java的访问修饰符如下：

• public ：在任何地方都可见
• protected ：只在同一个包，以及子类中可见
• 缺省（包访问权限）：只在同一个包中可见
• private ：只在本类内部可见

注意：一个Java文件里可以定义多个类，它们也是在同一个包里的（但一个Java文件里最多只能有一个public类）。

访问修饰符	同一个类	同一个包	不同包的子类	不同包的非子类
public	Y	Y	Y	Y
protected	Y	Y	Y	N
缺省	Y	Y	N	N
private	Y	N	N	N

import关键字

Java通过 import 关键字来引入包资源。由于包结构和实际文件目录结构一致，所以 import 既指定了包结构，也指定了目录结构（这和PHP是不同的）。

在import语句中，可以指定一个资源，也可以使用通配符 * ，比如：

• import java.util.List
• impport java.util.*

使用 import 来引入资源后，接下来就可以直接使用资源，而不需要指定资源的全限定名了，比如：

import java.util.ArrayList;
......ArrayList<String> list = new ArrayList<>();

注意：如果不通过 import 来引入资源，也可以使用资源，只不过每个用到资源的地方，都需要指定全限定名，比如：

        java.util.ArrayList<String> list = new java.util.ArrayList<>();

总结

• 使用 package 关键字来声明包，各级之间以 . 分隔
• 包结构和实际文件目录结构必须一致
• 包可以影响访问权限
• 通过 import 关键字来引入包资源，简化使用

PHP的namespace

namespace关键字

PHP通过 namespace 关键字来定义命名空间，对于多级命名空间，不同层级之间用 \ 分隔，比如：

namespace MyProject\Controllers;class MyClass1 {......
}

注：遵循 PSR-4 标准，使用首字母大写（PascalCase）。

注意：namespace 后面不用加引号，但是 require 和 include 后面需要加引号，比如：

namespace MyProject\Controllers;require 'test0602_1.php';
......

实际上，PHP的namespace有两种写法，上面的写法叫做非括号语法，还有一种写法叫做括号语法，如下：

namespace MyProject1 {......
}

这两种写法，在同一个文件中不能混用。

推荐还是使用非括号语法，而且一个文件只用一个namespace。

括号语法的一个不同之处在于，可以显式声明一个全局命名空间，比如：

namespace {......
}

不加命名空间名字，就是全局命名空间。

在同一个文件里使用资源

首先，在同一个文件里，可以有多个namespace（这一点和Java不一样），比如：

namespace MyProject1\Namespace1;......namespace MyProject2\Namespace2;......

或者：

namespace MyProject1\Namespace1 {......
}namespace MyProject2\Namespace2 {......
}

限定，完全限定，非限定

在使用另一个命名空间的资源时，可用下面三种方式：

• 限定：有点类似于“相对路径”，但貌似只能向下，不能向上（即找其父命名空间）
• 完全限定：有点类似于“绝对路径”，安全可靠
• 非限定：不指定namespace信息（使用当前命名空间的资源，或者全局资源，或者资源的别名）

限定

namespace MyProject1\Namespace1;
const PI = 3.14;namespace MyProject1;
echo Namespace1\PI;

本例中，在 MyProject1 下，要使用 MyProject1\Namespace1 下的资源，可以直接从当前命名空间开始计算，因此只需指定 Namespace1 即可（开头不加 \ ）。

完全限定

namespace MyProject1\Namespace1;
const PI = 3.14;namespace MyProject2\Namespace2;
echo \MyProject1\Namespace1\PI;

不管在哪里，要使用 MyProject1\Namespace1 下的资源，都可以从根命名空间开始计算，也就是以 \ 开头，指定全路径 \MyProject1\Namespace1。

非限定

namespace {const E = 2.72;
}namespace MyProject1 {echo E;// echo \E;
}

本例中，因为要使用的是全局命名空间的资源，所以无需指定namespace。

当然，如果前面加上 \ ，显式指定全局资源，也是OK的。

事实上，如果使用全局资源，加上 \ 会更安全一些，这是因为如果不加 \ ，会先查找当前命名空间，然后才是全局命名空间。

namespace MyProject1\Namespace1;
const M_PI = 3.14;
echo M_PI . PHP_EOL;
echo \M_PI . PHP_EOL;

输出结果如下：

3.14
3.1415926535898

可见 M_PI 和 \M_PI 是不同的，前者是当前命名空间的常量，后者是全局常量。

如果注释掉第二行代码，则 M_PI 和 \M_PI 一样，都是指向全局常量。

use关键字

使用其它命名空间的资源时，每次都要指定命名空间结构，太麻烦了。为了方便，可使用 use 关键字来简化操作。

use 关键字有以下几种使用方法：

• 指定命名空间
• 指定资源
• 指定命名空间，并给命名空间起个别名
• 指定资源，并给资源起个别名

namespace MyProject1\Namespace1;
const PI = 3.14;namespace MyProject2\Namespace2;
use \MyProject1\Namespace1; // 指定命名空间
echo Namespace1\PI . PHP_EOL;namespace MyProject3\Namespace3;
use const \MyProject1\Namespace1\PI; // 指定资源
echo PI . PHP_EOL;namespace MyProject4\Namespace4;
use \MyProject1\Namespace1 as MyNamespace; // 指定命名空间，并给命名空间起个别名
echo MyNamespace\PI . PHP_EOL;namespace MyProject5\Namespace5;
use const \MyProject1\Namespace1\PI as MyPI; // 指定资源，并给资源起个别名
echo MyPI . PHP_EOL;

注意和Java的区别：Java的 import 指定的是资源（具体来说是类），比如 import java.util.* 或者 import java.util.ArrayList 。而PHP的 use 既可以指定命名空间，也可以指定资源。

PHP在use命名空间时，如果没有起别名，则接下来使用命名空间的最后一部分（如上例中的 Namespace1 ）来简化命名空间全称，如果有别名，则使用别名来简化命名空间全称。

同理，PHP在use资源时，如果没有起别名，则接下来使用资源名（如上例中的 PI ）来简化其全限定名，如果有别名，则使用别名来简化其全限定名。

此外要注意，PHP在use资源时，如果是常量，则需显式指定 const （见上例）。类似的，如果是use一个方法，则需显式指定 function 。

起别名的一个重要意义在于，如果引入多个相同非限定名的命名空间或者是引入同名资源，则需要通过别名来避免冲突。比如：

namespace MyProject1\Controller;
const E = 2.71;namespace MyProject2\Controller;
const E = 2.71828;namespace MyProject1\Namespace1;
const PI = 3.14;namespace MyProject2\Namespace2;
const PI = 3.14159;namespace MyProject3\Namespace3;
use \MyProject1\Controller as Controller1; // Controller有歧义，需用别名避免冲突
echo Controller1\E . PHP_EOL;use \MyProject2\Controller as Controller2; // Controller有歧义，需用别名避免冲突
echo Controller2\E . PHP_EOL;use const \MyProject1\Namespace1\PI as PI1; // PI有歧义，需用别名避免冲突
echo PI1 . PHP_EOL;use const \MyProject2\Namespace2\PI as PI2; // PI有歧义，需用别名避免冲突
echo PI2 . PHP_EOL;

use VS 直接指定资源

前面提到，直接指定资源限定名时：

• 以 \ 开头：完全限定，从根命名空间开始计算
• 不以 \ 开头，非完全限定，从当前命名空间开始计算

在使用 use 关键字指定命名空间或资源时，无论是否以 \ 开头，都是完全限定的。也就是说，一定是从根命名空间开始计算的。

namespace MyProject1\Namespace1;
const PI = 3.14;namespace MyProject1;
echo Namespace1\PI . PHP_EOL; // 直接指定，不以 \ 开头，非完全限定，从当前命名空间开始计算echo \MyProject1\Namespace1\PI . PHP_EOL; // 直接指定，以 \ 开头，完全限定，从根命名空间开始计算use const MyProject1\Namespace1\PI as MyPI1; // 使用use， 不以 \ 开头，完全限定，从根命名空间开始计算
echo MyPI1 . PHP_EOL;use const \MyProject1\Namespace1\PI as MyPI2; // 使用use， 以 \ 开头，完全限定，从根命名空间开始计算
echo MyPI2 . PHP_EOL;

注：这种行为可能与PHP版本有关，我使用的PHP 8，也许旧版本不是这样的，我没有深究。

在不同的文件里使用

资源和使用者如果在不同的文件里，则使用者需要先引入资源所在的文件。在PHP里，是使用 include 或者 require 关键字来引入文件，具体参见我另一篇文档（ https://blog.csdn.net/duke_ding2/article/details/147690887 ）。

但是，由于PHP的命名空间和实际目录结构是相互独立的，因此，引入文件后，仍需通过命名空间来指定资源。

• test0602_1.php ：

namespace MyProject1\Namespace1;const PI = 3.14;

• test0602_2.php ：

namespace MyProject2\Namespace2;require 'test0602_1.php';echo \MyProject1\Namespace1\PI;

同样，也可使用 use 关键字来简化操作。

把 test0602_2.php 改写如下：

namespace MyProject2\Namespace2;require 'test0602_1.php';use const \MyProject1\Namespace1\PI;echo PI;

注意和Java对比：

• Java只需 import （既指定目录结构也指定包结构），PHP需要 require 和 use （前者指定目录结构，后者指定命名空间结构）
• Java不用 import 也行，只需指定资源全称。PHP可以不用 use ，只需指定资源或命名空间全称，但是 require 是避免不了的（除非通过自动加载机制隐式加载），因为文件路径和资源全称是相互独立的

总结

• 使用 namespace 关键字来声明命名空间，各级之间以 \ 分隔
• 有“括号语法”和“非括号语法”两种写法，一般使用非括号语法，且一个文件只用一个namespace
• 使用者可以通过“限定”、“完全限定”、“非限定”的方式来指定使用的命名空间
• 命名空间结构和实际文件目录结构可以不一致，但推荐保持一致
• 通过 use 关键字来引入命名空间或者资源，简化使用
• 使用 use 指定的命名空间或资源，不管是否以 \ 开头，实际都是从根命名空间开始计算的（至少PHP8是这样）