PHP定名空间(Namespace)的利用详解

发布日期:2019-07-23 19:56:43 阅读数: 356次 来源: 作者:

定名空间一个最明白的目标就是处理重名问题,PHP中不答应两个函数或者类呈现不异的名字,不然会发生一个致命的错误。这种环境下只需避免定名反复就能够处理,最常见的一种做法是商定一个前缀。

例:项目中有两个模块:article和message board,它们各自有一个处置用户留言的类Comment。之后我可能想要添加对所有用户留言的一些消息统计功能,好比说我想获得所有留言的数量。这时候挪用它们Comment供给的方式是很好的做法,可是同时引入各自的Comment类明显是不可的,代码会犯错,在另一个处所重写任何一个Comment也会降低维护性。那这时只能重构类名,我商定了一个定名法则,在类名前面加上模块名,像如许:Article_Comment、MessageBoard_Comment

能够看到,名字变得很长,那意味着当前利用Comment的时候会写上更多的代码(至多字符多了)。而且,当前若是要对各个模块添加更多的一些整合功能,或者是互相挪用,发生重名的时候就需要重构名字。当然在项目起头的时候就留意到这个问题,并划定定名法则就能很好的避免这个问题。另一个处理方式能够考虑利用定名空间。

说明:本文提到的常量:PHP5.3起头const环节字能够用在类的外部。const和define都是用来声明常量的(它们的区别不详述),可是在定名空间里,define的感化是全局的,而const则感化于当前空间。我在文中提到的常量是指利用const声明的常量。

根本

定名空间将代码划分出分歧的空间(区域),每个空间的常量、函数、类(为了偷懒,我下边都将它们称为元素)的名字互不影响, 这个有点雷同我们常常提到的'封装'的概念。

建立一个定名空间需要利用namespace环节字,如许:

<?php
//建立一个名为'Article'的定名空间
namespace Article;
?>

要留意的是,当前脚本文件的第一个定名空间前面不克不及有任何代码,下面的写法都是错误的:

例一

//在脚本前面写了一些逻辑代码
<?php
$path = "/";
class Comment { }
namespace Article;
?>

例二

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

子空间

定名空间的挪用语法像文件路径一样是有事理的,它答应我们自定义子空间来描述各个空间之间的关系。

抱愧我忘了说,article和message 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\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),如许可能会更容易理解。

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

<?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的定名空间方才接触,也不克不及随便给一些没有实践的建议。我小我认为定名空间的感化和功能都很强大,若是要写插件或者通用库的时候再也不消担忧重名问题。不外若是项目进行到必然程度,要通过添加定名空间去处理重名问题,我感觉工作量不会比重构名字少。也不得不认可它的语法会对项目添加必然的复杂度,因而从项目一起头的时候就该当很好的规划它,并制定一个定名规范。

本文由亚博手机app编辑整理亚博手机app