一、簡介
什麼是命名空間?從廣義上來說,命名空間是一種封裝事物的方法。例如,在操作系統中目錄用來將相關文件分組,對於目錄中的文件來說,目錄就扮演了命名空間的角色。
而在PHP當中,命名空間就扮演了目錄的角色,而PHP代碼中的類(包括抽象類和traits)、接口、函數和常量則就扮演了文件的角色。
PHP 中的命名空間(namespace)是在PHP 5.3中加入的,主要是爲了解決用戶編寫的代碼與PHP內部的類/函數/常量或第三方類/函數/常量之間的名字衝突。其作用是按照一種虛擬的層次結構組織PHP代碼,這種層次結構類似操作系統中文件系統的目錄結構。現代的PHP組件和框架都放在各自全局唯一的廠商命名空間中,以免與其他廠商使用常見類名衝突。
二、命名空間的定義
默認情況下,所有常量、類和函數名都放在全局空間下,就和PHP支持命名空間之前一樣。
1、聲明命名空間
命名空間通過關鍵字namespace 來聲明。如果一個文件中包含命名空間,它必須在其它所有代碼之前聲明命名空間,除了一個以外:declare關鍵字。語法格式如下;
< ?php
// 定義代碼在 'MyProject' 命名空間中
namespace MyProject;
另外,與PHP其它的語言特徵不同,同一個命名空間可以定義在多個文件中,即允許將同一個命名空間的內容分割存放在不同的文件中。
你也可以在同一個文件中定義不同的命名空間代碼,但非常不提倡這一種做法。
2、聲明子命名空間
與目錄和文件的關係很象,PHP 命名空間也允許指定層次化的命名空間的名稱。因此,命名空間的名字可以使用分層次的方式定義:
<?php
namespace MyProject\Sub\Level;
三、命名空間的使用
在討論如何使用命名空間之前,必須瞭解 PHP 是如何知道要使用哪一個命名空間中的元素的。可以將 PHP 命名空間與文件系統作一個簡單的類比。在文件系統中訪問一個文件有三種方式:
1)相對文件名形式如foo.txt。它會被解析爲 currentdirectory/foo.txt,其中 currentdirectory 表示當前目錄。因此如果當前目錄是 /home/foo,則該文件名被解析爲/home/foo/foo.txt。
2)相對路徑名形式如subdirectory/foo.txt。它會被解析爲 currentdirectory/subdirectory/foo.txt。
3)絕對路徑名形式如/main/foo.txt。它會被解析爲/main/foo.txt。
PHP 命名空間中的元素使用同樣的原理。例如,類名可以通過三種方式引用:
1、Unqualified name(非限定名稱)
名稱中不包含命名空間分隔符的標識符。
例如:$a=new foo();
或foo::staticmethod();
。如果當前命名空間是currentnamespace,foo 將被解析爲currentnamespace\foo
。如果使用 foo 的代碼是全局的,不包含在任何命名空間中的代碼,則 foo 會被解析爲foo
。
警告:對於函數和常量來說,如果當前命名空間中不存在該函數或常量,PHP 會退而使用全局空間中的函數或常量。
2、Qualified name(限制名稱)
名稱中含有命名空間分隔符的標識符。
例如:$a = new subnamespace\foo();
或subnamespace\foo::staticmethod();
。如果當前的命名空間是currentnamespace,則 foo 會被解析爲currentnamespace\subnamespace\foo
。如果使用 foo 的代碼是全局的,不包含在任何命名空間中的代碼,foo 會被解析爲subnamespace\foo
。
3、Fully qualified name(完全限制名稱)
名稱中包含命名空間分隔符,並以命名空間分隔符開始的標識符,例如\Foo\Bar
。namespace\Foo
也是一個完全限定名稱。
例如:$a = new \currentnamespace\foo();
或\currentnamespace\foo::staticmethod();
。在這種情況下,foo 總是被解析爲代碼中的文字名(literal name)currentnamespace\foo
。
官方例子:
file1.php 文件代碼:
namespace Foo\Bar\subnamespace;
const FOO = 1;
function foo(){}
class foo{
static function staticmethod(){}
}
file2.php文件代碼:
namespace Foo\Bar;
include 'file1.php';
const FOO = 2;
function foo(){}
class foo{
static function staticmethod(){}
}
/* 非限定名稱 */
foo(); // 解析爲函數: Foo\Bar\foo
foo::staticmethod(); // 解析爲類 Foo\Bar\foo的靜態方法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版本支持三種別名或導入方式:爲類名稱使用別名、爲接口使用別名或爲命名空間名稱使用別名。PHP 5.6開始允許導入函數或常量或者爲它們設置別名。
1、使用use操作符導入/使用別名
<?php
namespace foo;
use My\Full\Classname as Another;
// 下面的例子與 use My\Full\NSname as NSname 相同
use My\Full\NSname;
// 導入一個全局類
use ArrayObject;
// 導入一個函數 importing a function (PHP 5.6+)
use function My\Full\functionName;
// 爲一個函數設置別名 aliasing a function (PHP 5.6+)
use function My\Full\functionName as func;
// 導入一個常量 importing a constant (PHP 5.6+)
use const My\Full\CONSTANT;
$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 對象
func(); // calls function My\Full\functionName
echo CONSTANT; // echoes the value of My\Full\CONSTANT
?>
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
?>
爲了代碼更易於閱讀和糾錯,不推薦使用以上語法,建議一行寫一個use語句。
五、注意事項
如果一個文件中包含命名空間,它必須在其它所有代碼之前聲明命名空間。除了一個以外:declare關鍵字。
雖然任意合法的PHP代碼都可以包含在命名空間中,但只有以下類型的代碼受命名空間的影響,它們是:類(包括抽象類和traits)、接口、函數和常量。
PHP支持兩種抽象的訪問當前命名空間內部元素的方法,__NAMESPACE__魔術常量和namespace關鍵字。
常量__NAMESPACE__的值是包含當前命名空間名稱的字符串。在全局的,不包括在任何命名空間中的代碼,它包含一個空的字符串。關鍵字namespace可用來顯式訪問當前命名空間或子命名空間中的元素。它等價於類中的self操作符。
PHP命名空間與操作系統的物理文件系統不同,這是一個虛擬概念,沒必要和文件系統中的目錄結構完全對應。雖然如此,但是大多數PHP組件爲了兼容廣泛使用的PSR-4自動加載器標準,會把子命名空間放到文件系統的子目錄中。
六、參考
《Modern PHP》Josh Lockhart 著 安道 譯