命名空间适用于 (PHP 5 >= 5.3.0, PHP 7)
使用命名空间基础
PHP 命名空间类似于文件系统,
在文件系统中访问一个文件有三种方式:
- 相对文件名形式如foo.txt。它会被解析为 currentdirectory/foo.txt,其中 currentdirectory 表示当前目录。因此如果当前目录是 /home/foo,则该文件名被解析为/home/foo/foo.txt。
- 相对路径名形式如subdirectory/foo.txt。它会被解析为 currentdirectory/subdirectory/foo.txt。
- 绝对路径名形式如/main/foo.txt。它会被解析为/main/foo.txt。
PHP 命名空间中的元素使用同样的原理。例如,类名可以通过三种方式引用:
- 非限定名称,或不包含前缀的类名称,例如 $a=new foo(); 或 foo::staticmethod();。如果当前命名空间是 currentnamespace,foo 将被解析为currentnamespacefoo。如果使用 foo 的代码是全局的,不包含在任何命名空间中的代码,则 foo 会被解析为foo。 警告:如果命名空间中的函数或常量未定义,则该非限定的函数名称或常量名称会被解析为全局函数名称或常量名称。
- 限定名称,或包含前缀的名称,例如 $a = new subnamespacefoo(); 或 subnamespacefoo::staticmethod();。如果当前的命名空间是currentnamespace,则 foo 会被解析为 currentnamespacesubnamespacefoo。如果使用 foo 的代码是全局的,不包含在任何命名空间中的代码,foo 会被解析为subnamespacefoo。
- 完全限定名称,或包含了全局前缀操作符的名称,例如, $a = new currentnamespacefoo(); 或 currentnamespacefoo::staticmethod();。在这种情况下,foo 总是被解析为代码中的文字名(literal name)currentnamespacefoo。
定义命名空间
虽然任意合法的PHP代码都可以包含在命名空间中,但只有以下类型的代码受命名空间的影响,
它们是:
- 类(包括抽象类和traits)
- 接口
- 函数
- 常量
命名空间通过关键字 namespace 来声明。如果一个文件中包含命名空间,它必须在其它所有代码之前声明命名空间,除了一个以外:declare关键字。
<html>
<?php
namespace MyProject; // 致命错误 - 命名空间必须是程序脚本的第一条语句
?>
Example 声明单个命名空间
<?php namespace MyProject; const CONNECT_OK = 1; class Connection { /* ... */ } function connect() { /* ... */ } ?>
在同一个文件中定义多个命名空间
定义多个命名空间,推荐用大括号语法
<?php namespace MyProject { const CONNECT_OK = 1; class Connection { /* ... */ } function connect() { /* ... */ } } namespace AnotherProject { const CONNECT_OK = 1; class Connection { /* ... */ } function connect() { /* ... */ } } ?>
在实际的编程实践中,非常不提倡在同一个文件中定义多个命名空间。这种方式的主要用于将多个 PHP 脚本合并在同一个文件中。
将全局的非命名空间中的代码与命名空间中的代码组合在一起,只能使用大括号形式的语法。全局代码必须用一个不带名称的 namespace 语句加上大括号括起来,例如:
<?php declare(encoding='UTF-8'); namespace MyProject { const CONNECT_OK = 1; class Connection { /* ... */ } function connect() { /* ... */ } } namespace { // 全局代码 session_start(); $a = MyProjectconnect(); echo MyProjectConnection::start(); } ?>
namespace关键字和__NAMESPACE__常量
常量__NAMESPACE__
的值是包含当前命名空间名称的字符串。
如果不包括在任何命名空间中的代码,则为一个空的字符串。
<?php namespace MyProject; echo '"', __NAMESPACE__, '"'; // 输出 "MyProject" ?>
<?php
echo '"', __NAMESPACE__, '"'; // 输出 ""
?>
关键字 namespace 可用来显式访问当前命名空间或子命名空间中的元素。它等价于类中的 self 操作符。
<?php namespace MyProject; use blahlah as mine; // see "Using namespaces: importing/aliasing" blahmine(); // calls function MyProjectlahmine() namespacelahmine(); // calls function MyProjectlahmine() namespacefunc(); // calls function MyProjectfunc() namespacesubfunc(); // calls function MyProjectsubfunc() namespacecname::method(); // calls static method "method" of class MyProjectcname $a = new namespacesubcname(); // instantiates object of class MyProjectsubcname $b = namespaceCONSTANT; // assigns value of constant MyProjectCONSTANT to $b ?>
使用命名空间:别名/导入
允许通过别名引用或导入外部的完全限定名称,是命名空间的一个重要特征。这有点类似于在类 unix 文件系统中可以创建对其它的文件或目录的符号连接。
在PHP中,别名是通过操作符 use 来实现的.
<?php use MyFullClassname as Another, MyFullNSname; $obj = new Another; // 实例化 MyFullClassname 对象 NSnamesubnsfunc(); // 调用函数 MyFullNSnamesubnsfunc ?>
全局空间
如果没有定义任何命名空间,所有的类与函数的定义都是在全局空间,与 PHP 引入命名空间概念前一样。在名称前加上前缀 表示该名称是全局空间中的名称,即使该名称位于其它的命名空间中时也是如此。
<?php namespace ABC; /* 这个函数是 ABCfopen */ function fopen() { /* ... */ $f = fopen(...); // 调用全局的fopen函数 return $f; } ?>
使用命名空间:后备全局函数/常量
在一个命名空间中,当 PHP 遇到一个非限定的类、函数或常量名称时,它使用不同的优先策略来解析该名称。
类名称总是解析到当前命名空间中的名称。因此在访问系统内部或不包含在命名空间中的类名称时,必须使用完全限定名称,
<?php namespace ABC; class Exception extends Exception {} $a = new Exception('hi'); // $a 是类 ABCException 的一个对象 $b = new Exception('hi'); // $b 是类 Exception 的一个对象 $c = new ArrayObject; // 致命错误, 找不到 ABCArrayObject 类 ?>
对于函数和常量来说,如果当前命名空间中不存在该函数或常量,PHP 会退而使用全局空间中的函数或常量。
<?php namespace ABC; const E_ERROR = 45; function strlen($str) { return strlen($str) - 1; } echo E_ERROR, " "; // 输出 "45" echo INI_ALL, " "; // 输出 "7" - 使用全局常量 INI_ALL echo strlen('hi'), " "; // 输出 "1" if (is_array('hi')) { // 输出 "is not array" echo "is array "; } else { echo "is not array "; } ?>
PHP 官方文档: