PHP - 命名空间

我们经常将文件组织在不同的文件夹中。通常一个文件夹包含与特定目标、应用程序或类别相关的文件。一个文件夹不能包含两个同名的文件，尽管不同的文件夹可以拥有同名的文件，因为每个文件的路径不同。

PHP 中命名空间的概念与此类似。在 PHP 中，命名空间允许使用相同名称的类、函数或常量在不同的上下文中使用而不会发生冲突，从而封装这些项目。

PHP 命名空间是对类/函数等的逻辑分组，取决于它们的关联性。就像同名文件可以存在于两个不同的文件夹中一样，特定名称的类可以定义在两个命名空间中。此外，正如我们指定文件的完整路径来访问一样，我们需要指定类的全名以及命名空间。

随着应用程序规模的扩大，涉及许多类和函数定义，为每个类/函数赋予唯一名称可能会变得繁琐且不够优雅。使用命名空间可以以整洁的方式组织此类代码块。例如，如果我们需要声明一个 calculate() 函数来计算面积和税款，而不是将它们定义为 calculate_area() 和 calculate_tax() 之类的东西，我们可以创建两个命名空间 area 和 tax，并在其中使用 calculate()。

命名空间的优势

以下是使用 PHP 命名空间的一些优势：

命名空间有助于避免由他人定义的类/函数/常量与第三方类/函数/常量之间的名称冲突。
命名空间提供了一种为 Extra_Long_Names 创建别名（或缩短）的能力，从而提高了源代码的可读性。
PHP 命名空间提供了一种对相关的类、接口、函数和常量进行分组的方法。命名空间名称不区分大小写。

定义命名空间

PHP 的 namespace 关键字用于定义新的命名空间。

namespace myspace;

包含命名空间的“.php”文件必须在任何其他代码（除了 declare 指令）之前在文件的顶部声明命名空间。在命名空间内声明类、函数和常量会影响其访问。

PHP 脚本可能包含命名空间定义之外的其他代码。要加载在同一代码中定义的命名空间，PHP 使用“use”关键字。

use myspace;

示例

在下面的“hello.php”脚本中，我们在 myspace 命名空间内定义了一个 hello() 函数，并在当前脚本中加载命名空间后调用它。

<?php
   namespace myspace;
   function hello() {
      echo "Hello World";
   }
   use myspace;
   myspace\hello();
?>

它将产生以下输出：

Hello World

请注意，您必须使用包含命名空间的全名（myspace\hello()）限定 hello() 函数。

包含命名空间

您可能有一个脚本包含命名空间声明，另一个脚本使用 include 语句加载命名空间。

a.php

<?php
   namespace myspace {
      function hello() {
         echo "Hello World in myspace";
      }
   }
?>

b.php

<?php
   include 'a.php';
   myspace\hello();
?>

它将产生以下输出：

Hello World in myspace

可能出现这种情况：当前脚本（如上面的“b.php”）也具有与包含文件中相同的名称的函数。在前面加上命名空间的完全限定函数有助于解析器解决名称冲突。

示例

请看下面的例子：

<?php
   include 'a.php';
   function hello() {
      echo "Hello World from current namespace";
   }
   hello();
   myspace\hello();
?>

它将产生以下输出：

Hello World from current namespace
Hello World in myspace

示例

如上所述，命名空间声明必须位于顶部，紧跟在起始 <?php 标记之后。否则，解析器将抛出致命错误。

<?php
   echo "hello"
   namespace myspace;
   function hello() {
      echo "Hello World";
   }
   use myspace;
   myspace\hello();
?>

它将产生以下输出：

PHP Parse error:  syntax error, unexpected token "namespace", 
expecting "," or ";" in /home/cg/root/67771/main.php on line 4

上述错误消息清楚地表明，只有“declare 语句”允许出现在命名空间声明之前。

<?php
   declare (strict_types=1);
   namespace myspace;
   function hello() {
      echo "Hello World";
   }
   use myspace;
   myspace\hello();
?>

相对命名空间

可以通过使用相对命名空间路径来访问当前命名空间中的对象，例如函数、类和常量。

在下面的示例中，“b.php”包含一个命名空间 space1\myspace，其中包含一个 hello() 函数和一个 TEMP 常量。“a.php”中也定义了相同命名空间 space1 中的对象。

显然，当“b.php”包含在“a.php”中时，“myspace”是“space1”的子空间。因此，通过在其前面加上其相对命名空间（也包括 TEMP 常量）来调用“myspace”中的 hello()。

b.php

<?php
   namespace space1\myspace;
   const TEMP = 10;
   function hello() {
      echo "Hello from current namespace:" . __NAMESPACE__ . ;
   }
?>

a.php

<?php
   namespace space1;
   include 'b.php';
   function hello() {
      echo "Hello from current namespace:" . __NAMESPACE__ . ;
   }
   const TEMP = 100;
   hello();            // current namespace
   myspace\hello();   // sub namespace

   echo "TEMP : " . TEMP . " in " . __NAMESPACE__ . ;
   echo "TEMP : " . myspace\TEMP  . " \\in space1\\myspace\n";
?>

它将产生以下输出：

Hello from current namespace:space1
Hello from current namespace:space1\myspace
TEMP : 100 in space1
TEMP : 10 in space1\myspace

绝对命名空间

您还可以通过添加绝对命名空间路径来访问任何命名空间中的函数/常量。例如，“b.php”中的 hello() 是“\space\myspace\hello()”。

a.php

<?php
   namespace space1;
   include 'b.php';
   function hello() {
      echo "Hello from current namespace:" . __NAMESPACE__ . ;
   }
   const TEMP = 100;
   \space1\hello();	             //current namespace
   \space1\myspace\hello();	    //sub namespace

   echo "TEMP: " . \space1\TEMP . " in " . __NAMESPACE__ . ;
   echo "TEMP: " . \space1\myspace\TEMP  . " in space1\\myspace\n";
?>

__NAMESPACE__ 是 PHP 中一个预定义的常量，它返回当前命名空间的名称。

命名空间规则

不同命名空间之间出现的函数/类/常量名称冲突是通过遵循以下规则来解决的：

没有命名空间分隔符（/）的命名空间标识符意味着它指的是当前命名空间。这是一个非限定名称。
如果它包含分隔符，例如 myspace\space1，它将解析为 myspace 下的子命名空间 space1。这种类型的命名是相对命名空间。
完全限定命名空间的名称以“\”字符开头。例如，“\myspace”或“\myspace\space1”。
完全限定名称解析为绝对命名空间。例如 \myspace\space1 解析为 myspace\space1 命名空间
如果名称出现在全局命名空间中，则删除“namespace\”前缀。例如，“namespace\space1”解析为 space1。
但是，如果它出现在另一个命名空间内，则处理方式不同。例如，如果 namespace\space1 在 myspace 内，则它等效于“myspace\space1”。
限定名称中名称的第一段根据当前类/命名空间导入表进行转换。
如果没有应用导入规则，则当前命名空间将添加到名称前面。
类名根据类/命名空间导入表进行转换，函数名根据函数导入表进行转换，常量根据常量导入表进行转换。
对于非限定名称，如果没有应用导入规则并且名称引用函数或常量并且代码位于全局命名空间之外，则在运行时解析名称。首先它从当前命名空间查找函数，然后尝试查找并调用全局函数。

打印页面