• PHP命名空间(Namespace)的使用详解


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

    命名空间一个最明确的目的就是解决重名问题。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></html>
    <?php 
    //在脚本的前面输出了一些字符
    namespace Article;
    ?>

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

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

    <?php 
    //创建一个名为“Article”的命名空间
    namespace Article;
    //此Comment属于Article空间的元素
    class Comment{}
     
    //创建一个名为“MessageBoard”的命名空间
    namespace MessageBoard;
    //此Comment属于MessageBoard空间元素
    class Comment{}
    ?>

    在不同空间之间不可以直接调用其他元素,需要使用命名空间的语法:

    <?php 
    //创建一个名为“Article”的命名空间
    namespace Article;
    //此Comment属于Article空间的元素
    class Comment{}
     
    //创建一个名为“MessageBoard”的命名空间
    namespace MessageBoard;
    //此Comment属于MessageBoard空间元素
    class Comment{}
     
    //调用当前空间(MessageBoard)的Comment类
    $comment = new Comment();
     
    //调用Article空间的Comment类
    $article_comment = new ArticleComment();
    ?>

    可以看到,在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;
    echo getCommentTotal();
    $comment = new Comment();
     
    //调用Article空间的常量、函数和类
    echo ArticlePATH;
    echo ArticlegetCommentTotal();
    $article_comment = new ArticleComment();
    ?>

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

    Article和message board这两个模块都是处于同一个blog项目内。如果用命名空间来表示它们的关系,是这样:

    <?php 
    //我用这样的命名空间表示处于blog下的article模块
    namespace BlogArticle;
    class Comment{}
     
    //我用这样的命名空间来表示处于blog下的message board模块
    namespace BlogMessageBlog;
    class Comment{}
     
    //调用当前空间的类
    $comment = new Comment();
     
    //调用BlogArticle空间的类
    $article_comment = new BlogArticleComment();
    ?>

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

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

    <?php 
    function getIP(){}
    class FilterXSS{}
    ?>

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

    <?php 
    namespace BlogArticle;
    //引入脚本文件
    include './common_inc.php';
    $filter_XSS = new FilterXSS();//出现致命错误,找不到BlogArticleFilterXSS类
    $filter_XSS = new FilterXSS();//正确
    ?>

    调用公共空间的方式直接在元素名称前加’‘就可以了,否则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),这样可能更容易理解。

     

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

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

    <?php 
    namespace BlogArticle;
    class Comment{}
     
    //创建一个BBS空间
    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__可以通过组合字符串的形式来动态的访问。

    <?php 
    namespace BlogArticle;
    const PATH = '/Blog/article';
    class Comment{}
     
    //namespace关键字表示当前空间
    echo namespacePATH;
    $comment = new namespaceComment();
     
    //魔法常量__NAMESPACE__的值是当前空间的名称
    echo __NAMESPACE__;
     
    //可以组合成字符串并调用
    $comment_class_name = __NAMESPACE__.'Comment';
    $comment = new $comment_class_name();
    ?>

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

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

     

    <?php 
    namespace BlogArticle;
    const PATH = '/Blog/article';
    class name{}
     
    //我想调用BlogArticle ame
    $class_name = __NAMESPACE__." ame";//但是 将被转义为换行符
    $name = new $class_name();//发生致命的错误
    ?>

     

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

     

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

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

     
    namespace BlogArticle;
    class Common{}
    ?>


  • 相关阅读:
    链表的相关操作
    【回溯】旅行商问题
    【回溯】图的m着色问题
    奶牛卧室_待解决
    阶乘问题
    子数整数
    hihoCoder week4 Trie图
    hihoCoder week3 KMP算法
    hihoCoder week2 Trie树
    hihoCoder week1 最长回文子串
  • 原文地址:https://www.cnblogs.com/zhouguowei/p/5200878.html
Copyright © 2020-2023  润新知