PHP命名空間(Namespace)的使用詳解

時間 2019-11-08

標籤 php 命名空間 namespace 使用詳解欄目 PHP 简体版

原文原文鏈接

對於命名空間，官方的文檔已經說的很詳細，在這裏我作了一下實踐和總結。php

命名空間一個最明確的目的就是解決重名問題。Php中不容許兩個函數或者類出現相同的名字，不然會產生一個致命的錯誤。這種狀況下只要避免命名重複就能夠解決，最多見的一種作法是約定一個前綴。html

例：項目中有兩個模塊：article和message board，它們各自有一個處理用戶留言的類comment。以後我可能要增長對全部用戶留言的一些信息統計功能，好比說我想要獲得全部留言的數量。這時候調用它們comment提供的方法是很好的作法，可是同時引入各自的comment類顯然是不行的，代碼會出錯，在另外一個地方重寫一個comment也會下降維護性。那這時只能重構類名，我約定一個命名規則，在類名前面加上模塊名，像這樣：article_comment、messageBoard_comment。ide

能夠看到，名字變得很長，那就意味着之後使用comment的時候會寫上更多的代碼。而且，之後若是要對各個模塊增長更多的一些整合功能，或者是互相調用，發生重名的時候就須要重構名字。固然在項目開始的時候就注意到這個問題，並規定命名規則就能很好的避免這個問題。另外一個解決方法是能夠考慮使用命名空間。函數

註明：本文提到的常量php5.3開始const關鍵字能夠用在類的外部。Const和define都是來聲明常量的，可是在命名空間裏，define的做用是全局的，而const則做用與當前的空間。我在文中提到的常量是使用const聲明的常量。spa

基礎：命名空間將代碼劃分出不一樣放入空間（區域），每一個空間的常量、函數、類的名字互不影響，這個有點相似咱們經常提到的’封裝’的概念。code

建立一個命名空間須要使用 namespace關鍵詞：htm

<?php
// 建立一個名爲‘Article’的命名空間
namespace Article;
?>

注：當前腳本的第一個命名空間前面不能有任何代碼，下面的寫法是錯誤的：blog

<?php
// 在腳本前面寫了一些邏輯代碼
$path = '/';
class Comment{}
namespace Article;
?>

爲何要說第一個命名空間呢？由於同一個腳本文件中能夠建立多個命名空間。ci

下面我建立了兩個命名空間，順便爲這兩個空間各自添加一個Comment類元素：文檔

在不一樣空間之間不能夠直接調用其餘元素，須要使用命名空間的語法：

<?php
// 建立一個名爲「Article」的命名空間
namespace Article;
// 此Comment屬於Article空間的元素
class Comment{}

// 建立一個名爲「MessageBoard」的命名空間
namespace MessageBoard;
// 此Comment屬於MessageBoard空間元素
class Comment{}

// 調用當前空間（MessageBoard）的Comment類
$comment = new Comment();

// 調用Article空間的Comment類
$article_comment = new \Article\Comment();
?>

能夠看到，在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;
echo getCommentTotal();
$comment = new Comment();

// 調用Article空間的常量、函數和類
echo \Article\PATH;
echo \Article\getCommentTotal();
$article_comment = new \Article\Comment();
?>

子空間：命名空間的調用語法像文件路徑同樣是有道理的，它容許咱們自定義子空間來描述各個空間之間的關係。

Article和message board這兩個模塊都是處於同一個blog項目內。若是用命名空間來表示它們的關係，是這樣：

<?php
// 我用這樣的命名空間表示處於blog下的article模塊
namespace Blog\Article;
class Comment{}

// 我用這樣的命名空間來表示處於blog下的message board模塊
namespace Blog\MessageBlog;
class Comment{}

// 調用當前空間的類
$comment = new Comment();

// 調用Blog\Article空間的類
$article_comment = new \Blog\Article\Comment();
?>

而卻，子空間還能夠定義不少層次，好比說Blog\Article\Archives\Date

公共空間：我有一個common_inc.php腳本文件，裏面有一些好用的函數和類。

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

在一個命名空間裏引入這個腳本文件，腳本里的元素不會歸屬到這個命名空間。若是這個腳本里沒有定義其餘命名空間，它的元素始終處於公共空間中：

<?php
namespace Blog\Article;
// 引入腳本文件
include './common_inc.php';
$filter_XSS = new FilterXSS(); // 出現致命錯誤，找不到Blog\Article\FilterXSS類
$filter_XSS = new \FilterXSS(); // 正確
?>

調用公共空間的方式直接在元素名稱前加’\‘就能夠了，不然php解析器會認爲我想要調用當前空間下的元素。除了自定義的元素，還包括php自帶的元素，都屬於公共空間。

名稱術語：在別名和導入以前，須要知道關於空間三種名稱術語，以及php是怎樣解析它們的。

一、非限定名稱，或不包括前綴的類名稱。例如$comment = new Comment();。若是當前命名空間是Blog\Article，Comment將被解析爲Blog\Article\Comment。若是使用Comment的代碼不包括在任何命名空間中（全局空間），則Comment會被解析爲Comment。

二、限定名稱，或包括前綴的名稱。例如$comment = new Article\Comment();。若是當前的命名空間是Blog，則Comment會被解析爲Blog\Article\Comment。若是使用Comment的代碼不包括在任何命名空間中（全局空間），則Comment會被解析爲Comment。

三、徹底限定名稱，或包含了全局前綴操做符的名稱。例如$comment = new \Article\Comment();。在這種狀況下，Comment老是被解析爲代碼中的文字名(literal name)Article\COmment。

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

<?php
// 建立空間Blog
namespace Blog;
class comment{}

// 非限定名稱，表示當前Blog空間
//這個調用將被解析成Blog\Comment()
$blog_comment = new Comment();

// 限定名稱，表示相對於Blog空間
//這個調用將被解析成Blog\Article\Comment()
$article_comment = new Article\Comment();

// 徹底限定名稱，表示絕對於Blog空間
//這個調用將被解析成Blog\comment()
$article_comment = new \Blog\Comment();

// 徹底限定名稱，表示絕對於Blog空間
//這個調用將被解析成Blog\Article\Comment()
$article_comment = new \Blog\Article\Comment();

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

別名和導入：能夠看做是調用命名空間元素的一種快捷方式。

<?php
namespace Blog\Article;
class Comment{}

// 建立一個BBS空間
namespace BBS;

// 導入一個命名空間
use Blog\Article;
// 導入命名空間後可以使用限定名稱調用元素
$article_comment = new Article\Comment();

// 爲命名空間使用別名
use Blog\Article as Arte;
// 使用別名代替空間名
$article_comment = new Arte\Comment();

// 導入一個類
use Blog\Article\Comment;
// 導入類後可以使用非限定名稱調用元素
$article_comment = new Comment();

// 爲類使用別名
use Blog\Article\Comment as Comt;
// 使用別名代替空間名
$article_comment = new Comt();
?>

若是導入元素的時候，當前空間有相同的名字元素將會怎樣？顯然結果會發生致命錯誤。

<?php
namespace Blog\Article;
class Comment{}

// 建立一個BBS空間
namespace BBS;
class Comment{}
class Comt{}

// 導入一個類
use Blog\Article\Comment;
$article_comment = new Comment(); // 與當前空間的Comment發生衝突，程序產生致命錯誤

//爲類使用別名
use Blog\Article\Comment as Comt;
$article_comment = new Comt(); // 與當前空間的Comt發生衝突，程序產生致命錯誤
?>

動態調用：php提供了namespace關鍵字和__NAMESPACE__魔法常量動態的訪問元素，__NAMESPACE__能夠經過組合字符串的形式來動態的訪問。

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

// namespace關鍵字表示當前空間
echo namespace\PATH;
$comment = new namespace\Comment();

// 魔法常量__NAMESPACE__的值是當前空間的名稱
echo __NAMESPACE__;

// 能夠組合成字符串並調用
$comment_class_name = __NAMESPACE__.'\Comment';
$comment = new $comment_class_name();
?>

字符串形式調用問題：上面的動態調用的例子中，咱們看到了字符串形式的動態調用方式，若是要使用這種方式要注意兩個問題。

一、使用雙引號的時候特殊字符串可能被轉義

<?php
namespace Blog\Article;
const PATH = '/Blog/article';
class name{}

// 我想調用Blog\Article\name
$class_name = __NAMESPACE__."\name"; // 可是\n將被轉義爲換行符
$name = new $class_name(); // 發生致命的錯誤
?>

二、不會認爲是限定名稱：php在編譯腳本的時候就肯定了元素所在的空間，以及導入的狀況。而在解析腳本時字符串形式調用只能認爲是非限定名稱和徹底限定名稱，而永遠不多是限定名稱。

<?php
namespace Blog;

// 導入Common類
use Blog\Article\Common;
// 我想使用非限定名稱調用Blog\Article\Common
$common_class_name = 'Common';
// 實際會被看成非限定名稱，也就表示當前空間的Common類，但我當前空間沒有穿件Common類
$common = new $common_class_name(); // 發生致命錯誤，Common類不存在
//$common = new Common();

//我想使用限定名稱調用Blog\Article\Common
$common_class_name = 'Article\Common';
// 實際會被看成徹底限定名稱，也就是表示Article空間下的Common類，但我下面只定義了Blog\Article空間而不是Article空間
$common = new $common_class_name(); // 發生致命錯誤，Article\Common類不存在
//$common = new Article\Common();

namespace Blog\Article;
class Common{} ?>