PHP 命名空間(namespace)

PHP 命名空間(namespace)是在PHP 5.3中加入的，如果你學過C#和Java，那命名空間就不算什麼新事物。不過在PHP當中還是有著相當重要的意義。

PHP 命名空間可以解決以下兩類問題：

用戶編寫的代碼與PHP內部的類/函數/常量或第三方類/函數/常量之間的名字衝突。
為很長的標識符名稱(通常是為了緩解第一類問題而定義的)創建一個別名（或簡短）的名稱，提高源代碼的可讀性。

定義命名空間

默認情況下，所有常量、類和函數名都放在全局空間下，就和PHP支持命名空間之前一樣。

命名空間通過關鍵字namespace 來聲明。如果一個文件中包含命名空間，它必須在其它所有代碼之前聲明命名空間。語法格式如下；

< ?php  
// 定义代码在 'MyProject' 命名空间中  
namespace MyProject;  
 
// ... 代码 ...

你也可以在同一個文件中定義不同的命名空間代碼，如：

< ?php  
namespace MyProject1;  
// MyProject1 命名空间中的PHP代码  
 
namespace MyProject2;  
// MyProject2 命名空间中的PHP代码    
 
// 另一种语法
namespace MyProject3 {  
 // MyProject3 命名空间中的PHP代码    
}  
?>

在聲明命名空間之前唯一合法的代碼是用於定義源文件編碼方式的declare 語句。所有非PHP 代碼包括空白符都不能出現在命名空間的聲明之前。

<?php
declare(encoding='UTF-8'); //定义多个命名空间和不包含在命名空间中的代码
namespace MyProject {

const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */  }
}

namespace { // 全局代码
session_start();
$a = MyProject\connect();
echo MyProject\Connection::start();
}
?>

以下代碼會出現語法錯誤：

<html>
<?php
namespace MyProject; // 命名空间前出现了“<html>” 会致命错误 -　命名空间必须是程序脚本的第一条语句
?>

子命名空間

與目錄和文件的關係很像，PHP 命名空間也允許指定層次化的命名空間的名稱。因此，命名空間的名字可以使用分層次的方式定義：

<?php
namespace MyProject\Sub\Level;  //声明分层次的单个命名空间

const CONNECT_OK = 1;
class Connection { /* ... */ }
function Connect() { /* ... */  }

?>

上面的例子創建了常量MyProject\Sub\Level\CONNECT_OK，類MyProject\Sub\Level\Connection 和函數MyProject\Sub\Level\Connect。

命名空間使用

PHP 命名空間中的類名可以通過三種方式引用：

非限定名稱，或不包含前綴的類名稱，例如$a=new foo();或foo::staticmethod();。如果當前命名空間是currentnamespace，foo 將被解析為currentnamespace\foo。如果使用foo 的代碼是全局的，不包含在任何命名空間中的代碼，則foo 會被解析為foo。警告：如果命名空間中的函數或常量未定義，則該非限定的函數名稱或常量名稱會被解析為全局函數名稱或常量名稱。
限定名稱,或包含前綴的名稱，例如$a = new subnamespace\foo();或subnamespace\foo::staticmethod();。如果當前的命名空間是currentnamespace，則foo 會被解析為currentnamespace\subnamespace\foo。如果使用foo 的代碼是全局的，不包含在任何命名空間中的代碼，foo 會被解析為subnamespace\foo。
完全限定名稱，或包含了全局前綴操作符的名稱，例如， $a = new \currentnamespace\foo();或\currentnamespace\foo::staticmethod();。在這種情況下，foo 總是被解析為代碼中的文字名(literal name)currentnamespace\foo。

下面是一個使用這三種方式的實例：

file1.php 文件代碼

<?php
namespace Foo\Bar\subnamespace; 

const FOO = 1;
function foo() {}
class foo
{
    static function staticmethod() {}
}
?>

file2.php 文件代碼

<?php
namespace Foo\Bar;
include 'file1.php';

const FOO = 2;
function foo() {}
class foo
{
    static function staticmethod() {}
}

/* 非限定名称 */
foo(); // 解析为 Foo\Bar\foo resolves to function Foo\Bar\foo
foo::staticmethod(); // 解析为类 Foo\Bar\foo的静态方法staticmethod。resolves to class Foo\Bar\foo, method staticmethod
echo FOO; // resolves to constant Foo\Bar\FOO

/* 限定名称 */
subnamespace\foo(); // 解析为函数 Foo\Bar\subnamespace\foo
subnamespace\foo::staticmethod(); // 解析为类 Foo\Bar\subnamespace\foo,
                                  // 以及类的方法 staticmethod
echo subnamespace\FOO; // 解析为常量 Foo\Bar\subnamespace\FOO
                                  
/* 完全限定名称 */
\Foo\Bar\foo(); // 解析为函数 Foo\Bar\foo
\Foo\Bar\foo::staticmethod(); // 解析为类 Foo\Bar\foo, 以及类的方法 staticmethod
echo \Foo\Bar\FOO; // 解析为常量 Foo\Bar\FOO
?>

注意訪問任意全局類、函數或常量，都可以使用完全限定名稱，例如\strlen() 或\Exception 或\INI_ALL。

在命名空間內部訪問全局類、函數和常量：

<?php
namespace Foo;

function strlen() {}
const INI_ALL = 3;
class Exception {}

$a = \strlen('hi'); // 调用全局函数strlen
$b = \INI_ALL; // 访问全局常量 INI_ALL
$c = new \Exception('error'); // 实例化全局类 Exception
?>

命名空間和動態語言特徵

PHP 命名空間的實現受到其語言自身的動態特徵的影響。因此，如果要將下面的代碼轉換到命名空間中，動態訪問元素。

example1.php 文件代碼：

<?php
class classname
{
    function __construct()
    {
        echo __METHOD__,"\n";
    }
}
function funcname()
{
    echo __FUNCTION__,"\n";
}
const constname = "global";

$a = 'classname';
$obj = new $a; // prints classname::__construct
$b = 'funcname';
$b(); // prints funcname
echo constant('constname'), "\n"; // prints global
?>

必須使用完全限定名稱（包括命名空間前綴的類名稱）。注意因為在動態的類名稱、函數名稱或常量名稱中，限定名稱和完全限定名稱沒有區別，因此其前導的反斜杠是不必要的。

動態訪問命名空間的元素

<?php
namespace namespacename;
class classname
{
    function __construct()
    {
        echo __METHOD__,"\n";
    }
}
function funcname()
{
    echo __FUNCTION__,"\n";
}
const constname = "namespaced";

include 'example1.php';

$a = 'classname';
$obj = new $a; // prints classname::__construct
$b = 'funcname';
$b(); // prints funcname
echo constant('constname'), "\n"; // prints global

/* note that if using double quotes, "\\namespacename\\classname" must be used */
$a = '\namespacename\classname';
$obj = new $a; // prints namespacename\classname::__construct
$a = 'namespacename\classname';
$obj = new $a; // also prints namespacename\classname::__construct
$b = 'namespacename\funcname';
$b(); // prints namespacename\funcname
$b = '\namespacename\funcname';
$b(); // also prints namespacename\funcname
echo constant('\namespacename\constname'), "\n"; // prints namespaced
echo constant('namespacename\constname'), "\n"; // also prints namespaced
?>

namespace關鍵字和NAMESPACE常量

PHP支持兩種抽象的訪問當前命名空間內部元素的方法，__NAMESPACE__ 魔術常量和namespace關鍵字。

常量__NAMESPACE__的值是包含當前命名空間名稱的字符串。在全局的，不包括在任何命名空間中的代碼，它包含一個空的字符串。

__NAMESPACE__ 示例, 在命名空間中的代碼

<?php
namespace MyProject;

echo '"', __NAMESPACE__, '"'; // 输出 "MyProject"
?>

__NAMESPACE__ 示例，全局代碼

<?php

echo '"', __NAMESPACE__, '"'; // 输出 ""
?>

常量__NAMESPACE__ 在動態創建名稱時很有用，例如：

使用__NAMESPACE__動態創建名稱

<?php
namespace MyProject;

function get($classname)
{
    $a = __NAMESPACE__ . '\\' . $classname;
    return new $a;
}
?>

關鍵字namespace 可用來顯式訪問當前命名空間或子命名空間中的元素。它等價於類中的self 操作符。

namespace操作符，命名空間中的代碼

<?php
namespace MyProject;

use blah\blah as mine; // see "Using namespaces: importing/aliasing"

blah\mine(); // calls function blah\blah\mine()
namespace\blah\mine(); // calls function MyProject\blah\mine()

namespace\func(); // calls function MyProject\func()
namespace\sub\func(); // calls function MyProject\sub\func()
namespace\cname::method(); // calls static method "method" of class MyProject\cname
$a = new namespace\sub\cname(); // instantiates object of class MyProject\sub\cname
$b = namespace\CONSTANT; // assigns value of constant MyProject\CONSTANT to $b
?>

namespace操作符, 全局代碼

<?php

namespace\func(); // calls function func()
namespace\sub\func(); // calls function sub\func()
namespace\cname::method(); // calls static method "method" of class cname
$a = new namespace\sub\cname(); // instantiates object of class sub\cname
$b = namespace\CONSTANT; // assigns value of constant CONSTANT to $b
?>

使用命名空間：別名/導入

PHP 命名空間支持有兩種使用別名或導入方式：為類名稱使用別名，或為命名空間名稱使用別名。注意PHP不支持導入函數或常量。

在PHP中，別名是通過操作符use 來實現的. 下面是一個使用所有可能的三種導入方式的例子：

1、使用use操作符導入/使用別名

<?php
namespace foo;
use My\Full\Classname as Another;

// 下面的例子与 use My\Full\NSname as NSname 相同
use My\Full\NSname;

// 导入一个全局类
use \ArrayObject;

$obj = new namespace\Another; // 实例化 foo\Another 对象
$obj = new Another; // 实例化 My\Full\Classname　对象
NSname\subns\func(); // 调用函数 My\Full\NSname\subns\func
$a = new ArrayObject(array(1)); // 实例化 ArrayObject 对象
// 如果不使用 "use \ArrayObject" ，则实例化一个 foo\ArrayObject 对象
?>

2、一行中包含多個use語句

<?php
use My\Full\Classname as Another, My\Full\NSname;

$obj = new Another; // 实例化 My\Full\Classname 对象
NSname\subns\func(); // 调用函数 My\Full\NSname\subns\func
?>

導入操作是在編譯執行的，但動態的類名稱、函數名稱或常量名稱則不是。

3、導入和動態名稱

<?php
use My\Full\Classname as Another, My\Full\NSname;

$obj = new Another; // 实例化一个 My\Full\Classname 对象
$a = 'Another';
$obj = new $a;      // 实际化一个 Another 对象
?>

另外，導入操作只影響非限定名稱和限定名稱。完全限定名稱由於是確定的，故不受導入的影響。

4、導入和完全限定名稱

<?php
use My\Full\Classname as Another, My\Full\NSname;

$obj = new Another; // instantiates object of class My\Full\Classname
$obj = new \Another; // instantiates object of class Another
$obj = new Another\thing; // instantiates object of class My\Full\Classname\thing
$obj = new \Another\thing; // instantiates object of class Another\thing
?>

使用命名空間：後備全局函數/常量

在一個命名空間中，當PHP 遇到一個非限定的類、函數或常量名稱時，它使用不同的優先策略來解析該名稱。類名稱總是解析到當前命名空間中的名稱。因此在訪問系統內部或不包含在命名空間中的類名稱時，必須使用完全限定名稱，例如：

1、在命名空間中訪問全局類

<?php
namespace A\B\C;
class Exception extends \Exception {}

$a = new Exception('hi'); // $a 是类 A\B\C\Exception 的一个对象
$b = new \Exception('hi'); // $b 是类 Exception 的一个对象

$c = new ArrayObject; // 致命错误, 找不到 A\B\C\ArrayObject 类
?>

對於函數和常量來說，如果當前命名空間中不存在該函數或常量，PHP 會退而使用全局空間中的函數或常量。

2、命名空間中後備的全局函數/常量

<?php
namespace A\B\C;

const E_ERROR = 45;
function strlen($str)
{
    return \strlen($str) - 1;
}

echo E_ERROR, "\n"; // 输出 "45"
echo INI_ALL, "\n"; // 输出 "7" - 使用全局常量 INI_ALL

echo strlen('hi'), "\n"; // 输出 "1"
if (is_array('hi')) { // 输出 "is not array"
    echo "is array\n";
} else {
    echo "is not array\n";
}
?>

全局空間

如果沒有定義任何命名空間，所有的類與函數的定義都是在全局空間，與PHP 引入命名空間概念前一樣。在名稱前加上前綴\ 表示該名稱是全局空間中的名稱，即使該名稱位於其它的命名空間中時也是如此。

使用全局空間說明

<?php
namespace A\B\C;

/* 这个函数是 A\B\C\fopen */
function fopen() { 
     /* ... */
     $f = \fopen(...); // 调用全局的fopen函数
     return $f;
} 
?>

命名空間的順序

自從有了命名空間之後，最容易出錯的該是使用類的時候，這個類的尋找路徑是什麼樣的了。

<?php
namespace A;
use B\D, C\E as F;

// 函数调用

foo();      // 首先尝试调用定义在命名空间"A"中的函数foo()
            // 再尝试调用全局函数 "foo"

\foo();     // 调用全局空间函数 "foo" 

my\foo();   // 调用定义在命名空间"A\my"中函数 "foo" 

F();        // 首先尝试调用定义在命名空间"A"中的函数 "F" 
            // 再尝试调用全局函数 "F"

// 类引用

new B();    // 创建命名空间 "A" 中定义的类 "B" 的一个对象
            // 如果未找到，则尝试自动装载类 "A\B"

new D();    // 使用导入规则，创建命名空间 "B" 中定义的类 "D" 的一个对象
            // 如果未找到，则尝试自动装载类 "B\D"

new F();    // 使用导入规则，创建命名空间 "C" 中定义的类 "E" 的一个对象
            // 如果未找到，则尝试自动装载类 "C\E"

new \B();   // 创建定义在全局空间中的类 "B" 的一个对象
            // 如果未发现，则尝试自动装载类 "B"

new \D();   // 创建定义在全局空间中的类 "D" 的一个对象
            // 如果未发现，则尝试自动装载类 "D"

new \F();   // 创建定义在全局空间中的类 "F" 的一个对象
            // 如果未发现，则尝试自动装载类 "F"

// 调用另一个命名空间中的静态方法或命名空间函数

B\foo();    // 调用命名空间 "A\B" 中函数 "foo"

B::foo();   // 调用命名空间 "A" 中定义的类 "B" 的 "foo" 方法
            // 如果未找到类 "A\B" ，则尝试自动装载类 "A\B"

D::foo();   // 使用导入规则，调用命名空间 "B" 中定义的类 "D" 的 "foo" 方法
            // 如果类 "B\D" 未找到，则尝试自动装载类 "B\D"

\B\foo();   // 调用命名空间 "B" 中的函数 "foo" 

\B::foo();  // 调用全局空间中的类 "B" 的 "foo" 方法
            // 如果类 "B" 未找到，则尝试自动装载类 "B"

// 当前命名空间中的静态方法或函数

A\B::foo();   // 调用命名空间 "A\A" 中定义的类 "B" 的 "foo" 方法
              // 如果类 "A\A\B" 未找到，则尝试自动装载类 "A\A\B"

\A\B::foo();  // 调用命名空间 "A\B" 中定义的类 "B" 的 "foo" 方法
              // 如果类 "A\B" 未找到，则尝试自动装载类 "A\B"
?>

名稱解析遵循下列規則：

對完全限定名稱的函數，類和常量的調用在編譯時解析。例如new \A\B解析為類A\B 。
所有的非限定名稱和限定名稱（非完全限定名稱）根據當前的導入規則在編譯時進行轉換。例如，如果命名空間A\B\C被導入為C ，那麼對C\D\e()的調用就會被轉換為A\B\C\D\e() 。
在命名空間內部，所有的沒有根據導入規則轉換的限定名稱均會在其前面加上當前的命名空間名稱。例如，在命名空間A\B內部調用C\D\e() ，則C\D\e()會被轉換為A\B\C\D\e() 。
非限定類名根據當前的導入規則在編譯時轉換（用全名代替短的導入名稱）。例如，如果命名空間A\B\C導入為C，則new C()被轉換為new A\B\C() 。
在命名空間內部（例如A\B），對非限定名稱的函數調用是在運行時解析的。例如對函數foo()的調用是這樣解析的：
1. 在當前命名空間中查找名為A\B\foo()的函數
2. 嘗試查找並調用全局(global)空間中的函數foo() 。
在命名空間（例如A\B ）內部對非限定名稱或限定名稱類（非完全限定名稱）的調用是在運行時解析的。下面是調用new C()及new D\E()的解析過程： new C()的解析:
1. 在當前命名空間中查找A\B\C類。
2. 嘗試自動裝載類A\B\C 。
new D\E()的解析:
1. 在類名稱前面加上當前命名空間名稱變成： A\B\D\E ，然後查找該類。
2. 嘗試自動裝載類A\B\D\E 。
為了引用全局命名空間中的全局類，必須使用完全限定名稱new \C() 。

上一頁： PHP魔術變量

下一頁： PHP PDO

PHP 教程

PHP 表單

PHP 高級教程

PHP 7 新特性

PHP 數據庫

PHP XML

PHP & AJAX

PHP 參考手冊

PHP 命名空間(namespace)

定義命名空間

子命名空間

命名空間使用

命名空間和動態語言特徵

namespace關鍵字和NAMESPACE常量

使用命名空間：別名/導入

使用命名空間：後備全局函數/常量

全局空間

命名空間的順序

PHP 教程

PHP 表單

PHP 高級教程

PHP 7 新特性

PHP 數據庫

PHP XML

PHP & AJAX

PHP 參考手冊

PHP 命名空間(namespace)

定義命名空間

子命名空間

命名空間使用

命名空間和動態語言特徵

namespace關鍵字和__NAMESPACE__常量

使用命名空間：別名/導入

使用命名空間：後備全局函數/常量

全局空間

命名空間的順序

namespace關鍵字和NAMESPACE常量