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

更新時(shí)間：2013年05月04日 09:11:03 作者：

命名空間一個(gè)最明確的目的就是解決重名問題，PHP中不允許兩個(gè)函數(shù)或者類出現(xiàn)相同的名字，否則會(huì)產(chǎn)生一個(gè)致命的錯(cuò)誤。這種情況下只要避免命名重復(fù)就可以解決

對(duì)于命名空間，官方文檔已經(jīng)說得很詳細(xì)[查看]，我在這里做了一下實(shí)踐和總結(jié)。

命名空間一個(gè)最明確的目的就是解決重名問題，PHP中不允許兩個(gè)函數(shù)或者類出現(xiàn)相同的名字，否則會(huì)產(chǎn)生一個(gè)致命的錯(cuò)誤。這種情況下只要避免命名重復(fù)就可以解決，最常見的一種做法是約定一個(gè)前綴。

例：項(xiàng)目中有兩個(gè)模塊：article和message board，它們各自有一個(gè)處理用戶留言的類Comment。之后我可能想要增加對(duì)所有用戶留言的一些信息統(tǒng)計(jì)功能，比如說我想得到所有留言的數(shù)量。這時(shí)候調(diào)用它們Comment提供的方法是很好的做法，但是同時(shí)引入各自的Comment類顯然是不行的，代碼會(huì)出錯(cuò)，在另一個(gè)地方重寫任何一個(gè)Comment也會(huì)降低維護(hù)性。那這時(shí)只能重構(gòu)類名，我約定了一個(gè)命名規(guī)則，在類名前面加上模塊名，像這樣：Article_Comment、MessageBoard_Comment

可以看到，名字變得很長(zhǎng)，那意味著以后使用Comment的時(shí)候會(huì)寫上更多的代碼（至少字符多了）。并且，以后如果要對(duì)各個(gè)模塊增加更多的一些整合功能，或者是互相調(diào)用，發(fā)生重名的時(shí)候就需要重構(gòu)名字。當(dāng)然在項(xiàng)目開始的時(shí)候就注意到這個(gè)問題，并規(guī)定命名規(guī)則就能很好的避免這個(gè)問題。另一個(gè)解決方法可以考慮使用命名空間。

注明：

本文提到的常量：PHP5.3開始const關(guān)鍵字可以用在類的外部。const和define都是用來聲明常量的（它們的區(qū)別不詳述），但是在命名空間里，define的作用是全局的，而const則作用于當(dāng)前空間。我在文中提到的常量是指使用const聲明的常量。

基礎(chǔ)
命名空間將代碼劃分出不同的空間（區(qū)域），每個(gè)空間的常量、函數(shù)、類（為了偷懶，我下邊都將它們稱為元素）的名字互不影響，這個(gè)有點(diǎn)類似我們常常提到的‘封裝'的概念。

創(chuàng)建一個(gè)命名空間需要使用namespace關(guān)鍵字，這樣：

復(fù)制代碼代碼如下:

<?php

//創(chuàng)建一個(gè)名為'Article'的命名空間
namespace Article;

要注意的是，當(dāng)前腳本文件的第一個(gè)命名空間前面不能有任何代碼，下面的寫法都是錯(cuò)誤的：

復(fù)制代碼代碼如下:

//例一
//在腳本前面寫了一些邏輯代碼

<?php

$path = "/";

class Comment { }

namespace Article;

//例二
//在腳本前面輸出了一些字符

<html></html>
<?php

namespace Article;

為什么要說第一個(gè)命名空間呢？因?yàn)橥荒_本文件中可以創(chuàng)建多個(gè)命名空間。

下面我創(chuàng)建了兩個(gè)命名空間，順便為這兩個(gè)空間各自添加了一個(gè)Comment類元素：

復(fù)制代碼代碼如下:

<?php

//創(chuàng)建一個(gè)名為'Article'的命名空間
namespace Article;

//此Comment屬于Article空間的元素
class Comment { }

//創(chuàng)建一個(gè)名為'MessageBoard'的命名空間
namespace MessageBoard;

//此Comment屬于MessageBoard空間的元素
class Comment { }
?>

在不同空間之間不可以直接調(diào)用其它元素，需要使用命名空間的語(yǔ)法：

復(fù)制代碼代碼如下:

<?php

namespace Article;

class Comment { }

namespace MessageBoard;

class Comment { }

//調(diào)用當(dāng)前空間（MessageBoard）的Comment類
$comment = new Comment();

//調(diào)用Article空間的Comment類
$article_comment = new \Article\Comment();

可以看到，在MessageBoard空間中調(diào)用article空間里的Comment類時(shí)，使用了一種像文件路徑的語(yǔ)法： \空間名\元素名

除了類之外，對(duì)函數(shù)和常量的用法是一樣的，下面我為兩個(gè)空間創(chuàng)建了新的元素，并在MessageBoard空間中輸出了它們的值。

復(fù)制代碼代碼如下:

<?php

namespace Article;

const PATH = '/article';

function getCommentTotal() {
return 100;
}

class Comment { }

namespace MessageBoard;

const PATH = '/message_board';

function getCommentTotal() {
return 300;
}

class Comment { }

//調(diào)用當(dāng)前空間的常量、函數(shù)和類
echo PATH; ///message_board
echo getCommentTotal(); //300
$comment = new Comment();

//調(diào)用Article空間的常量、函數(shù)和類
echo \Article\PATH; ///article
echo \Article\getCommentTotal(); //100
$article_comment = new \Article\Comment();

然后我的確得到了Article空間的元素?cái)?shù)據(jù)。

子空間
命名空間的調(diào)用語(yǔ)法像文件路徑一樣是有道理的，它允許我們自定義子空間來描述各個(gè)空間之間的關(guān)系。

抱歉我忘了說，article和message board這兩個(gè)模塊其實(shí)都是處于同一個(gè)blog項(xiàng)目?jī)?nèi)。如果用命名空間來表達(dá)它們的關(guān)系，是這樣：

復(fù)制代碼代碼如下:

<?php

//我用這樣的命名空間表示處于blog下的article模塊
namespace Blog\Article;

class Comment { }

//我用這樣的命名空間表示處于blog下的message board模塊
namespace Blog\MessageBoard;

class Comment { }

//調(diào)用當(dāng)前空間的類
$comment = new Comment();

//調(diào)用Blog\Article空間的類
$article_comment = new \Blog\Article\Comment();

而且，子空間還可以定義很多層次，比如說 Blog\Article\Archives\Date

公共空間
我有一個(gè)common_inc.php腳本文件，里面有一些好用的函數(shù)和類：

復(fù)制代碼代碼如下:

<?php

function getIP() { }

class FilterXSS { }

在一個(gè)命名空間里引入這個(gè)腳本，腳本里的元素不會(huì)歸屬到這個(gè)命名空間。如果這個(gè)腳本里沒有定義其它命名空間，它的元素就始終處于公共空間中：

復(fù)制代碼代碼如下:

<?php

namespace Blog\Article;

//引入腳本文件
include './common_inc.php';

$filter_XSS = new FilterXSS(); //出現(xiàn)致命錯(cuò)誤：找不到Blog\Article\FilterXSS類

$filter_XSS = new \FilterXSS(); //正確

調(diào)用公共空間的方式是直接在元素名稱前加 \ 就可以了，否則PHP解析器會(huì)認(rèn)為我想調(diào)用當(dāng)前空間下的元素。除了自定義的元素，還包括PHP自帶的元素，都屬于公共空間。

要提一下，其實(shí)公共空間的函數(shù)和常量不用加 \ 也可以正常調(diào)用（不明白PHP為什么要這樣做），但是為了正確區(qū)分元素，還是建議調(diào)用函數(shù)的時(shí)候加上 \

名稱術(shù)語(yǔ)
在說別名和導(dǎo)入之前，需要知道關(guān)于空間三種名稱的術(shù)語(yǔ)，以及PHP是怎樣解析它們的。官方文檔說得非常好，我就直接拿來套了。

1.非限定名稱，或不包含前綴的類名稱，例如 $comment = new Comment();。如果當(dāng)前命名空間是Blog\Article，Comment將被解析為Blog\Article\Comment。如果使用Comment的代碼不包含在任何命名空間中的代碼（全局空間中），則Comment會(huì)被解析為Comment。

2.限定名稱，或包含前綴的名稱，例如 $comment = new Article\Comment();。如果當(dāng)前的命名空間是Blog，則Comment會(huì)被解析為Blog\Article\Comment。如果使用Comment的代碼不包含在任何命名空間中的代碼（全局空間中），則Comment會(huì)被解析為Comment。

3.完全限定名稱，或包含了全局前綴操作符的名稱，例如 $comment = new \Article\Comment();。在這種情況下，Comment總是被解析為代碼中的文字名(literal name)Article\Comment。

其實(shí)可以把這三種名稱類比為文件名（例如 comment.php）、相對(duì)路徑名（例如 ./article/comment.php）、絕對(duì)路徑名（例如 /blog/article/comment.php），這樣可能會(huì)更容易理解。

我用了幾個(gè)示例來表示它們：

復(fù)制代碼代碼如下:

<?php

//創(chuàng)建空間Blog
namespace Blog;

class Comment { }

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

//限定名稱，表示相對(duì)于Blog空間
//這個(gè)調(diào)用將被解析成 Blog\Article\Comment();
$article_comment = new Article\Comment(); //類前面沒有反斜桿\

//完全限定名稱，表示絕對(duì)于Blog空間
//這個(gè)調(diào)用將被解析成 Blog\Comment();
$article_comment = new \Blog\Comment(); //類前面有反斜桿\

//完全限定名稱，表示絕對(duì)于Blog空間
//這個(gè)調(diào)用將被解析成 Blog\Article\Comment();
$article_comment = new \Blog\Article\Comment(); //類前面有反斜桿\

//創(chuàng)建Blog的子空間Article
namespace Blog\Article;

class Comment { }

其實(shí)之前我就一直在使用非限定名稱和完全限定名稱，現(xiàn)在它們終于可以叫出它們的名稱了。

別名和導(dǎo)入
別名和導(dǎo)入可以看作是調(diào)用命名空間元素的一種快捷方式。PHP并不支持導(dǎo)入函數(shù)或常量。

它們都是通過使用use操作符來實(shí)現(xiàn)：

復(fù)制代碼代碼如下:

<?php

namespace Blog\Article;

class Comment { }

//創(chuàng)建一個(gè)BBS空間（我有打算開個(gè)論壇）
namespace BBS;

//導(dǎo)入一個(gè)命名空間
use Blog\Article;
//導(dǎo)入命名空間后可使用限定名稱調(diào)用元素
$article_comment = new Article\Comment();

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

//導(dǎo)入一個(gè)類
use Blog\Article\Comment;
//導(dǎo)入類后可使用非限定名稱調(diào)用元素
$article_comment = new Comment();

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

我注意到，如果導(dǎo)入元素的時(shí)候，當(dāng)前空間有相同的名字元素將會(huì)怎樣？顯然結(jié)果會(huì)發(fā)生致命錯(cuò)誤。

例：

復(fù)制代碼代碼如下:

<?php

namespace Blog\Article;

class Comment { }

namespace BBS;

class Comment { }

Class Comt { }

//導(dǎo)入一個(gè)類
use Blog\Article\Comment;
$article_comment = new Comment(); //與當(dāng)前空間的Comment發(fā)生沖突，程序產(chǎn)生致命錯(cuò)誤

//為類使用別名
use Blog\Article\Comment as Comt;
$article_comment = new Comt(); //與當(dāng)前空間的Comt發(fā)生沖突，程序產(chǎn)生致命錯(cuò)誤

動(dòng)態(tài)調(diào)用
PHP提供了namespace關(guān)鍵字和__NAMESPACE__魔法常量動(dòng)態(tài)的訪問元素，__NAMESPACE__可以通過組合字符串的形式來動(dòng)態(tài)訪問：

復(fù)制代碼代碼如下:

<?php

namespace Blog\Article;

const PATH = '/Blog/article';

class Comment { }

//namespace關(guān)鍵字表示當(dāng)前空間
echo namespace\PATH; ///Blog/article
$comment = new namespace\Comment();

//魔法常量__NAMESPACE__的值是當(dāng)前空間名稱
echo __NAMESPACE__; //Blog\Article
//可以組合成字符串并調(diào)用
$comment_class_name = __NAMESPACE__ . '\Comment';
$comment = new $comment_class_name();

字符串形式調(diào)用問題

上面的動(dòng)態(tài)調(diào)用的例子中，我們看到了字符串形式的動(dòng)態(tài)調(diào)用方式，如果要使用這種方式要注意兩個(gè)問題。

1. 使用雙引號(hào)的時(shí)候特殊字符可能被轉(zhuǎn)義

復(fù)制代碼代碼如下:

<?php

namespace Blog\Article;

class name { }

//我是想調(diào)用Blog\Article\name
$class_name = __NAMESPACE__ . "\name"; //但是\n將被轉(zhuǎn)義為換行符

$name = new $class_name(); //發(fā)生致命錯(cuò)誤

2. 不會(huì)認(rèn)為是限定名稱

PHP在編譯腳本的時(shí)候就確定了元素所在的空間，以及導(dǎo)入的情況。而在解析腳本時(shí)字符串形式調(diào)用只能認(rèn)為是非限定名稱和完全限定名稱，而永遠(yuǎn)不可能是限定名稱。

復(fù)制代碼代碼如下:

<?php

namespace Blog;

//導(dǎo)入Common類
use Blog\Article\Common;
//我想使用非限定名稱調(diào)用Blog\Article\Common
$common_class_name = 'Common';
//實(shí)際會(huì)被當(dāng)作非限定名稱，也就表示當(dāng)前空間的Common類，但我當(dāng)前類沒有創(chuàng)建Common類
$common = new $common_class_name(); //發(fā)生致命錯(cuò)誤：Common類不存在

//我想使用限定名稱調(diào)用Blog\Article\Common
$common_class_name = 'Article\Common';
//實(shí)際會(huì)被當(dāng)作完全限定名稱，也就表示Article空間下的Common類，但我下面只定義了Blog\Article空間而不是Article空間
$common = new $common_class_name(); //發(fā)生致命錯(cuò)誤：Article\Common類不存在

namespace Blog\Article;

class Common { }

總結(jié)
我對(duì)PHP的命名空間剛剛接觸，也不能隨便給一些沒有實(shí)踐的建議。我個(gè)人認(rèn)為命名空間的作用和功能都很強(qiáng)大，如果要寫插件或者通用庫(kù)的時(shí)候再也不用擔(dān)心重名問題。不過如果項(xiàng)目進(jìn)行到一定程度，要通過增加命名空間去解決重名問題，我覺得工作量不會(huì)比重構(gòu)名字少。也不得不承認(rèn)它的語(yǔ)法會(huì)對(duì)項(xiàng)目增加一定的復(fù)雜度，因此從項(xiàng)目一開始的時(shí)候就應(yīng)該很好的規(guī)劃它，并制定一個(gè)命名規(guī)范。

您可能感興趣的文章: