PHP命名空间（Namespace）初探

探完闭包[查看]，再探命名空间。

对于命名空间，官方文档已经说得很详细[查看]，我在这里做了一下实践和总结。

命名空间一个最明确的目的就是解决重名问题，PHP中不允许两个函数或者类出现相同的名字，否则会产生一个致命的错误。这种情况下只要避免命名重复就可以解决，最常见的一种做法是约定一个前缀。

例：项目中有两个模块：article和message board，它们各自有一个处理用户留言的类Comment。之后我可能想要增加对所有用户留言的一些信息统计功能，比如说我想得到所有留言的数量。这时候调用它们Comment提供的方法是很好的做法，但是同时引入各自的Comment类显然是不行的，代码会出错，在另一个地方重写任何一个Comment也会降低维护性。那这时只能重构类名，我约定了一个命名规则，在类名前面加上模块名，像这样：Article_Comment、MessageBoard_Comment

可以看到，名字变得很长，那意味着以后使用Comment的时候会写上更多的代码（至少字符多了）。并且，以后如果要对各个模块增加更多的一些整合功能，或者是互相调用，发生重名的时候就需要重构名字。当然在项目开始的时候就注意到这个问题，并规定命名规则就能很好的避免这个问题。另一个解决方法可以考虑使用命名空间。

 

注明：

本文提到的常量：PHP5.3开始const关键字可以用在类的外部。const和define都是用来声明常量的（它们的区别不详述），但是在命名空间里，define的作用是全局的，而const则作用于当前空间。我在文中提到的常量是指使用const声明的常量。

 

 

基础

命名空间将代码划分出不同的空间（区域），每个空间的常量、函数、类（为了偷懒，我下边都将它们称为元素）的名字互不影响， 这个有点类似我们常常提到的‘封装’的概念。

创建一个命名空间需要使用namespace关键字，这样：

<span style="color: #000000;">php

</span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个名为'Article'的命名空间</span>
<span style="color: #000000;">namespace Article;

</span>?>

 

要注意的是，当前脚本文件的第一个命名空间前面不能有任何代码，下面的写法都是错误的：

<span style="color: #008000;">//</span><span style="color: #008000;">例一
//在脚本前面写了一些逻辑代码</span>

<span style="color: #000000;">php

</span><span style="color: #800080;">$path</span> = "/"<span style="color: #000000;">;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

namespace Article;

</span>?>
<br>

<span style="color: #008000;">//</span><span style="color: #008000;">例二
//在脚本前面输出了一些字符</span>


<span style="color: #000000;">php

namespace Article;

</span>?>

 

为什么要说第一个命名空间呢？因为同一脚本文件中可以创建多个命名空间。

下面我创建了两个命名空间，顺便为这两个空间各自添加了一个Comment类元素：

<span style="color: #000000;">php

</span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个名为'Article'的命名空间</span>
<span style="color: #000000;">namespace Article;

</span><span style="color: #008000;">//</span><span style="color: #008000;">此Comment属于Article空间的元素</span>
<span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }



</span><span style="color: #008000;">//</span><span style="color: #008000;">创建一个名为'MessageBoard'的命名空间</span>
<span style="color: #000000;">namespace MessageBoard;

</span><span style="color: #008000;">//</span><span style="color: #008000;">此Comment属于MessageBoard空间的元素</span>
<span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }
</span>?>

 

在不同空间之间不可以直接调用其它元素，需要使用命名空间的语法：

<span style="color: #000000;">php

namespace Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }



namespace MessageBoard;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用当前空间（MessageBoard）的Comment类</span>
<span style="color: #800080;">$comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用Article空间的Comment类</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> \Article\Comment();

</span>?>

 

可以看到，在MessageBoard空间中调用article空间里的Comment类时，使用了一种像文件路径的语法： \空间名\元素名

除了类之外，对函数和常量的用法是一样的，下面我为两个空间创建了新的元素，并在MessageBoard空间中输出了它们的值。

<span style="color: #000000;">php

namespace Article;

</span><span style="color: #0000ff;">const</span> PATH = '/article'<span style="color: #000000;">;

</span><span style="color: #0000ff;">function</span><span style="color: #000000;"> getCommentTotal() {
    </span><span style="color: #0000ff;">return</span> 100<span style="color: #000000;">;
}

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }




namespace MessageBoard;

</span><span style="color: #0000ff;">const</span> PATH = '/message_board'<span style="color: #000000;">;

</span><span style="color: #0000ff;">function</span><span style="color: #000000;"> getCommentTotal() {
    </span><span style="color: #0000ff;">return</span> 300<span style="color: #000000;">;
}

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用当前空间的常量、函数和类</span>
<span style="color: #0000ff;">echo</span> PATH; <span style="color: #008000;">//</span><span style="color: #008000;">/message_board</span>
<span style="color: #0000ff;">echo</span> getCommentTotal(); <span style="color: #008000;">//</span><span style="color: #008000;">300</span>
<span style="color: #800080;">$comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用Article空间的常量、函数和类</span>
<span style="color: #0000ff;">echo</span> \Article\PATH; <span style="color: #008000;">//</span><span style="color: #008000;">/article</span>
<span style="color: #0000ff;">echo</span> \Article\getCommentTotal(); <span style="color: #008000;">//</span><span style="color: #008000;">100</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> \Article\Comment();

</span>?>

 

然后我的确得到了Article空间的元素数据。

 

 

子空间

命名空间的调用语法像文件路径一样是有道理的，它允许我们自定义子空间来描述各个空间之间的关系。

抱歉我忘了说，article和message board这两个模块其实都是处于同一个blog项目内。如果用命名空间来表达它们的关系，是这样：

<span style="color: #000000;">php

</span><span style="color: #008000;">//</span><span style="color: #008000;">我用这样的命名空间表示处于blog下的article模块</span>
<span style="color: #000000;">namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }



</span><span style="color: #008000;">//</span><span style="color: #008000;">我用这样的命名空间表示处于blog下的message board模块</span>
<span style="color: #000000;">namespace Blog\MessageBoard;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用当前空间的类</span>
<span style="color: #800080;">$comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">调用Blog\Article空间的类</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> \Blog\Article\Comment();

</span>?>

而且，子空间还可以定义很多层次，比如说 Blog\Article\Archives\Date

 

 

公共空间

我有一个common_inc.php脚本文件，里面有一些好用的函数和类：

<span style="color: #000000;">php

</span><span style="color: #0000ff;">function</span><span style="color: #000000;"> getIP() { }

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> FilterXSS { }

</span>?>

 

在一个命名空间里引入这个脚本，脚本里的元素不会归属到这个命名空间。如果这个脚本里没有定义其它命名空间，它的元素就始终处于公共空间中：

<span style="color: #000000;">php

namespace Blog\Article;

</span><span style="color: #008000;">//</span><span style="color: #008000;">引入脚本文件</span>
<span style="color: #0000ff;">include</span> './common_inc.php'<span style="color: #000000;">;

</span><span style="color: #800080;">$filter_XSS</span> = <span style="color: #0000ff;">new</span> FilterXSS(); <span style="color: #008000;">//</span><span style="color: #008000;">出现致命错误：找不到Blog\Article\FilterXSS类</span>

<span style="color: #800080;">$filter_XSS</span> = <span style="color: #0000ff;">new</span> \FilterXSS(); <span style="color: #008000;">//</span><span style="color: #008000;">正确</span>


?>

 

调用公共空间的方式是直接在元素名称前加 \ 就可以了，否则PHP解析器会认为我想调用当前空间下的元素。除了自定义的元素，还包括PHP自带的元素，都属于公共空间。

要提一下，其实公共空间的函数和常量不用加 \ 也可以正常调用（不明白PHP为什么要这样做），但是为了正确区分元素，还是建议调用函数的时候加上 \ 

 

 

名称术语

在说别名和导入之前，需要知道关于空间三种名称的术语，以及PHP是怎样解析它们的。官方文档说得非常好，我就直接拿来套了。

1. 非限定名称，或不包含前缀的类名称，例如 $comment = new Comment();。如果当前命名空间是Blog\Article，Comment将被解析为Blog\Article\Comment。如果使用Comment的代码不包含在任何命名空间中的代码（全局空间中），则Comment会被解析为Comment。
2. 限定名称，或包含前缀的名称，例如 $comment = new Article\Comment();。如果当前的命名空间是Blog，则Comment会被解析为Blog\Article\Comment。如果使用Comment的代码不包含在任何命名空间中的代码（全局空间中），则Comment会被解析为Comment。
3. 完全限定名称，或包含了全局前缀操作符的名称，例如 $comment = new \Article\Comment();。在这种情况下，Comment总是被解析为代码中的文字名(literal name)Article\Comment。

 

其实可以把这三种名称类比为文件名（例如 comment.php）、相对路径名（例如 ./article/comment.php）、绝对路径名（例如 /blog/article/comment.php），这样可能会更容易理解。

我用了几个示例来表示它们：

<span style="color: #000000;">php

</span><span style="color: #008000;">//</span><span style="color: #008000;">创建空间Blog</span>
<span style="color: #000000;">namespace Blog;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

</span><span style="color: #008000;">//</span><span style="color: #008000;">非限定名称，表示当前Blog空间
//这个调用将被解析成 Blog\Comment();</span>
<span style="color: #800080;">$blog_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">限定名称，表示相对于Blog空间
//这个调用将被解析成 Blog\Article\Comment();</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span> Article\Comment(); <span style="color: #008000;">//类</span><span style="color: #008000;">前面没有反斜杆\

//完全限定名称，表示绝对于Blog空间
//这个调用将被解析成 Blog\Comment();</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span> \Blog\Comment(); <span style="color: #008000;">//类</span><span style="color: #008000;">前面有反斜杆\

//完全限定名称，表示绝对于Blog空间
//这个调用将被解析成 Blog\Article\Comment();</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span> \Blog\Article\Comment(); <span style="color: #008000;">//类</span><span style="color: #008000;">前面有反斜杆\



//创建Blog的子空间Article</span>
<span style="color: #000000;">namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }


</span>?>

 

其实之前我就一直在使用非限定名称和完全限定名称，现在它们终于可以叫出它们的名称了。

 

别名和导入

别名和导入可以看作是调用命名空间元素的一种快捷方式。PHP并不支持导入函数或常量。

它们都是通过使用use操作符来实现：

<span style="color: #000000;">php

namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }



</span><span style="color: #008000;">//创建一个BBS空间（我有打算开个论坛）</span>
<span style="color: #000000;">namespace BBS;

</span><span style="color: #008000;">//</span><span style="color: #008000;">导入一个命名空间</span>
<span style="color: #0000ff;">use</span><span style="color: #000000;"> Blog\Article;
</span><span style="color: #008000;">//</span><span style="color: #008000;">导入命名空间后可使用限定名称调用元素</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Article\Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">为命名空间使用别名</span>
<span style="color: #0000ff;">use</span> Blog\Article <span style="color: #0000ff;">as</span><span style="color: #000000;"> Arte;
</span><span style="color: #008000;">//</span><span style="color: #008000;">使用别名代替空间名</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Arte\Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">导入一个类</span>
<span style="color: #0000ff;">use</span><span style="color: #000000;"> Blog\Article\Comment;
</span><span style="color: #008000;">//</span><span style="color: #008000;">导入类后可使用非限定名称调用元素</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">为类使用别名</span>
<span style="color: #0000ff;">use</span> Blog\Article\Comment <span style="color: #0000ff;">as</span><span style="color: #000000;"> Comt;
</span><span style="color: #008000;">//</span><span style="color: #008000;">使用别名代替空间名</span>
<span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> Comt();

</span>?>

 

我注意到，如果导入元素的时候，当前空间有相同的名字元素将会怎样？显然结果会发生致命错误。

例：

<span style="color: #000000;">php

namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }



namespace BBS;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }

</span><span style="color: #0000ff;">Class</span><span style="color: #000000;"> Comt { }


</span><span style="color: #008000;">//</span><span style="color: #008000;">导入一个类</span>
<span style="color: #0000ff;">use</span><span style="color: #000000;"> Blog\Article\Comment;
</span><span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span> Comment(); <span style="color: #008000;">//</span><span style="color: #008000;">与当前空间的Comment发生冲突，程序产生致命错误

//为类使用别名</span>
<span style="color: #0000ff;">use</span> Blog\Article\Comment <span style="color: #0000ff;">as</span><span style="color: #000000;"> Comt;
</span><span style="color: #800080;">$article_comment</span> = <span style="color: #0000ff;">new</span> Comt(); <span style="color: #008000;">//</span><span style="color: #008000;">与当前空间的Comt发生冲突，程序产生致命错误</span>

?>

 

 

动态调用

PHP提供了namespace关键字和__NAMESPACE__魔法常量动态的访问元素，__NAMESPACE__可以通过组合字符串的形式来动态访问：

<span style="color: #000000;">php

namespace Blog\Article;

</span><span style="color: #0000ff;">const</span> PATH = '/Blog/article'<span style="color: #000000;">;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Comment { }


</span><span style="color: #008000;">//</span><span style="color: #008000;">namespace关键字表示当前空间</span>
<span style="color: #0000ff;">echo</span> namespace\PATH; <span style="color: #008000;">//</span><span style="color: #008000;">/Blog/article</span>
<span style="color: #800080;">$comment</span> = <span style="color: #0000ff;">new</span><span style="color: #000000;"> namespace\Comment();

</span><span style="color: #008000;">//</span><span style="color: #008000;">魔法常量__NAMESPACE__的值是当前空间名称</span>
<span style="color: #0000ff;">echo</span> __NAMESPACE__; <span style="color: #008000;">//</span><span style="color: #008000;">Blog\Article
//可以组合成字符串并调用</span>
<span style="color: #800080;">$comment_class_name</span> = __NAMESPACE__ . '\Comment'<span style="color: #000000;">;
</span><span style="color: #800080;">$comment</span> = <span style="color: #0000ff;">new</span> <span style="color: #800080;">$comment_class_name</span><span style="color: #000000;">();

</span>?>

 

字符串形式调用问题

上面的动态调用的例子中，我们看到了字符串形式的动态调用方式，如果要使用这种方式要注意两个问题。

1. 使用双引号的时候特殊字符可能被转义

<span style="color: #000000;">php

namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> name { }

</span><span style="color: #008000;">//</span><span style="color: #008000;">我是想调用Blog\Article\name</span>
<span style="color: #800080;">$class_name</span> = __NAMESPACE__ . "\name"; <span style="color: #008000;">//</span><span style="color: #008000;">但是\n将被转义为换行符</span>

<span style="color: #800080;">$name</span> = <span style="color: #0000ff;">new</span> <span style="color: #800080;">$class_name</span>(); <span style="color: #008000;">//</span><span style="color: #008000;">发生致命错误</span>

?>

 

2. 不会认为是限定名称

PHP在编译脚本的时候就确定了元素所在的空间，以及导入的情况。而在解析脚本时字符串形式调用只能认为是非限定名称和完全限定名称，而永远不可能是限定名称。

<span style="color: #000000;">php

namespace Blog;

</span><span style="color: #008000;">//</span><span style="color: #008000;">导入Common类</span>
<span style="color: #0000ff;">use</span><span style="color: #000000;"> Blog\Article\Common;
</span><span style="color: #008000;">//</span><span style="color: #008000;">我想使用非限定名称调用Blog\Article\Common</span>
<span style="color: #800080;">$common_class_name</span> = 'Common'<span style="color: #000000;">;
</span><span style="color: #008000;">//</span><span style="color: #008000;">实际会被当作非限定名称，也就表示当前空间的Common类，但我当前类没有创建Common类</span>
<span style="color: #800080;">$common</span> = <span style="color: #0000ff;">new</span> <span style="color: #800080;">$common_class_name</span>(); <span style="color: #008000;">//</span><span style="color: #008000;">发生致命错误：Common类不存在

//我想使用限定名称调用Blog\Article\Common</span>
<span style="color: #800080;">$common_class_name</span> = 'Article\Common'<span style="color: #000000;">;
</span><span style="color: #008000;">//</span><span style="color: #008000;">实际会被当作完全限定名称，也就表示Article空间下的Common类，但我下面只定义了Blog\Article空间而不是Article空间</span>
<span style="color: #800080;">$common</span> = <span style="color: #0000ff;">new</span> <span style="color: #800080;">$common_class_name</span>(); <span style="color: #008000;">//</span><span style="color: #008000;">发生致命错误：Article\Common类不存在</span>
<span style="color: #000000;">

namespace Blog\Article;

</span><span style="color: #0000ff;">class</span><span style="color: #000000;"> Common { }

</span>?>

 

 

总结

我对PHP的命名空间刚刚接触，也不能随便给一些没有实践的建议。我个人认为命名空间的作用和功能都很强大，如果要写插件或者通用库的时候再也不用担心重名问题。不过如果项目进行到一定程度，要通过增加命名空间去解决重名问题，我觉得工作量不会比重构名字少。也不得不承认它的语法会对项目增加一定的复杂度，因此从项目一开始的时候就应该很好的规划它，并制定一个命名规范。