詳細(xì)分析PHP 命名空間(namespace)

更新時(shí)間：2020年06月30日 15:03:20 作者：菜鳥(niǎo)教程

這篇文章主要介紹了PHP 命名空間(namespace)的的相關(guān)資料，文中講解非常詳細(xì)，實(shí)例代碼幫助大家更好的理解和學(xué)習(xí)，感興趣的朋友可以了解下

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

PHP 命名空間可以解決以下兩類(lèi)問(wèn)題：

用戶(hù)編寫(xiě)的代碼與PHP內(nèi)部的類(lèi)/函數(shù)/常量或第三方類(lèi)/函數(shù)/常量之間的名字沖突。
為很長(zhǎng)的標(biāo)識(shí)符名稱(chēng)(通常是為了緩解第一類(lèi)問(wèn)題而定義的)創(chuàng)建一個(gè)別名（或簡(jiǎn)短）的名稱(chēng)，提高源代碼的可讀性。

定義命名空間

默認(rèn)情況下，所有常量、類(lèi)和函數(shù)名都放在全局空間下，就和PHP支持命名空間之前一樣。

命名空間通過(guò)關(guān)鍵字namespace 來(lái)聲明。如果一個(gè)文件中包含命名空間，它必須在其它所有代碼之前聲明命名空間。語(yǔ)法格式如下；

<?php 
// 定義代碼在 'MyProject' 命名空間中 
namespace MyProject; 
 
// ... 代碼 ...

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

<?php 
namespace MyProject;

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

namespace AnotherProject;

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

不建議使用這種語(yǔ)法在單個(gè)文件中定義多個(gè)命名空間。建議使用下面的大括號(hào)形式的語(yǔ)法。

<?php
namespace MyProject {
 const CONNECT_OK = 1;
 class Connection { /* ... */ }
 function connect() { /* ... */ }
}

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

將全局的非命名空間中的代碼與命名空間中的代碼組合在一起，只能使用大括號(hào)形式的語(yǔ)法。全局代碼必須用一個(gè)不帶名稱(chēng)的 namespace 語(yǔ)句加上大括號(hào)括起來(lái)，例如：

<?php
namespace MyProject {

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

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

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

<?php
declare(encoding='UTF-8'); //定義多個(gè)命名空間和不包含在命名空間中的代碼
namespace MyProject {

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

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

以下代碼會(huì)出現(xiàn)語(yǔ)法錯(cuò)誤：

<html>
<?php
namespace MyProject; // 命名空間前出現(xiàn)了“<html>” 會(huì)致命錯(cuò)誤 -　命名空間必須是程序腳本的第一條語(yǔ)句
?>

子命名空間

與目錄和文件的關(guān)系很像，PHP 命名空間也允許指定層次化的命名空間的名稱(chēng)。因此，命名空間的名字可以使用分層次的方式定義：

<?php
namespace MyProject\Sub\Level; //聲明分層次的單個(gè)命名空間

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

?>

上面的例子創(chuàng)建了常量 MyProject\Sub\Level\CONNECT_OK，類(lèi) MyProject\Sub\Level\Connection 和函數(shù) MyProject\Sub\Level\Connect。

命名空間使用

PHP 命名空間中的類(lèi)名可以通過(guò)三種方式引用：

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

下面是一個(gè)使用這三種方式的實(shí)例：

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() {}
}

/* 非限定名稱(chēng) */
foo(); // 解析為函數(shù) Foo\Bar\foo
foo::staticmethod(); // 解析為類(lèi) Foo\Bar\foo ，方法為 staticmethod
echo FOO; // 解析為常量 Foo\Bar\FOO

/* 限定名稱(chēng) */
subnamespace\foo(); // 解析為函數(shù) Foo\Bar\subnamespace\foo
subnamespace\foo::staticmethod(); // 解析為類(lèi) Foo\Bar\subnamespace\foo,
         // 以及類(lèi)的方法 staticmethod
echo subnamespace\FOO; // 解析為常量 Foo\Bar\subnamespace\FOO
         
/* 完全限定名稱(chēng) */
\Foo\Bar\foo(); // 解析為函數(shù) Foo\Bar\foo
\Foo\Bar\foo::staticmethod(); // 解析為類(lèi) Foo\Bar\foo, 以及類(lèi)的方法 staticmethod
echo \Foo\Bar\FOO; // 解析為常量 Foo\Bar\FOO
?>

注意訪(fǎng)問(wèn)任意全局類(lèi)、函數(shù)或常量，都可以使用完全限定名稱(chēng)，例如 \strlen() 或 \Exception 或 \INI_ALL。

在命名空間內(nèi)部訪(fǎng)問(wèn)全局類(lèi)、函數(shù)和常量：

<?php
namespace Foo;

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

$a = \strlen('hi'); // 調(diào)用全局函數(shù)strlen
$b = \INI_ALL; // 訪(fǎng)問(wèn)全局常量 INI_ALL
$c = new \Exception('error'); // 實(shí)例化全局類(lèi) Exception
?>

命名空間和動(dòng)態(tài)語(yǔ)言特征

PHP 命名空間的實(shí)現(xiàn)受到其語(yǔ)言自身的動(dòng)態(tài)特征的影響。因此，如果要將下面的代碼轉(zhuǎn)換到命名空間中，動(dòng)態(tài)訪(fǎng)問(wèn)元素。

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
?>

必須使用完全限定名稱(chēng)（包括命名空間前綴的類(lèi)名稱(chēng)）。注意因?yàn)樵趧?dòng)態(tài)的類(lèi)名稱(chēng)、函數(shù)名稱(chēng)或常量名稱(chēng)中，限定名稱(chēng)和完全限定名稱(chēng)沒(méi)有區(qū)別，因此其前導(dǎo)的反斜杠是不必要的。

動(dòng)態(tài)訪(fǎng)問(wèn)命名空間的元素

<?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; // 輸出 classname::__construct
$b = 'funcname';
$b(); // 輸出函數(shù)名
echo constant('constname'), "\n"; // 輸出 global

/* 如果使用雙引號(hào)，使用方法為 "\\namespacename\\classname"*/
$a = '\namespacename\classname';
$obj = new $a; // 輸出 namespacename\classname::__construct
$a = 'namespacename\classname';
$obj = new $a; // 輸出 namespacename\classname::__construct
$b = 'namespacename\funcname';
$b(); // 輸出 namespacename\funcname
$b = '\namespacename\funcname';
$b(); // 輸出 namespacename\funcname
echo constant('\namespacename\constname'), "\n"; // 輸出 namespaced
echo constant('namespacename\constname'), "\n"; // 輸出 namespaced
?>

namespace關(guān)鍵字和__NAMESPACE__常量

PHP支持兩種抽象的訪(fǎng)問(wèn)當(dāng)前命名空間內(nèi)部元素的方法，__NAMESPACE__ 魔術(shù)常量和namespace關(guān)鍵字。

常量__NAMESPACE__的值是包含當(dāng)前命名空間名稱(chēng)的字符串。在全局的，不包括在任何命名空間中的代碼，它包含一個(gè)空的字符串。

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

<?php
namespace MyProject;

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

__NAMESPACE__ 示例，全局代碼

<?php

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

常量 __NAMESPACE__ 在動(dòng)態(tài)創(chuàng)建名稱(chēng)時(shí)很有用，例如：

使用__NAMESPACE__動(dòng)態(tài)創(chuàng)建名稱(chēng)

<?php
namespace MyProject;

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

關(guān)鍵字 namespace 可用來(lái)顯式訪(fǎng)問(wèn)當(dāng)前命名空間或子命名空間中的元素。它等價(jià)于類(lèi)中的 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
?>

使用命名空間：別名/導(dǎo)入

PHP 命名空間支持有兩種使用別名或?qū)敕绞剑簽轭?lèi)名稱(chēng)使用別名，或?yàn)槊臻g名稱(chēng)使用別名。

在PHP中，別名是通過(guò)操作符 use 來(lái)實(shí)現(xiàn)的. 下面是一個(gè)使用所有可能的三種導(dǎo)入方式的例子：

1、使用use操作符導(dǎo)入/使用別名

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

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

// 導(dǎo)入一個(gè)全局類(lèi)
use \ArrayObject;

$obj = new namespace\Another; // 實(shí)例化 foo\Another 對(duì)象
$obj = new Another; // 實(shí)例化 My\Full\Classname　對(duì)象
NSname\subns\func(); // 調(diào)用函數(shù) My\Full\NSname\subns\func
$a = new ArrayObject(array(1)); // 實(shí)例化 ArrayObject 對(duì)象
// 如果不使用 "use \ArrayObject" ，則實(shí)例化一個(gè) foo\ArrayObject 對(duì)象
?>

2、一行中包含多個(gè)use語(yǔ)句

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

$obj = new Another; // 實(shí)例化 My\Full\Classname 對(duì)象
NSname\subns\func(); // 調(diào)用函數(shù) My\Full\NSname\subns\func
?>

導(dǎo)入操作是在編譯執(zhí)行的，但動(dòng)態(tài)的類(lèi)名稱(chēng)、函數(shù)名稱(chēng)或常量名稱(chēng)則不是。

3、導(dǎo)入和動(dòng)態(tài)名稱(chēng)

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

$obj = new Another; // 實(shí)例化一個(gè) My\Full\Classname 對(duì)象
$a = 'Another';
$obj = new $a;  // 實(shí)際化一個(gè) Another 對(duì)象
?>

另外，導(dǎo)入操作只影響非限定名稱(chēng)和限定名稱(chēng)。完全限定名稱(chēng)由于是確定的，故不受導(dǎo)入的影響。

4、導(dǎo)入和完全限定名稱(chēng)

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

$obj = new Another; // 實(shí)例化 My\Full\Classname 類(lèi)
$obj = new \Another; // 實(shí)例化 Another 類(lèi)
$obj = new Another\thing; // 實(shí)例化 My\Full\Classname\thing 類(lèi)
$obj = new \Another\thing; // 實(shí)例化 Another\thing 類(lèi)
?>

使用命名空間：后備全局函數(shù)/常量

在一個(gè)命名空間中，當(dāng) PHP 遇到一個(gè)非限定的類(lèi)、函數(shù)或常量名稱(chēng)時(shí)，它使用不同的優(yōu)先策略來(lái)解析該名稱(chēng)。類(lèi)名稱(chēng)總是解析到當(dāng)前命名空間中的名稱(chēng)。因此在訪(fǎng)問(wèn)系統(tǒng)內(nèi)部或不包含在命名空間中的類(lèi)名稱(chēng)時(shí)，必須使用完全限定名稱(chēng)，例如：

1、在命名空間中訪(fǎng)問(wèn)全局類(lèi)

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

$a = new Exception('hi'); // $a 是類(lèi) A\B\C\Exception 的一個(gè)對(duì)象
$b = new \Exception('hi'); // $b 是類(lèi) Exception 的一個(gè)對(duì)象

$c = new ArrayObject; // 致命錯(cuò)誤, 找不到 A\B\C\ArrayObject 類(lèi)
?>

對(duì)于函數(shù)和常量來(lái)說(shuō)，如果當(dāng)前命名空間中不存在該函數(shù)或常量，PHP 會(huì)退而使用全局空間中的函數(shù)或常量。

2、命名空間中后備的全局函數(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";
}
?>

全局空間

如果沒(méi)有定義任何命名空間，所有的類(lèi)與函數(shù)的定義都是在全局空間，與 PHP 引入命名空間概念前一樣。在名稱(chēng)前加上前綴 \ 表示該名稱(chēng)是全局空間中的名稱(chēng)，即使該名稱(chēng)位于其它的命名空間中時(shí)也是如此。

使用全局空間說(shuō)明

<?php
namespace A\B\C;

/* 這個(gè)函數(shù)是 A\B\C\fopen */
function fopen() { 
  /* ... */
  $f = \fopen(...); // 調(diào)用全局的fopen函數(shù)
  return $f;
} 
?>

命名空間的順序

自從有了命名空間之后，最容易出錯(cuò)的該是使用類(lèi)的時(shí)候，這個(gè)類(lèi)的尋找路徑是什么樣的了。

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

// 函數(shù)調(diào)用

foo();  // 首先嘗試調(diào)用定義在命名空間"A"中的函數(shù)foo()
   // 再?lài)L試調(diào)用全局函數(shù) "foo"

\foo();  // 調(diào)用全局空間函數(shù) "foo" 

my\foo(); // 調(diào)用定義在命名空間"A\my"中函數(shù) "foo" 

F();  // 首先嘗試調(diào)用定義在命名空間"A"中的函數(shù) "F" 
   // 再?lài)L試調(diào)用全局函數(shù) "F"

// 類(lèi)引用

new B(); // 創(chuàng)建命名空間 "A" 中定義的類(lèi) "B" 的一個(gè)對(duì)象
   // 如果未找到，則嘗試自動(dòng)裝載類(lèi) "A\B"

new D(); // 使用導(dǎo)入規(guī)則，創(chuàng)建命名空間 "B" 中定義的類(lèi) "D" 的一個(gè)對(duì)象
   // 如果未找到，則嘗試自動(dòng)裝載類(lèi) "B\D"

new F(); // 使用導(dǎo)入規(guī)則，創(chuàng)建命名空間 "C" 中定義的類(lèi) "E" 的一個(gè)對(duì)象
   // 如果未找到，則嘗試自動(dòng)裝載類(lèi) "C\E"

new \B(); // 創(chuàng)建定義在全局空間中的類(lèi) "B" 的一個(gè)對(duì)象
   // 如果未發(fā)現(xiàn)，則嘗試自動(dòng)裝載類(lèi) "B"

new \D(); // 創(chuàng)建定義在全局空間中的類(lèi) "D" 的一個(gè)對(duì)象
   // 如果未發(fā)現(xiàn)，則嘗試自動(dòng)裝載類(lèi) "D"

new \F(); // 創(chuàng)建定義在全局空間中的類(lèi) "F" 的一個(gè)對(duì)象
   // 如果未發(fā)現(xiàn)，則嘗試自動(dòng)裝載類(lèi) "F"

// 調(diào)用另一個(gè)命名空間中的靜態(tài)方法或命名空間函數(shù)

B\foo(); // 調(diào)用命名空間 "A\B" 中函數(shù) "foo"

B::foo(); // 調(diào)用命名空間 "A" 中定義的類(lèi) "B" 的 "foo" 方法
   // 如果未找到類(lèi) "A\B" ，則嘗試自動(dòng)裝載類(lèi) "A\B"

D::foo(); // 使用導(dǎo)入規(guī)則，調(diào)用命名空間 "B" 中定義的類(lèi) "D" 的 "foo" 方法
   // 如果類(lèi) "B\D" 未找到，則嘗試自動(dòng)裝載類(lèi) "B\D"

\B\foo(); // 調(diào)用命名空間 "B" 中的函數(shù) "foo" 

\B::foo(); // 調(diào)用全局空間中的類(lèi) "B" 的 "foo" 方法
   // 如果類(lèi) "B" 未找到，則嘗試自動(dòng)裝載類(lèi) "B"

// 當(dāng)前命名空間中的靜態(tài)方法或函數(shù)

A\B::foo(); // 調(diào)用命名空間 "A\A" 中定義的類(lèi) "B" 的 "foo" 方法
    // 如果類(lèi) "A\A\B" 未找到，則嘗試自動(dòng)裝載類(lèi) "A\A\B"

\A\B::foo(); // 調(diào)用命名空間 "A" 中定義的類(lèi) "B" 的 "foo" 方法
    // 如果類(lèi) "A\B" 未找到，則嘗試自動(dòng)裝載類(lèi) "A\B"
?>

名稱(chēng)解析遵循下列規(guī)則：

1. 對(duì)完全限定名稱(chēng)的函數(shù)，類(lèi)和常量的調(diào)用在編譯時(shí)解析。例如 new \A\B 解析為類(lèi) A\B。

2. 所有的非限定名稱(chēng)和限定名稱(chēng)（非完全限定名稱(chēng)）根據(jù)當(dāng)前的導(dǎo)入規(guī)則在編譯時(shí)進(jìn)行轉(zhuǎn)換。例如，如果命名空間 A\B\C 被導(dǎo)入為 C，那么對(duì) C\D\e() 的調(diào)用就會(huì)被轉(zhuǎn)換為 A\B\C\D\e()。

3. 在命名空間內(nèi)部，所有的沒(méi)有根據(jù)導(dǎo)入規(guī)則轉(zhuǎn)換的限定名稱(chēng)均會(huì)在其前面加上當(dāng)前的命名空間名稱(chēng)。例如，在命名空間 A\B 內(nèi)部調(diào)用 C\D\e()，則 C\D\e() 會(huì)被轉(zhuǎn)換為 A\B\C\D\e() 。

4. 非限定類(lèi)名根據(jù)當(dāng)前的導(dǎo)入規(guī)則在編譯時(shí)轉(zhuǎn)換（用全名代替短的導(dǎo)入名稱(chēng)）。例如，如果命名空間 A\B\C 導(dǎo)入為C，則 new C() 被轉(zhuǎn)換為 new A\B\C() 。

5. 在命名空間內(nèi)部（例如A\B），對(duì)非限定名稱(chēng)的函數(shù)調(diào)用是在運(yùn)行時(shí)解析的。例如對(duì)函數(shù) foo() 的調(diào)用是這樣解析的：

在當(dāng)前命名空間中查找名為 A\B\foo() 的函數(shù)
嘗試查找并調(diào)用全局(global) 空間中的函數(shù) foo()。

6. 在命名空間（例如A\B）內(nèi)部對(duì)非限定名稱(chēng)或限定名稱(chēng)類(lèi)（非完全限定名稱(chēng)）的調(diào)用是在運(yùn)行時(shí)解析的。下面是調(diào)用 new C() 及 new D\E() 的解析過(guò)程： new C()的解析: