PHP 命名空間

什麼是命名空間？

從廣義來說，命名空間是一種封裝事物的方法。在很多地方都可以看到這種抽象概念。

例如，在作業系統中目錄用來將相關檔案分組，對於目錄中的檔案來說，它就扮演了命名空間的角色。

具體舉個例子，檔案 foo.txt 可以同時在目錄/home/greg 和 /home/other 中存在，但在同一個目錄中不能存在兩個 foo.txt 檔案。

另外，當目錄 /home/greg 外存取 foo.txt 檔案時，我們必須將目錄名稱以及目錄分隔符號放在檔案名稱之前得到 /home/greg/foo.txt。這個原理應用在程式設計領域就是命名空間的概念。

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

PHP命名空間的作用

命名空間一個最明確的目的就是解決重名問題，PHP不允許兩個函數或者類別出現相同的名字，否則會產生一個致命的錯誤。這種情況只要避免命名重複就可以解決，最常見的做法就是約定一個前綴。

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

1.使用者寫的程式碼與PHP內部的類別/函數/常數或第三方類別/函數/常量之間的名字衝突。

2.為很長的識別碼名稱(通常是為了緩解第一類問題而定義的)創建一個別名（或簡短）的名稱，提高原始程式碼的可讀性。

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 命名空間中的類別名稱可以用三種方式引用：

1. 非限定名稱，或不包含前綴的類別名稱，例如$a=new foo(); 或foo:: staticmethod();。如果目前命名空間是 currentnamespace，foo 將會解析為 currentnamespace\foo。如果使用 foo 的程式碼是全域的，不包含在任何命名空間中的程式碼，則 foo 會被解析為foo。警告：如果命名空間中的函數或常數未定義，則該非限定的函數名稱或常數名稱會被解析為全域函數名稱或常數名稱。

2. 限定名稱,或包含前綴的名稱，例如 $a = new subnamespace\foo(); 或 subnamespace\foo::staticmethod();。如果目前的命名空間是 currentnamespace，則 foo 會被解析為 currentnamespace\subnamespace\foo。如果使用 foo 的程式碼是全域性的，不包含在任何命名空間中的程式碼，foo 會被解析為subnamespace\foo。

3. 完全限定名稱，或包含了全域前綴運算子的名稱，例如， $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"
?>

名稱解析遵循下列規則：

1.對完全限定名稱的函數，類別和常數的呼叫在編譯時解析。例如 new \A\B 解析為類別 A\B。

2.所有的非限定名稱和限定名稱（非完全限定名稱）根據目前的導入規則在編譯時進行轉換。例如，如果命名空間A\B\C 被導入為 C，那麼對 C\D\e() 的呼叫就會轉換為 A\B\C\D\e()。

3.在命名空間內部，所有的沒有根據導入規則轉換的限定名稱都會在其前面加上目前的命名空間名稱。例如，在命名空間 A\B 內部呼叫 C\D\e()，則 C\D\e() 會轉換為 A\B\C\D\e() 。

4.非限定類別名稱根據目前的導入規則在編譯時轉換（以全名取代短的導入名稱）。例如，如果命名空間A\B\C 導入為C，則 new C() 轉換為 new A\B\C() 。

5.在命名空間內部（例如A\B），對非限定名稱的函數呼叫是在執行時間解析的。例如對函數foo() 的呼叫是這樣解析的：

a.在目前命名空間中尋找名為A\B\foo() 的函數

b.嘗試尋找並呼叫全域(global) 空間中的函數foo()。

6.在命名空間（例如A\B）內部對非限定名稱或限定名稱類別（非完全限定名稱）的呼叫是在執行時間解析的。以下是呼叫new C() 及new D\E() 的解析過程：new C()的解析: new D\E()的解析:為了引用全域命名空間中的全域類，必須使用完全限定名稱new \C()。

a.在類別名稱前面加上目前命名空間名稱變成：A\B\D\E，然後尋找該類別。

b.嘗試自動裝載類別 A\B\D\E。

c.在目前命名空間中尋找A\B\C類別。

d.嘗試自動裝載類別A\B\C。

PHP 命名空間

PHP中文網