电竞比分网-中国电竞赛事及体育赛事平台

分享

PHP命名空間(Namespace)的使用詳解_腳本之家

 小喬先僧 2016-04-13
  對于命名空間,官方文檔已經(jīng)說得很詳細(xì)[查看],我在這里做了一下實踐和總結(jié)。

  undefined

  命名空間一個最明確的目的就是解決重名問題,PHP中不允許兩個函數(shù)或者類出現(xiàn)相同的名字,否則會產(chǎn)生一個致命的錯誤。這種情況下只要避免命名重復(fù)就可以解決,最常見的一種做法是約定一個前綴。

  例:項目中有兩個模塊:article和message board,它們各自有一個處理用戶留言的類Comment。之后我可能想要增加對所有用戶留言的一些信息統(tǒng)計功能,比如說我想得到所有留言的數(shù)量。這時候調(diào)用它們Comment提供的方法是很好的做法,但是同時引入各自的Comment類顯然是不行的,代碼會出錯,在另一個地方重寫任何一個Comment也會降低維護性。那這時只能重構(gòu)類名,我約定了一個命名規(guī)則,在類名前面加上模塊名,像這樣:Article_Comment、MessageBoard_Comment

  可以看到,名字變得很長,那意味著以后使用Comment的時候會寫上更多的代碼(至少字符多了)。并且,以后如果要對各個模塊增加更多的一些整合功能,或者是互相調(diào)用,發(fā)生重名的時候就需要重構(gòu)名字。當(dāng)然在項目開始的時候就注意到這個問題,并規(guī)定命名規(guī)則就能很好的避免這個問題。另一個解決方法可以考慮使用命名空間。

  注明:

  本文提到的常量:PHP5.3開始const關(guān)鍵字可以用在類的外部。const和define都是用來聲明常量的(它們的區(qū)別不詳述),但是在命名空間里,define的作用是全局的,而const則作用于當(dāng)前空間。我在文中提到的常量是指使用const聲明的常量。

  基礎(chǔ)

  命名空間將代碼劃分出不同的空間(區(qū)域),每個空間的常量、函數(shù)、類(為了偷懶,我下邊都將它們稱為元素)的名字互不影響, 這個有點類似我們常常提到的‘封裝’的概念。

  創(chuàng)建一個命名空間需要使用namespace關(guān)鍵字,這樣:

  <?php

  //創(chuàng)建一個名為'Article'的命名空間

  namespace Article;

  ?>

  要注意的是,當(dāng)前腳本文件的第一個命名空間前面不能有任何代碼,下面的寫法都是錯誤的:

  //例一

  //在腳本前面寫了一些邏輯代碼

  <?php

  $path = '/';

  class Comment { }

  namespace Article;

  ?>

  //例二

  //在腳本前面輸出了一些字符

  <html></html>

  <?php

  namespace Article;

  ?>

  為什么要說第一個命名空間呢?因為同一腳本文件中可以創(chuàng)建多個命名空間。

  下面我創(chuàng)建了兩個命名空間,順便為這兩個空間各自添加了一個Comment類元素:

  <?php

  //創(chuàng)建一個名為'Article'的命名空間

  namespace Article;

  //此Comment屬于Article空間的元素

  class Comment { }

  //創(chuàng)建一個名為'MessageBoard'的命名空間

  namespace MessageBoard;

  //此Comment屬于MessageBoard空間的元素

  class Comment { }

  ?>

  在不同空間之間不可以直接調(diào)用其它元素,需要使用命名空間的語法:

  <?php

  namespace Article;

  class Comment { }

  namespace MessageBoard;

  class Comment { }

  //調(diào)用當(dāng)前空間(MessageBoard)的Comment類

  $comment = new Comment();

  //調(diào)用Article空間的Comment類

  $article_comment = new \Article\Comment();

  ?>

  可以看到,在MessageBoard空間中調(diào)用article空間里的Comment類時,使用了一種像文件路徑的語法: \空間名\元素名

  除了類之外,對函數(shù)和常量的用法是一樣的,下面我為兩個空間創(chuàng)建了新的元素,并在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 { }

  //調(diào)用當(dāng)前空間的常量、函數(shù)和類

  echo PATH; ///message_board

  echo getCommentTotal(); //300

  $comment = new Comment();

  //調(diào)用Article空間的常量、函數(shù)和類

  echo \Article\PATH; ///article

  echo \Article\getCommentTotal(); //100

  $article_comment = new \Article\Comment();

  ?>

  然后我的確得到了Article空間的元素數(shù)據(jù)。

  子空間

  命名空間的調(diào)用語法像文件路徑一樣是有道理的,它允許我們自定義子空間來描述各個空間之間的關(guān)系。

  抱歉我忘了說,article和message board這兩個模塊其實都是處于同一個blog項目內(nèi)。如果用命名空間來表達它們的關(guān)系,是這樣:

  <?php

  //我用這樣的命名空間表示處于blog下的article模塊

  namespace Blog\Article;

  class Comment { }

  //我用這樣的命名空間表示處于blog下的message board模塊

  namespace Blog\MessageBoard;

  class Comment { }

  //調(diào)用當(dāng)前空間的類

  $comment = new Comment();

  //調(diào)用Blog\Article空間的類

  $article_comment = new \Blog\Article\Comment();

  ?>

  而且,子空間還可以定義很多層次,比如說 Blog\Article\Archives\Date

  公共空間

  我有一個common_inc.php腳本文件,里面有一些好用的函數(shù)和類:

  <?php

  function getIP() { }

  class FilterXSS { }

  ?>

  在一個命名空間里引入這個腳本,腳本里的元素不會歸屬到這個命名空間。如果這個腳本里沒有定義其它命名空間,它的元素就始終處于公共空間中:

  <?php

  namespace Blog\Article;

  //引入腳本文件

  include './common_inc.php';

  $filter_XSS = new FilterXSS(); //出現(xiàn)致命錯誤:找不到Blog\Article\FilterXSS類

  $filter_XSS = new \FilterXSS(); //正確

  ?>

  調(diào)用公共空間的方式是直接在元素名稱前加 \ 就可以了,否則PHP解析器會認(rèn)為我想調(diào)用當(dāng)前空間下的元素。除了自定義的元素,還包括PHP自帶的元素,都屬于公共空間。

  要提一下,其實公共空間的函數(shù)和常量不用加 \ 也可以正常調(diào)用(不明白PHP為什么要這樣做),但是為了正確區(qū)分元素,還是建議調(diào)用函數(shù)的時候加上 \

  名稱術(shù)語

  在說別名和導(dǎo)入之前,需要知道關(guān)于空間三種名稱的術(shù)語,以及PHP是怎樣解析它們的。官方文檔說得非常好,我就直接拿來套了。

  1.非限定名稱,或不包含前綴的類名稱,例如 $comment = new Comment();。如果當(dāng)前命名空間是Blog\Article,Comment將被解析為Blog\Article\Comment。如果使用Comment的代碼不包含在任何命名空間中的代碼(全局空間中),則Comment會被解析為Comment。

  2.限定名稱,或包含前綴的名稱,例如 $comment = new Article\Comment();。如果當(dāng)前的命名空間是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

  //創(chuàng)建空間Blog

  namespace Blog;

  class Comment { }

  //非限定名稱,表示當(dāng)前Blog空間

  //這個調(diào)用將被解析成 Blog\Comment();

  $blog_comment = new Comment();

  //限定名稱,表示相對于Blog空間

  //這個調(diào)用將被解析成 Blog\Article\Comment();

  $article_comment = new Article\Comment(); //類前面沒有反斜桿\

  //完全限定名稱,表示絕對于Blog空間

  //這個調(diào)用將被解析成 Blog\Comment();

  $article_comment = new \Blog\Comment(); //類前面有反斜桿\

  //完全限定名稱,表示絕對于Blog空間

  //這個調(diào)用將被解析成 Blog\Article\Comment();

  $article_comment = new \Blog\Article\Comment(); //類前面有反斜桿\

  //創(chuàng)建Blog的子空間Article

  namespace Blog\Article;

  class Comment { }

  ?>

  其實之前我就一直在使用非限定名稱和完全限定名稱,現(xiàn)在它們終于可以叫出它們的名稱了。

  別名和導(dǎo)入

  別名和導(dǎo)入可以看作是調(diào)用命名空間元素的一種快捷方式。PHP并不支持導(dǎo)入函數(shù)或常量。

  它們都是通過使用use操作符來實現(xiàn):

  <?php

  namespace Blog\Article;

  class Comment { }

  //創(chuàng)建一個BBS空間(我有打算開個論壇)

  namespace BBS;

  //導(dǎo)入一個命名空間

  use Blog\Article;

  //導(dǎo)入命名空間后可使用限定名稱調(diào)用元素

  $article_comment = new Article\Comment();

  //為命名空間使用別名

  use Blog\Article as Arte;

  //使用別名代替空間名

  $article_comment = new Arte\Comment();

  //導(dǎo)入一個類

  use Blog\Article\Comment;

  //導(dǎo)入類后可使用非限定名稱調(diào)用元素

  $article_comment = new Comment();

  //為類使用別名

  use Blog\Article\Comment as Comt;

  //使用別名代替空間名

  $article_comment = new Comt();

  ?>

  我注意到,如果導(dǎo)入元素的時候,當(dāng)前空間有相同的名字元素將會怎樣?顯然結(jié)果會發(fā)生致命錯誤。

  例:

  <?php

  namespace Blog\Article;

  class Comment { }

  namespace BBS;

  class Comment { }

  Class Comt { }

  //導(dǎo)入一個類

  use Blog\Article\Comment;

  $article_comment = new Comment(); //與當(dāng)前空間的Comment發(fā)生沖突,程序產(chǎn)生致命錯誤

  //為類使用別名

  use Blog\Article\Comment as Comt;

  $article_comment = new Comt(); //與當(dāng)前空間的Comt發(fā)生沖突,程序產(chǎn)生致命錯誤

  ?>

  動態(tài)調(diào)用

  PHP提供了namespace關(guān)鍵字和__NAMESPACE__魔法常量動態(tài)的訪問元素,__NAMESPACE__可以通過組合字符串的形式來動態(tài)訪問:

  <?php

  namespace Blog\Article;

  const PATH = '/Blog/article';

  class Comment { }

  //namespace關(guān)鍵字表示當(dāng)前空間

  echo namespace\PATH; ///Blog/article

  $comment = new namespace\Comment();

  //魔法常量__NAMESPACE__的值是當(dāng)前空間名稱

  echo __NAMESPACE__; //Blog\Article

  //可以組合成字符串并調(diào)用

  $comment_class_name = __NAMESPACE__ . '\Comment';

  $comment = new $comment_class_name();

  ?>

  字符串形式調(diào)用問題

  上面的動態(tài)調(diào)用的例子中,我們看到了字符串形式的動態(tài)調(diào)用方式,如果要使用這種方式要注意兩個問題。

  1. 使用雙引號的時候特殊字符可能被轉(zhuǎn)義

  <?php

  namespace Blog\Article;

  class name { }

  //我是想調(diào)用Blog\Article\name

  $class_name = __NAMESPACE__ . '\name'; //但是\n將被轉(zhuǎn)義為換行符

  $name = new $class_name(); //發(fā)生致命錯誤

  ?>

  2. 不會認(rèn)為是限定名稱

  PHP在編譯腳本的時候就確定了元素所在的空間,以及導(dǎo)入的情況。而在解析腳本時字符串形式調(diào)用只能認(rèn)為是非限定名稱和完全限定名稱,而永遠不可能是限定名稱。

  <?php

  namespace Blog;

  //導(dǎo)入Common類

  use Blog\Article\Common;

  //我想使用非限定名稱調(diào)用Blog\Article\Common

  $common_class_name = 'Common';

  //實際會被當(dāng)作非限定名稱,也就表示當(dāng)前空間的Common類,但我當(dāng)前類沒有創(chuàng)建Common類

  $common = new $common_class_name(); //發(fā)生致命錯誤:Common類不存在

  //我想使用限定名稱調(diào)用Blog\Article\Common

  $common_class_name = 'Article\Common';

  //實際會被當(dāng)作完全限定名稱,也就表示Article空間下的Common類,但我下面只定義了Blog\Article空間而不是Article空間

  $common = new $common_class_name(); //發(fā)生致命錯誤:Article\Common類不存在

  namespace Blog\Article;

  class Common { }

  ?>

  總結(jié)

  我對PHP的命名空間剛剛接觸,也不能隨便給一些沒有實踐的建議。我個人認(rèn)為命名空間的作用和功能都很強大,如果要寫插件或者通用庫的時候再也不用擔(dān)心重名問題。不過如果項目進行到一定程度,要通過增加命名空間去解決重名問題,我覺得工作量不會比重構(gòu)名字少。也不得不承認(rèn)它的語法會對項目增加一定的復(fù)雜度,因此從項目一開始的時候就應(yīng)該很好的規(guī)劃它,并制定一個命名規(guī)范。

    本站是提供個人知識管理的網(wǎng)絡(luò)存儲空間,所有內(nèi)容均由用戶發(fā)布,不代表本站觀點。請注意甄別內(nèi)容中的聯(lián)系方式、誘導(dǎo)購買等信息,謹(jǐn)防詐騙。如發(fā)現(xiàn)有害或侵權(quán)內(nèi)容,請點擊一鍵舉報。
    轉(zhuǎn)藏 分享 獻花(0

    0條評論

    發(fā)表

    請遵守用戶 評論公約

    類似文章 更多