文档章节

PHP命名空间(Namespace)初探

豆浆Melon
 豆浆Melon
发布于 2013/05/04 00:47
字数 2924
阅读 3170
收藏 100

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

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

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

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

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

 

注明:

本文提到的常量:PHP5.3开始const关键字可以用在类的外部。constdefine都是用来声明常量的(它们的区别不详述),但是在命名空间里,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 \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; ///message_board
echo getCommentTotal(); //300
$comment = new Comment();

//调用Article空间的常量、函数和类
echo \Article\PATH; ///article
echo \Article\getCommentTotal(); //100
$article_comment = new \Article\Comment();

?>


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

 

 

子空间

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

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

<?php

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

class Comment { }



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

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为什么要这样做),但是为了正确区分元素,还是建议调用函数的时候加上 \ 

 

 

名称术语

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

  1. 非限定名称,或不包含前缀的类名称,例如 $comment = new Comment();。如果当前命名空间是Blog\ArticleComment将被解析为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),这样可能会更容易理解。

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

<?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并不支持导入函数或常量。

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

<?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 { }



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; ///Blog/article
$comment = new namespace\Comment();

//魔法常量__NAMESPACE__的值是当前空间名称
echo __NAMESPACE__; //Blog\Article
//可以组合成字符串并调用
$comment_class_name = __NAMESPACE__ . '\Comment';
$comment = new $comment_class_name();

?>


字符串形式调用问题

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

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

<?php

namespace Blog\Article;

class name { }

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

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

?>


2. 不会认为是限定名称

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

<?php

namespace Blog;

//导入Common类
use Blog\Article\Common;
//我想使用非限定名称调用Blog\Article\Common
$common_class_name = 'Common';
//实际会被当作非限定名称,也就表示当前空间的Common类,但我当前类没有创建Common类
$common = new $common_class_name(); //发生致命错误:Common类不存在

//我想使用限定名称调用Blog\Article\Common
$common_class_name = 'Article\Common';
//实际会被当作完全限定名称,也就表示Article空间下的Common类,但我下面只定义了Blog\Article空间而不是Article空间
$common = new $common_class_name(); //发生致命错误:Article\Common类不存在


namespace Blog\Article;

class Common { }

?>


 

总结

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

 

 

© 著作权归作者所有

共有 人打赏支持
豆浆Melon

豆浆Melon

粉丝 67
博文 8
码字总数 18465
作品 1
广州
程序员
加载中

评论(34)

-rust-
-rust-
总结的很好,学习了。
hyxj1220
hyxj1220
豆浆Melon
豆浆Melon

引用来自“听沨”的评论

[字符串形式调用问题-->>2. 不会认为是限定名称] 的第14行,应该是“下面只定义了Article空间而不是Blog\Article空间”吧?是不是反了?我这里没看懂

第18行是 namespace Blog\Article; 所以是定义Blog\Article空间
如果是只定义Article空间则是 namespace Article;
也就是说, '定义Article空间',它是独立的,不属于Blog的空间,这样不对
听沨
听沨
[字符串形式调用问题-->>2. 不会认为是限定名称] 的第14行,应该是“下面只定义了Article空间而不是Blog\Article空间”吧?是不是反了?我这里没看懂
gannimeiza
gannimeiza

引用来自“阿尔法兽”的评论

引用来自“李惟”的评论

引用来自“阿尔法兽”的评论

引用来自“夏侯仲达”的评论

引用来自“阿尔法兽”的评论

引用来自“G.”的评论

引用来自“阿尔法兽”的评论

感觉PHP就是个杂货铺,这个语言的语法抄一点,那个语言的特点抄一点,就没有自己原创的东西,不伦不类。
吐槽完毕,结论:目前还没必要用,复杂度增加了,也没看到很大的必要性。
不能因为语言有了什么就用什么。好比手里有把锤子,看到什么都是钉子。

并不是所有原创的东西都能做到 有伦有类.

原创总比抄袭好,如果一个语言没有自己的思想只有抄袭或者说模仿,真不以为然。
PHP5里的几乎所有东西和特性都是抄袭。
几乎所有OO特性,如异常、SPL里的迭代器、过滤器抄袭的Java;
命名空间抄袭的C++;
闭包抄袭的JS;
trait 抄袭的ruby和scala;
Generators 抄袭的.Net

如果php能够把这些语言的有点都学到,并运用的得体,那php就快无敌了

腾讯也无敌抄袭王,产品也好,但很难得到别人的尊重

你不是照样在用腾讯的产品嘛?

但我打心底并不佩服腾讯,他是个好商人,但算不上IT界的开拓者和领袖。
所以骂腾讯的也不少。

tx连好商人都算不上, 名副其实的奸商, 中国有好商人吗? 另外你搞错了一点, tx是个彻头彻尾的商业机构, 别人google怎么说也为开源做了贡献的, 而php本身并不是一个商业产品, 这就是 tx 和 php 最大的区别, 所以根本没可比性.
李惟
李惟

引用来自“lifer”的评论

引用来自“李惟”的评论

引用来自“hoho”的评论

引用来自“李惟”的评论

引用来自“李淼”的评论

PHP的namespace结合autoload函数使用,这样对象的namespace就可以按照文件所在目录层级定义或者目录按照namespace构建,Java也是这样处理的,使用起来还是很方便的。但是层级分割符使用“\”就太丑陋了,之前α版使用的“::”都比这个好看。另外导包时使用的use关键字也比较令人烦恼,导入命名空间、闭包引用外部变量、Trait导入都使用use关键字,这很容易产生歧义理解。

想想PHP静态方法怎么调用的你就知道为什么PHP要用"\"而不用"::",朋友PHP还要多看看

点号被用做了字符串连接符,这才是最要命的,不然PHP语法应该不会这么丑陋。

最要命的是所有变量前面要加$,只是所有的写php的程序员都习惯了。

感觉php的代码很乱,有些时候,一个全局变量不知道去哪里找,可能写代码的人,写的不好吧。

是的,一般我都是一个个文件找,其他语言有好的解决方法?比如JS,好像也只能一个个文件找,关键还是看写这个语言的人吧,PHP提倡尽量少用$_GLOBAL
lifer
lifer

引用来自“李惟”的评论

引用来自“hoho”的评论

引用来自“李惟”的评论

引用来自“李淼”的评论

PHP的namespace结合autoload函数使用,这样对象的namespace就可以按照文件所在目录层级定义或者目录按照namespace构建,Java也是这样处理的,使用起来还是很方便的。但是层级分割符使用“\”就太丑陋了,之前α版使用的“::”都比这个好看。另外导包时使用的use关键字也比较令人烦恼,导入命名空间、闭包引用外部变量、Trait导入都使用use关键字,这很容易产生歧义理解。

想想PHP静态方法怎么调用的你就知道为什么PHP要用"\"而不用"::",朋友PHP还要多看看

点号被用做了字符串连接符,这才是最要命的,不然PHP语法应该不会这么丑陋。

最要命的是所有变量前面要加$,只是所有的写php的程序员都习惯了。

感觉php的代码很乱,有些时候,一个全局变量不知道去哪里找,可能写代码的人,写的不好吧。
李惟
李惟

引用来自“hoho”的评论

引用来自“李惟”的评论

引用来自“李淼”的评论

PHP的namespace结合autoload函数使用,这样对象的namespace就可以按照文件所在目录层级定义或者目录按照namespace构建,Java也是这样处理的,使用起来还是很方便的。但是层级分割符使用“\”就太丑陋了,之前α版使用的“::”都比这个好看。另外导包时使用的use关键字也比较令人烦恼,导入命名空间、闭包引用外部变量、Trait导入都使用use关键字,这很容易产生歧义理解。

想想PHP静态方法怎么调用的你就知道为什么PHP要用"\"而不用"::",朋友PHP还要多看看

点号被用做了字符串连接符,这才是最要命的,不然PHP语法应该不会这么丑陋。

最要命的是所有变量前面要加$,只是所有的写php的程序员都习惯了。
h
hoho

引用来自“李惟”的评论

引用来自“李淼”的评论

PHP的namespace结合autoload函数使用,这样对象的namespace就可以按照文件所在目录层级定义或者目录按照namespace构建,Java也是这样处理的,使用起来还是很方便的。但是层级分割符使用“\”就太丑陋了,之前α版使用的“::”都比这个好看。另外导包时使用的use关键字也比较令人烦恼,导入命名空间、闭包引用外部变量、Trait导入都使用use关键字,这很容易产生歧义理解。

想想PHP静态方法怎么调用的你就知道为什么PHP要用"\"而不用"::",朋友PHP还要多看看

点号被用做了字符串连接符,这才是最要命的,不然PHP语法应该不会这么丑陋。
李惟
李惟

引用来自“李淼”的评论

PHP的namespace结合autoload函数使用,这样对象的namespace就可以按照文件所在目录层级定义或者目录按照namespace构建,Java也是这样处理的,使用起来还是很方便的。但是层级分割符使用“\”就太丑陋了,之前α版使用的“::”都比这个好看。另外导包时使用的use关键字也比较令人烦恼,导入命名空间、闭包引用外部变量、Trait导入都使用use关键字,这很容易产生歧义理解。

想想PHP静态方法怎么调用的你就知道为什么PHP要用"\"而不用"::",朋友PHP还要多看看
复习PHP-语言参考-命名空间

1.定义命名空间 命名空间只作用于类,函数,常量。(注意只能是const的常量,而不能是define出来的常量,我测试是报错的。) 通过namespace 声明。 必须在所有代码之前声明。 2.定义子命名空...

qzd1989
2014/05/02
0
0
PHP的命名空间

PHP的命名空间(namespace)是php5.3之后才有的。这个概念在C#中已经很早就有了,php中的namespace其实和c#的概念是一样的。 为什么php中要使用namespace? 假设如果不使用namespace,那么每...

王二狗子11
01/07
0
0
PHP命名空间(Namespace)的使用详解

对于命名空间,官方文档已经说得很详细[查看],我在这里做了一下实践和总结。 命名空间一个最明确的目的就是解决重名问题,PHP中不允许两个函数或者类出现相同的名字,否则会产生一个致命的错...

Surjur
2015/02/12
0
0
PHP之新手自学基础知识(六)——拓展篇之命名空间

命名空间概述 什么是命名空间?从广义上来说,命名空间是一种封装事物的方法。在很多地方都可以见到这种抽象概念。例如,在操作系统中目录用来将相关文件分组,对于目录中的文件来说,它就扮...

天谴残魂
01/09
0
0
PHP之命名空间

从广义上来说,命名空间是一种封装事物的方法。在很多地方都可以见到这种抽象概念。例如,在操作系统中目录用来将相关文件分组,对于目录中的文件来说,它就扮演了命名空间的角色。这个原理应...

jjjssswww
2017/06/06
0
0

没有更多内容

加载失败,请刷新页面

加载更多

白话SpringCloud | 第五章:服务容错保护(Hystrix)

前言 前一章节,我们知道了如何利用RestTemplate+Ribbon和Feign的方式进行服务的调用。在微服务架构中,一个服务可能会调用很多的其他微服务应用,虽然做了多集群部署,但可能还会存在诸如网...

oKong
20分钟前
0
0
【解惑】领略Java内部类的“内部”

内部类有两种情况: (1) 在类中定义一个类(私有内部类,静态内部类) (2) 在方法中定义一个类(局部内部类,匿名内部类) 1、私有内部类 —— 在方法之间定义的内部类,非静态 我们首先看看类中...

偶尔诗文
今天
1
0
sqlserver 2008 r2 直接下载地址(百度云)

之前下载的sqlserver2008发现不能附加,就卸载了,重新找到了sqlserver2008R2的百度云资源 卸载sqlserver2008还是有点麻烦,不过就是需要删除注册表中的信息 自己来回卸载了3次终于重装sqlse...

dillonxiao
今天
1
0
[Java]JVM调优总结 -Xms -Xmx -Xmn -Xss

JVM调优总结 -Xms -Xmx -Xmn -Xss 博客分类: Java General JVM应用服务器电信CMS算法 堆大小设置 JVM 中最大堆大小有三方面限制:相关操作系统的数据模型(32-bt还是64-bit)限制;系统的可...

morpheusWB
今天
2
0
C++ std::function 和 std::bind

C++11提供了std::function和std::bind两个工具,用于引用可调用对象。这些可调用对象包括 普通函数,Lambda表达式,类的静态成员函数,非静态成员函数以及仿函数等。引用可调用对象,可以用于...

yepanl
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部