PHP的命名空间使用详解

PHP的命名空间（namespace）是php5.3之后才有的。这个概念在C#中已经很早就有了，php中的namespace其实和c#的概念是一样的。

为什么php中要使用namespace？

假设如果不使用namespace，那么每个类在一个项目中的名字就必须是固定的。因为php在new的时候不管是调用autoload还是调用已加载过的类，都存在一个类名对应的文件。所以在没有namespace的时候，我们会想各种命名规则来区分不同的类，比如project1_school1_class1_Student或者project2_school_class_Student。

引入namespace之后就可以将这个有效规避了，一个namespace就相当于对应一个文件路径，查找这个类的时候，就会去对应的文件路径查找类定义文件了。

注明：

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

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

namespace的定义和使用

定义：

 
namespace Myproject;
或者

 
namespace Myproject {
 
}
使用：

 
use Myproject/School;
 
use Myproject/Schoolas School1;  // 别名
命名空间是运行时解析的。use就相当于一种声明，并不解析和加载。比如下面这个例子：

test.php

use myname;
require_once("/home/yejianfeng/handcode/test/namespace1.php");
$a =new mynameA();
$a->Print1();
namespace1.php

namespace myname;
class A {
        public function Print1(){
                echo 11;
        }
}

虽然require_once在use下面，也是可以正常运行的，因为程序只有在new mynameA()的时候才去加载命名空间myname

全局类和命名空间类

如果要new一个全局类使用 new A()

如果要new一个命名空间类，使用new mynamespaceA()

命名空间的顺序

自从有了命名空间之后，最容易出错的该是使用类的时候，这个类的寻找路径是什么样的了。

如果能弄清楚manual中的这个例子就能全部弄清楚寻找顺序了。

namespace A;
use BD, CEas F;
 
// 函数调用
 
foo();      // 首先尝试调用定义在命名空间"A"中的函数foo()
            // 再尝试调用全局函数 "foo"
 
foo();     // 调用全局空间函数 "foo"
 
myfoo();   // 调用定义在命名空间"Amy"中函数 "foo"
 
F();        // 首先尝试调用定义在命名空间"A"中的函数 "F"
            // 再尝试调用全局函数 "F"
 
// 类引用
 
new B();   // 创建命名空间 "A" 中定义的类 "B" 的一个对象
            // 如果未找到，则尝试自动装载类 "AB"
 
new D();   // 使用导入规则，创建命名空间 "B" 中定义的类 "D" 的一个对象
            // 如果未找到，则尝试自动装载类 "BD"
 
new F();   // 使用导入规则，创建命名空间 "C" 中定义的类 "E" 的一个对象
            // 如果未找到，则尝试自动装载类 "CE"
 
new B();  // 创建定义在全局空间中的类 "B" 的一个对象
            // 如果未发现，则尝试自动装载类 "B"
 
new D();  // 创建定义在全局空间中的类 "D" 的一个对象
            // 如果未发现，则尝试自动装载类 "D"
 
new F();  // 创建定义在全局空间中的类 "F" 的一个对象
            // 如果未发现，则尝试自动装载类 "F"
 
// 调用另一个命名空间中的静态方法或命名空间函数
 
Bfoo();    // 调用命名空间 "AB" 中函数 "foo"
 
B::foo();   // 调用命名空间 "A" 中定义的类 "B" 的 "foo" 方法
            // 如果未找到类 "AB" ，则尝试自动装载类 "AB"
 
D::foo();   // 使用导入规则，调用命名空间 "B" 中定义的类 "D" 的 "foo" 方法
            // 如果类 "BD" 未找到，则尝试自动装载类 "BD"
 
Bfoo();   // 调用命名空间 "B" 中的函数 "foo"
 
B::foo();  // 调用全局空间中的类 "B" 的 "foo" 方法
            // 如果类 "B" 未找到，则尝试自动装载类 "B"
 
// 当前命名空间中的静态方法或函数
 
AB::foo();   // 调用命名空间 "AA" 中定义的类 "B" 的 "foo" 方法
              // 如果类 "AAB" 未找到，则尝试自动装载类 "AAB"
 
AB::foo();  // 调用命名空间 "AB" 中定义的类 "B" 的 "foo" 方法
              // 如果类 "AB" 未找到，则尝试自动装载类 "AB"
?>

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

 

 

//创建一个名为'Article'的命名空间
namespace Article;

?>

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

 

//例一
//在脚本前面写了一些逻辑代码
 

$path = "/";

class Comment { }

namespace Article;

?>

 

//例二
//在脚本前面输出了一些字符

namespace Article;

?>

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

 

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

 

 

//创建一个名为'Article'的命名空间
namespace Article;

//此Comment属于Article空间的元素
class Comment { }

//创建一个名为'MessageBoard'的命名空间
namespace MessageBoard;

//此Comment属于MessageBoard空间的元素
class Comment { }
?>

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

 

 

namespace Article;

class Comment { }

namespace MessageBoard;

class Comment { }

//调用当前空间（MessageBoard）的Comment类
$comment = new Comment();

//调用Article空间的Comment类
$article_comment = new ArticleComment();

?>

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

 

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

 

 

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空间的元素数据。

 

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

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

 

 

//我用这样的命名空间表示处于blog下的article模块
namespace BlogArticle;

class Comment { }

//我用这样的命名空间表示处于blog下的message board模块
namespace BlogMessageBoard;

class Comment { }

//调用当前空间的类
$comment = new Comment();

//调用BlogArticle空间的类
$article_comment = new BlogArticleComment();

?>

而且，子空间还可以定义很多层次，比如说 BlogArticleArchivesDate

 

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

 

 

function getIP() { }

class FilterXSS { }

?>

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

 

 

namespace BlogArticle;

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

$filter_XSS = new FilterXSS(); //出现致命错误：找不到BlogArticleFilterXSS类

$filter_XSS = new FilterXSS(); //正确

?>

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

 

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

名称术语
在说别名和导入之前，需要知道关于空间三种名称的术语，以及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），这样可能会更容易理解。

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

 

 

//创建空间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操作符来实现：

 

 

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();

?>

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

 

例：

 

 

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__可以通过组合字符串的形式来动态访问：

 

 

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. 使用双引号的时候特殊字符可能被转义

 

 

namespace BlogArticle;

class name { }

//我是想调用BlogArticlename
$class_name = __NAMESPACE__ . "name"; //但是n将被转义为换行符

$name = new $class_name(); //发生致命错误

?>

2. 不会认为是限定名称

 

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