PHP 命名空間(namespace)
PHP 命名空間(namespace)是在PHP 5.3中加入的
什麼是命名空間?從廣義來說,命名空間是一種封裝事物的方法。在很多地方都可以看到這種抽象概念。例如,在作業(yè)系統(tǒng)中目
錄用來將相關(guān)檔案分組,對於目錄中的檔案來說,它就扮演了命名空間的角色。具體舉個例子,檔案 foo.txt 可以同時在目
錄製/home/greg 和 /home/other 中存在,但在同一個目錄中不能存在兩個 foo.txt 檔案。另外,在目錄 /home/greg 外存取?
foo.txt 檔案時,我們必須將目錄名稱以及目錄分隔符號放在檔案名稱之前得到 /home/greg/foo.txt。這個原理應(yīng)用到程式設(shè)計領(lǐng)域就是
#命名空間的概念。 ?
PHP 命名空間可以解決以下兩個類別問題:
1.??? 使用者所寫的程式碼與PHP內(nèi)部的類別/函數(shù)/常數(shù)或第三方類別/函數(shù)/常數(shù)之間的名字衝突。
2.??? 為很長的識別碼名稱(通常是為了緩解第一類問題而定義的)創(chuàng)建一個別名(或簡短)的名稱,提高原始程式碼的可讀性。
定義命名空間
預(yù)設(shè)情況下,所有常數(shù)、類和函數(shù)名都放在全域空間下,就跟PHP支援命名空間之前一樣。
命名空間透過關(guān)鍵字namespace 來宣告。如果一個檔案中包含命名空間,它必須在其它所有程式碼之前聲明命名空間。
語法格式如下:
<?php // 定義代碼在 'MyProject' 命名空間中 namespace MyProject; // ... 代碼 ... ?> 你也可以在同一個文件中定義不同的命名空間代碼,如: <?php namespace MyProject1; // MyProject1 命名空間中的PHP代碼 namespace MyProject2; // MyProject2 命名空間中的PHP代碼 // 另一種語法 namespace MyProject3 { // MyProject3 命名空間中的PHP代碼 } ?>
在宣告命名空間之前唯一合法的程式碼是用來定義原始檔編碼方式的 declare 語句。另外,所有非PHP 程式碼包含空白符都不能出現(xiàn)在命名空間的宣告之前:
<?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; // 命名空間前出現(xiàn)了“<html>” 會致命錯誤 - 命名空間必須是程序腳本的第一條語句 ?>
子命名空間
與目錄和檔案的關(guān)係很像,PHP 命名空間也允許指定層次化的命名空間的名稱。因此,命名空間的名字可以使用分層的方式定義:
<?php namespace MyProject\Sub\Level; //聲明分層次的單個命名空間 const CONNECT_OK = 1; class Connection { /* ... */ } function Connect() { /* ... */ } ?>
上面的範(fàn)例創(chuàng)建了常數(shù)MyProject\Sub\Level\CONNECT_OK,類別MyProject\Sub\Level\Connection 和函數(shù)MyProject\Sub\Level \Connect。
命名空間使用
在討論如何使用命名空間之前,必須先了解 PHP 是如何知道要使用哪一個命名空間中的元素的??梢詫?PHP 命名空間與檔案系統(tǒng)作一個簡單的類比。在檔案系統(tǒng)中存取一個檔案有三種方式:
? ?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.??? 非限定名稱,或不包含前綴的類別名稱,例如$a= new foo(); 或foo::staticmethod();。如果目前命名空間是 currentnamespace,foo 將會解析為 currentnamespace\foo。如果使用 foo 的程式碼是全域的,不包含在任何命名空間中的程式碼,則 foo 會被解析為foo。 警告:如果命名空間中的函數(shù)或常數(shù)未定義,則該非限定的函數(shù)名稱或常數(shù)名稱會被解析為全域函數(shù)名稱或常數(shù)名稱。
2.??? 限定名稱,或包含前綴的名稱,例如$a = new subnamespace\foo(); 或subnamespace\foo::staticmethod(); 。如果目前的命名空間是 currentnamespace,則 foo 會被解析為 currentnamespace\subnamespace\foo。如果使用 foo 的程式碼是全域性的,不包含在任何命名空間中的程式碼,foo 會被解析為subnamespace\foo。
3.??? 完全限定名稱,或包含了全域前綴運(yùn)算子的名稱,例如, $a = new \currentnamespace\foo(); 或\currentnamespace \foo::staticmethod();。在這種情況下,foo 總是被解析為程式碼中的文字名稱(literal name)currentnamespace\foo。
下面是一個使用這三種方式的實例:
實例
<?php namespace Foo\Bar\subnamespace; const FOO = 1; function foo() {} class foo { static function staticmethod() {} } ?>
實例
<?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的靜態(tài)方法staticmethod。resolves to class Foo\Bar\foo, method staticmethod echo FOO; // resolves to constant Foo\Bar\FOO /* 限定名稱 */ subnamespace\foo(); // 解析為函數(shù) Foo\Bar\subnamespace\foo subnamespace\foo::staticmethod(); // 解析為類 Foo\Bar\subnamespace\foo, // 以及類的方法 staticmethod echo subnamespace\FOO; // 解析為常量 Foo\Bar\subnamespace\FOO /* 完全限定名稱 */ \Foo\Bar\foo(); // 解析為函數(shù) Foo\Bar\foo \Foo\Bar\foo::staticmethod(); // 解析為類 Foo\Bar\foo, 以及類的方法 staticmethod echo \Foo\Bar\FOO; // 解析為常量 Foo\Bar\FOO ?>
注意存取任意全域類別、函數(shù)或常數(shù),都可以使用完全限定名稱,例如\strlen() 或\Exception 或\INI_ALL。
在命名空間內(nèi)部存取全域類別、函數(shù)和常數(shù):
<?php namespace Foo; function strlen() {} const INI_ALL = 3; class Exception {} $a = \strlen('hi'); // 調(diào)用全局函數(shù)strlen $b = \INI_ALL; // 訪問全局常量 INI_ALL $c = new \Exception('error'); // 實例化全局類 Exception ?>
#
命名空間和動態(tài)語言特徵
PHP 命名空間的實現(xiàn)受到其語言本身的動態(tài)特徵的影響。因此,如果要將下面的程式碼轉(zhuǎn)換到命名空間中,動態(tài)存取元素。
實例
<?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 ?>
#?程式執(zhí)行結(jié)果:
classname::__construct funcname global
?必須使用完全限定名稱(包含命名空間前綴的類別名稱)。注意因為在動態(tài)的類別名稱、函數(shù)名稱或常數(shù)名稱中,限定名稱和完全限定名稱沒有區(qū)別,因此其前導(dǎo)的反斜線是不必要的。
實例
#動態(tài)存取命名空間的元素
<?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 ?>
?程式運(yùn)行結(jié)果:
classname::__construct funcname global classname::__construct funcname global namespacename\classname::__construct namespacename\classname::__construct namespacename\funcname namespacename\funcname namespaced namespaced
namespace關(guān)鍵字與__NAMESPACE__常數(shù)
PHP支援兩種抽象的存取目前命名空間內(nèi)部元素的方法,__NAMESPACE__ 魔術(shù)常數(shù)和namespace關(guān)鍵字。
常數(shù)__NAMESPACE__的值是包含目前命名空間名稱的字串。在全域的,不包括在任何命名空間中的程式碼,它包含一個空的字串。
實例
#__NAMESPACE__ 範(fàn)例, 在命名空間中的程式碼
<?php namespace MyProject; header("Content-type:text/html;charset=utf-8"); //設(shè)置編碼 echo '"', __NAMESPACE__, '"'; // 輸出 "MyProject" ?>
程式執(zhí)行結(jié)果:
"MyProject"
實例
__NAMESPACE__ 範(fàn)例,全域程式碼
<?php header("Content-type:text/html;charset=utf-8"); //設(shè)置編碼 echo '"', __NAMESPACE__, '"'; // 輸出 "MyProject" ?>
程式執(zhí)行結(jié)果:
##""
實例
常數(shù)__NAMESPACE__ 在動態(tài)建立名稱時很有用,例如:使用__NAMESPACE__動態(tài)建立名稱<?php namespace MyProject; function get($classname) { $a = __NAMESPACE__ . '\' . $classname; return new $a; } ?>關(guān)鍵字namespace 可用來明確存取目前命名空間或子命名空間中的元素。它等價於類別中的 self 操作符。
實例
namespace運(yùn)算符,命名空間中的程式碼<?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運(yùn)算子, 全域程式碼<?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不支援導(dǎo)入函數(shù)或常數(shù)。
在PHP中,別名是透過運(yùn)算子use 來實現(xiàn)的. 以下是一個使用所有可能的三種導(dǎo)入方式的範(fàn)例:1 、使用use運(yùn)算子導(dǎo)入/使用別名?
<?php
namespace foo;
use My\Full\Classname as Another;
// 下面的例子與 use My\Full\NSname as NSname 相同
use My\Full\NSname;
// 導(dǎo)入一個全局類
use \ArrayObject;
$obj = new namespace\Another; // 實例化 foo\Another 對象
$obj = new Another; // 實例化 My\Full\Classname 對象
NSname\subns\func(); // 調(diào)用函數(shù) 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(); // 調(diào)用函數(shù) My\Full\NSname\subns\func
?>
3、匯入與動態(tài)名稱??
<?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 ?>## ######################使用命名空間:後備全域函數(shù)/常數(shù)##########
在一個命名空間中,當(dāng) PHP 遇到一個非限定的類別、函數(shù)或常數(shù)名稱時,它會使用不同的優(yōu)先策略來解析該名稱。類別名稱總是解析到目前命名空間中的名稱。因此在存取系統(tǒng)內(nèi)部或不包含在命名空間中的類別名稱時,必須使用完全限定名稱
#例如:
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 類 ?>
##對於函數(shù)和常數(shù)來說,如果目前命名空間中不存在該函數(shù)或常數(shù),PHP 會退而使用全域空間中的函數(shù)或常數(shù)。
2、 命名空間中後備的全域函數(shù)/常數(shù)?
<?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"; } ?>
全域空間
如果沒有定義任何命名空間,所有的類別與函數(shù)的定義都是在全域空間,與PHP 引入命名空間概念前一樣。在名稱前加上前綴 \ 表示該名稱是全域空間中的名稱,即使該名稱位於其它的命名空間中也是如此。實例
使用全域空間說明?<?php namespace A\B\C; /* 這個函數(shù)是 A\B\C\fopen */ function fopen() { /* ... */ $f = \fopen(...); // 調(diào)用全局的fopen函數(shù) return $f; } ?>
命名空間的順序
自從有了命名空間之後,最容易出錯的該是使用類別的時候,這個類別的尋找路徑是什麼樣的了。<?php namespace A; use B\D, C\E as F; // 函數(shù)調(diào)用 foo(); // 首先嘗試調(diào)用定義在命名空間"A"中的函數(shù)foo() // 再嘗試調(diào)用全局函數(shù) "foo" \foo(); // 調(diào)用全局空間函數(shù) "foo" my\foo(); // 調(diào)用定義在命名空間"A\my"中函數(shù) "foo" F(); // 首先嘗試調(diào)用定義在命名空間"A"中的函數(shù) "F" // 再嘗試調(diào)用全局函數(shù) "F" // 類引用 new B(); // 創(chuàng)建命名空間 "A" 中定義的類 "B" 的一個對象 // 如果未找到,則嘗試自動裝載類 "A\B" new D(); // 使用導(dǎo)入規(guī)則,創(chuàng)建命名空間 "B" 中定義的類 "D" 的一個對象 // 如果未找到,則嘗試自動裝載類 "B\D" new F(); // 使用導(dǎo)入規(guī)則,創(chuàng)建命名空間 "C" 中定義的類 "E" 的一個對象 // 如果未找到,則嘗試自動裝載類 "C\E" new \B(); // 創(chuàng)建定義在全局空間中的類 "B" 的一個對象 // 如果未發(fā)現(xiàn),則嘗試自動裝載類 "B" new \D(); // 創(chuàng)建定義在全局空間中的類 "D" 的一個對象 // 如果未發(fā)現(xiàn),則嘗試自動裝載類 "D" new \F(); // 創(chuàng)建定義在全局空間中的類 "F" 的一個對象 // 如果未發(fā)現(xiàn),則嘗試自動裝載類 "F" // 調(diào)用另一個命名空間中的靜態(tài)方法或命名空間函數(shù) B\foo(); // 調(diào)用命名空間 "A\B" 中函數(shù) "foo" B::foo(); // 調(diào)用命名空間 "A" 中定義的類 "B" 的 "foo" 方法 // 如果未找到類 "A\B" ,則嘗試自動裝載類 "A\B" D::foo(); // 使用導(dǎo)入規(guī)則,調(diào)用命名空間 "B" 中定義的類 "D" 的 "foo" 方法 // 如果類 "B\D" 未找到,則嘗試自動裝載類 "B\D" \B\foo(); // 調(diào)用命名空間 "B" 中的函數(shù) "foo" \B::foo(); // 調(diào)用全局空間中的類 "B" 的 "foo" 方法 // 如果類 "B" 未找到,則嘗試自動裝載類 "B" // 當(dāng)前命名空間中的靜態(tài)方法或函數(shù) A\B::foo(); // 調(diào)用命名空間 "A\A" 中定義的類 "B" 的 "foo" 方法 // 如果類 "A\A\B" 未找到,則嘗試自動裝載類 "A\A\B" \A\B::foo(); // 調(diào)用命名空間 "A\B" 中定義的類 "B" 的 "foo" 方法 // 如果類 "A\B" 未找到,則嘗試自動裝載類 "A\B" ?>
名稱解析遵循下列規(guī)則:
#1.??? 完全限定名稱的函數(shù),類別和常數(shù)的呼叫在編譯時解析。例如?new \A\B?解析為類別?A\B。 2.??? 所有的非限定名稱和限定名稱(非完全限定名稱)依照目前的導(dǎo)入規(guī)則在編譯時進(jìn)行轉(zhuǎn)換。例如,如果命名空間?A\B\C?被導(dǎo)入為?C,那麼對?C\D\e()?的呼叫就會轉(zhuǎn)換為?A\B\C\D\e()。 3.??? 在命名空間內(nèi)部,所有的沒有根據(jù)導(dǎo)入規(guī)則轉(zhuǎn)換的限定名稱都會在其前面加上目前的命名空間名稱。例如,在命名空間?A\B?內(nèi)部呼叫C\D\e(),則?C\D\e()?會轉(zhuǎn)換為?A\B\C\D\e()?。4.??? 非限定類別名稱依照目前的導(dǎo)入規(guī)則在編譯時轉(zhuǎn)換(以全名取代短的導(dǎo)入名稱)。例如,如果命名空間?A\B\C?導(dǎo)入為C,則?new C()?轉(zhuǎn)換為?new A\B\C()?。
5.??? 在命名空間內(nèi)部(例如A\B),對非限定名稱的函數(shù)呼叫是在執(zhí)行時解析的。例如函數(shù)?foo()?的呼叫是這樣解析的:
1.??? 在目前命名空間中尋找名為?A\B\foo()?的函數(shù)
2.??? 嘗試找出並呼叫全域(global)?空間中的函數(shù)?foo()。
6.??? 在命名空間(例如A\B)內(nèi)部對非限定名稱或限定名稱類別(非完全限定名稱)的呼叫是在執(zhí)行時解析的。以下是呼叫?new C()?及?new D\E()?的解析過程:?new C()的解??析:
1.??? 在目前命名空間尋找A\B\C類別。
2.??? 嘗試自動載入類別A\B\C。
new D\E()的解析:
3.??? 在類別名稱前面加上目前命名空間名稱變成:A\B\D\E,然後尋找該類別。
4.??? 嘗試自動載入類別?A\B\D\E。
為了引用全域命名空間中的全域類,必須使用完全限定名稱?new \C()。