PHP——名稱空間（namespace）使用詳細介紹

對於名稱空間，官方文件已經說得很詳細[檢視]，我在這裡做了一下實踐和總結。

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

例：專案中有兩個模組：article和message board，它們各自有一個處理使用者留言的類Comment。之後我可能想要增加對所有使用者留言的一些資訊統計功能，比如說我想得到所有留言的數量。這時候呼叫它們Comment提供的方法是很好的做法，但是同時引入各自的Comment類顯然是不行的，程式碼會出錯，在另一個地方重寫任何一個Comment也會降低維護性。那這時只能重構類名，我約定了一個命名規則，在類名前面加上模組名，像這樣：Article_Comment、MessageBoard_Comment

可以看到，名字變得很長，那意味著以後使用Comment的時候會寫上更多的程式碼（至少字元多了）。並且，以後如果要對各個模組增加更多的一些整合功能，或者是互相呼叫，發生重名的時候就需要重構名字。當然在專案開始的時候就注意到這個問題，並規定命名規則就能很好的避免這個問題。另一個解決方法可以考慮使用名稱空間。

註明：

本文提到的常數：PHP5.3開始const關鍵字可以用在類的外部。const和define都是用來宣告常數的（它們的區別不詳述），但是在名稱空間裡，define的作用是全域性的，而const則作用於當前空間。我在文中提到的常數是指使用const宣告的常數。

基礎：

名稱空間將程式碼劃分出不同的空間（區域），每個空間的常數、函數、類（為了偷懶，我下邊都將它們稱為元素）的名字互不影響，這個有點類似我們常常提到的‘封裝'的概念。

建立一個名稱空間需要使用namespace關鍵字

程式碼如下：

<?php 
//建立一個名為'Article'的名稱空間
namespace Article;
?>

要注意的是，當前指令碼檔案的第一個名稱空間前面不能有任何程式碼，下面的寫法都是錯誤的：

程式碼如下：

//在指令碼前面寫了一些邏輯程式碼
<?php
$path = "/";
class Comment { }
namespace Article;
?>

或者如下：

//在指令碼前面輸出了一些字元
<html></html>
<?php
namespace Article;
?>

為什麼要說第一個名稱空間呢？因為同一指令碼檔案中可以建立多個名稱空間。

下面我建立了兩個名稱空間，順便為這兩個空間各自新增了一個Comment類元素：

程式碼如下：

<?php 
//建立一個名為'Article'的名稱空間
namespace Article;
//此Comment屬於Article空間的元素
class Comment { }

//建立一個名為'MessageBoard'的名稱空間
namespace MessageBoard;
//此Comment屬於MessageBoard空間的元素
class Comment { }
?>

在不同空間之間不可以直接呼叫其它元素，需要使用名稱空間的語法：

程式碼如下：

<?php 
namespace Article;
class Comment { }

namespace MessageBoard;
class Comment { }
//呼叫當前空間（MessageBoard）的Comment類
$comment = new Comment();
//呼叫Article空間的Comment類
$article_comment = new ArticleComment();
?>

可以看到，在MessageBoard空間中呼叫article空間裡的Comment類時，使用了一種像檔案路徑的語法：空間名元素名

除了類之外，對函數和常數的用法是一樣的，下面我為兩個空間建立了新的元素，並在MessageBoard空間中輸出了它們的值。

程式碼如下：

<?php 
namespace Article;
const PATH = '/article';
function getCommentTotal() {
    return 100;
}
class Comment { }

namespace MessageBoard;
const PATH = '/message_board';
function getCommentTotal() {
    return 300;
}
class Comment { }
//呼叫當前空間的常數、函數和類
echo PATH; ///message_board
echo getCommentTotal(); //300
$comment = new Comment();
//呼叫Article空間的常數、函數和類
echo ArticlePATH; ///article
echo ArticlegetCommentTotal(); //100
$article_comment = new ArticleComment();
?>

子空間：

名稱空間的呼叫語法像檔案路徑一樣是有道理的，它允許我們自定義子空間來描述各個空間之間的關係。

抱歉我忘了說，article和message board這兩個模組其實都是處於同一個blog專案內。如果用名稱空間來表達它們的關係

<?php 
//我用這樣的名稱空間表示處於blog下的article模組
namespace BlogArticle;
class Comment { }

//我用這樣的名稱空間表示處於blog下的message board模組
namespace BlogMessageBoard;
class Comment { }
//呼叫當前空間的類
$comment = new Comment();
//呼叫BlogArticle空間的類
$article_comment = new BlogArticleComment();
?>

公共空間：

我有一個common_inc.php指令碼檔案，裡面有一些好用的函數和類：

<?php 
function getIP() { }
class FilterXSS { }
?>

在一個名稱空間裡引入這個指令碼，指令碼裡的元素不會歸屬到這個名稱空間。如果這個指令碼裡沒有定義其它名稱空間，它的元素就始終處於公共空間中：

<?php 
namespace BlogArticle;
//引入指令碼檔案
include './common_inc.php';
$filter_XSS = new FilterXSS(); //出現致命錯誤：找不到BlogArticleFilterXSS類
$filter_XSS = new FilterXSS(); //正確
?>

呼叫公共空間的方式是直接在元素名稱前加就可以了，否則PHP解析器會認為我想呼叫當前空間下的元素。除了自定義的元素，還包括PHP自帶的元素，都屬於公共空間

要提一下，其實公共空間的函數和常數不用加也可以正常呼叫（不明白PHP為什麼要這樣做），但是為了正確區分元素，還是建議呼叫函數的時候加上

3、名稱術語

在說別名和匯入之前，需要知道關於空間三種名稱的術語，以及PHP是怎樣解析它們的。官方文件說得非常好，我就直接拿來套了。

1.非限定名稱，或不包含字首的類名稱，例如 $comment = new Comment();。如果當前名稱空間是BlogArticle，Comment將被解析為BlogArticleComment。如果使用Comment的程式碼不包含在任何名稱空間中的程式碼（全域性空間中），則Comment會被解析為Comment。

2.限定名稱，或包含字首的名稱，例如 $comment = new ArticleComment();。如果當前的名稱空間是Blog，則Comment會被解析為BlogArticleComment。如果使用Comment的程式碼不包含在任何名稱空間中的程式碼（全域性空間中），則Comment會被解析為Comment。

3.完全限定名稱，或包含了全域性字首操作符的名稱，例如 $comment = new ArticleComment();。在這種情況下，Comment總是被解析為程式碼中的文字名(literal name)ArticleComment。

其實可以把這三種名稱類比為檔名（例如 comment.php）、相對路徑名（例如 ./article/comment.php）、絕對路徑名（例如 /blog/article/comment.php），這樣可能會更容易理解。

我用了幾個範例來表示它們：

<?php 
//建立空間Blog
namespace Blog;
class Comment { }
//非限定名稱，表示當前Blog空間
//這個呼叫將被解析成 BlogComment();
$blog_comment = new Comment();
//限定名稱，表示相對於Blog空間
//這個呼叫將被解析成 BlogArticleComment();
$article_comment = new ArticleComment(); //類前面沒有反斜桿
//完全限定名稱，表示絕對於Blog空間
//這個呼叫將被解析成 BlogComment();
$article_comment = new BlogComment(); //類前面有反斜桿
//完全限定名稱，表示絕對於Blog空間
//這個呼叫將被解析成 BlogArticleComment();
$article_comment = new BlogArticleComment(); //類前面有反斜桿

//建立Blog的子空間Article
namespace BlogArticle;
class Comment { }
?>

別名和匯入
別名和匯入可以看作是呼叫名稱空間元素的一種快捷方式。PHP並不支援匯入函數或常數。

它們都是通過使用use操作符來實現

程式碼如下：

<?php 
namespace BlogArticle;
class Comment { }

//建立一個BBS空間（我有打算開個論壇）
namespace BBS;
//匯入一個名稱空間
use BlogArticle;
//匯入名稱空間後可使用限定名稱呼叫元素
$article_comment = new ArticleComment();
//為名稱空間使用別名
use BlogArticle as Arte;
//使用別名代替空間名
$article_comment = new ArteComment();
//匯入一個類
use BlogArticleComment;
//匯入類後可使用非限定名稱呼叫元素
$article_comment = new Comment();
//為類使用別名
use BlogArticleComment as Comt;
//使用別名代替空間名
$article_comment = new Comt();
?>

我注意到，如果匯入元素的時候，當前空間有相同的名字元素將會怎樣？顯然結果會發生致命錯誤。

<?php 
namespace BlogArticle;
class Comment { }

namespace BBS;
class Comment { }
Class Comt { }

//匯入一個類
use BlogArticleComment;
$article_comment = new Comment(); //與當前空間的Comment發生衝突，程式產生致命錯誤
//為類使用別名
use BlogArticleComment as Comt;
$article_comment = new Comt(); //與當前空間的Comt發生衝突，程式產生致命錯誤
?>

動態呼叫
PHP提供了namespace關鍵字和__NAMESPACE__魔法常數動態的存取元素，__NAMESPACE__可以通過組合字串的形式來動態存取

<?php 
namespace BlogArticle;
const PATH = '/Blog/article';
class Comment { }

//namespace關鍵字表示當前空間
echo namespacePATH; ///Blog/article
$comment = new namespaceComment();
//魔法常數__NAMESPACE__的值是當前空間名稱
echo __NAMESPACE__; //BlogArticle
//可以組合成字串並呼叫
$comment_class_name = __NAMESPACE__ . 'Comment';
$comment = new $comment_class_name();
?>

字串形式呼叫問題：

上面的動態呼叫的例子中，我們看到了字串形式的動態呼叫方式，如果要使用這種方式要注意兩個問題

1、使用""時特殊字元可能被跳脫

<?php 
namespace BlogArticle;
class name { }
//我是想呼叫BlogArticlename
$class_name = __NAMESPACE__ . "name"; //但是n將被跳脫為換行符
$name = new $class_name(); //發生致命錯誤
?>

2、不會認為是限定名稱

PHP在編譯指令碼的時候就確定了元素所在的空間，以及匯入的情況。而在解析指令碼時字串形式呼叫只能認為是非限定名稱和完全限定名稱，而永遠不可能是限定名稱

<?php 
namespace Blog;
//匯入Common類
use BlogArticleCommon;
//我想使用非限定名稱呼叫BlogArticleCommon
$common_class_name = 'Common';
//實際會被當作非限定名稱，也就表示當前空間的Common類，但我當前類沒有建立Common類
$common = new $common_class_name(); //發生致命錯誤：Common類不存在
//我想使用限定名稱呼叫BlogArticleCommon
$common_class_name = 'ArticleCommon';
//實際會被當作完全限定名稱，也就表示Article空間下的Common類，但我下面只定義了BlogArticle空間而不是Article空間
$common = new $common_class_name(); //發生致命錯誤：ArticleCommon類不存在

namespace BlogArticle;
class Common { }
?>

總結
我對PHP的名稱空間剛剛接觸，也不能隨便給一些沒有實踐的建議。我個人認為名稱空間的作用和功能都很強大，如果要寫外掛或者通用庫的時候再也不用擔心重名問題。不過如果專案進行到一定程度，要通過增加名稱空間去解決重名問題，我覺得工作量不會比重構名字少。也不得不承認它的語法會對專案增加一定的複雜度，因此從專案一開始的時候就應該很好的規劃它，並制定一個命名規範。

更多相關問題請存取PHP中文網：PHP視訊教學

以上就是PHP——名稱空間（namespace）使用詳細介紹的詳細內容，更多請關注TW511.COM其它相關文章！