PHP 名稱空間

Galois發表於2020-01-14
PHP

前言

有時候使用者編寫的程式碼與PHP內部的類/函式/常量之間用重名的衝突，PHP 名稱空間可以解決這種問題。
預設情況下，所有常量、類和函式名都放在全域性空間下，就和 PHP 支援名稱空間之前一樣。（PHP 名稱空間是在 PHP 5.3 中加入的）

定義名稱空間

名稱空間透過關鍵字 namespace 來宣告。如果一個檔案中包含名稱空間，它必須在其它所有程式碼之前宣告名稱空間。

<?php
namespace MyPro;  // 定義程式碼在 MyPro 名稱空間中
// ... 程式碼 ...

也可以在同一個檔案中定義不同的名稱空間程式碼：

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

也可以用大括號形式的語法：

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

用一個不帶名稱的 namespace 語句加上大括號括起來可以將全域性的非名稱空間中的程式碼與名稱空間中的程式碼組合在一起：

<?php
namespace MyPro {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */  }
}
namespace { // 全域性程式碼
session_start();
$a = MyPro\connect();
echo MyPro\Connection::start();
}

在宣告名稱空間之前唯一合法的程式碼是用於定義原始檔編碼方式的 declare 語句。所有非 PHP 程式碼包括空白符都不能出現在名稱空間的宣告之前。

<?php
declare(encoding='UTF-8'); //定義多個名稱空間和不包含在名稱空間中的程式碼
namespace MyPro {
const CONNECT_OK = 1;
class Connection { /* ... */ }
function connect() { /* ... */  }
}
namespace { 
// 全域性程式碼
}

子名稱空間

子名稱空間的概念如同目錄和檔案的關係，PHP 名稱空間也允許指定層次化的名稱空間的名稱。名稱空間的名字可以使用分層次的方式定義：

<?php
namespace MyPro\Sub\User;  //宣告分層次的單個名稱空間
const CONNECT_OK = 1;
class Connection { /* ... */ }
function Connect() { /* ... */  }

上面的例子建立了常量 MyPro\Sub\User\CONNECT_OK，類 MyPro\Sub\User\Connection 和函式 MyPro\Sub\User\Connect。

名稱空間使用

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

  1. 非限定名稱，或不包含字首的類名稱（出現同名遵循就近原則）
  2. 限定名稱，或包含字首的名稱
  3. 完全限定名稱，或包含了全域性字首運算子的名稱

例項：
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
foo::staticmethod(); // 解析為類 Foo\Bar\foo ，方法為 staticmethod
echo FOO; // 解析為常量 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

名稱空間和動態語言特徵

PHP 名稱空間的實現受到其語言自身的動態特徵的影響：
ex.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 'ex.php';
$a = 'classname';
$obj = new $a; // 輸出 classname::__construct
$b = 'funcname';
$b(); // 輸出函式名
echo constant('constname'), "\n"; // 輸出 global
/* 如果使用雙引號，使用方法為 "\\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 關鍵字和 __NAMESPACE__ 常量

PHP支援兩種抽象的訪問當前名稱空間內部元素的方法，__NAMESPACE__ 魔術常量和 namespace 關鍵字。常量 __NAMESPACE__ 的值是包含當前名稱空間名稱的字串。在全域性的，不包括在任何名稱空間中的程式碼，它包含一個空的字串。

<?php
namespace MyPro;
echo '"', __NAMESPACE__, '"'; // 輸出 "MyPro"
<?php
echo '"', __NAMESPACE__, '"'; // 輸出 ""

常量 NAMESPACE 在動態建立名稱時很有用，使用 __NAMESPACE__ 動態建立名稱：

<?php
namespace  MyPro;
function get($classname)
{
    $a = __NAMESPACE__ . '\\' . $classname;
    return new $a;
}

關鍵字 namespace 可用來顯式訪問當前名稱空間或子名稱空間中的元素。它等價於類中的 self 運算子。
namespace運算子，名稱空間中的程式碼：

<?php
namespace MyPro;
use blah\blah as mine; // see "Using namespaces: importing/aliasing"
blah\mine(); // calls function blah\blah\mine()
namespace\blah\mine(); // calls function MyPro\blah\mine()
namespace\func(); // calls function MyPro\func()
namespace\sub\func(); // calls function MyPro\sub\func()
namespace\cname::method(); // calls static method "method" of class MyPro\cname
$a = new namespace\sub\cname(); // instantiates object of class MyPro\sub\cname
$b = namespace\CONSTANT; // assigns value of constant MyPro\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中，別名是透過運算子 use 來實現的。

使用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 物件

一行中包含多個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

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

<?php
use My\Full\Classname as Another, My\Full\NSname;
$obj = new Another; // 例項化一個 My\Full\Classname 物件
$a = 'Another';
$obj = new $a;      // 實際化一個 Another 物件

匯入操作隻影響非限定名稱和限定名稱。完全限定名稱由於是確定的，故不受匯入的影響。
匯入和完全限定名稱：

<?php
use My\Full\Classname as Another, My\Full\NSname;
$obj = new Another; // 例項化 My\Full\Classname 類
$obj = new \Another; // 例項化 Another 類
$obj = new Another\thing; // 例項化 My\Full\Classname\thing 類
$obj = new \Another\thing; // 例項化 Another\thing 類

使用名稱空間 - 後備全域性函式 / 常量

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

在名稱空間中訪問全域性類：

<?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 會退而使用全域性空間中的函式或常量。
名稱空間中後備的全域性函式/常量：

<?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"; // 輸出 "2"
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" 的 "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() 的呼叫是這樣解析的：

    • 在當前名稱空間中查詢名為 A\B\foo() 的函式。
    • 嘗試查詢並呼叫 全域性(global) 空間中的函式 foo()。

  • 在名稱空間（例如A\B）內部對非限定名稱或限定名稱類（非完全限定名稱）的呼叫是在執行時解析的。下面是呼叫 new C() 及 new D\E() 的解析過程：

    • new C()的解析：
      • 在當前名稱空間中查詢A\B\C類。
      • 嘗試自動裝載類A\B\C。
    • new D\E()的解析：
      • 在類名稱前面加上當前名稱空間名稱變成：A\B\D\E，然後查詢該類。
      • 嘗試自動裝載類 A\B\D\E。
    • 為了引用全域性名稱空間中的全域性類，必須使用完全限定名稱 new \C()。
本作品採用《CC 協議》，轉載必須註明作者和本文連結
不要試圖用百米衝刺的方法完成馬拉松比賽。

相關文章