PHP命名空間（Namespace）初探

来源:http://www.cnblogs.com/shouce/archive/2016/05/27/5533349.html
-Advertisement-
Play Games

探完閉包[查看]，再探命名空間。 對於命名空間，官方文檔已經說得很詳細[查看]，我在這裡做了一下實踐和總結。 命名空間一個最明確的目的就是解決重名問題，PHP中不允許兩個函數或者類出現相同的名字，否則會產生一個致命的錯誤。這種情況下只要避免命名重覆就可以解決，最常見的一種做法是約定一個首碼。 例：項 ...


探完閉包[查看]，再探命名空間。

對於命名空間，官方文檔已經說得很詳細[查看]，我在這裡做了一下實踐和總結。

命名空間一個最明確的目的就是解決重名問題，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

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的命名空間剛剛接觸，也不能隨便給一些沒有實踐的建議。我個人認為命名空間的作用和功能都很強大，如果要寫插件或者通用庫的時候再也不用擔心重名問題。不過如果項目進行到一定程度，要通過增加命名空間去解決重名問題，我覺得工作量不會比重構名字少。也不得不承認它的語法會對項目增加一定的複雜度，因此從項目一開始的時候就應該很好的規劃它，並制定一個命名規範。

 

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • SubSonic2.2框架的使用方法和配置說明
    網上.net ORM框架也不少，但是我感覺這個框架配置很簡單的，前幾年貌似用的人很多，現在好像用得比較少了，隨著它官方的升級現在已經到3.0了, 並且採用T4 模板生成的方式，代碼量好像減少了。不過我感覺2.2還是比較穩定，前些天有網友問這個框架怎麼使用，在次讓我整理了一下。廢話就不說了，先看看怎麼 ...
  • c# 連接Mysql資料庫
    mysql.data.dll下載_c#連接mysql必要插件 全部版本下載：http://hovertree.com/h/bjaf/0sft36s9.htm mysql.data.dll是C#操作MYSQL的驅動文件，是c#連接mysql必要插件，使c#語言更簡潔的操作mysql資料庫。當你的電腦彈 ...
  • 一種基於自定義代碼的asp.net網站訪問IP過濾方法！
    對於一些企業內部核心系統，特別是外網訪問的時候，為了信息安全，可能需要對外部訪問的IP地址作限制，雖然IIS中也提供了根據IP地址或IP地址段進行限制或允許，但並沒有提供根據IP地址所在的城市進行限制或允許。本文主要通過自定義擴展IHttpModule介面，考慮到性能IP資料庫主要採用QQwry純真 ...
  • C# 日期格式化
    DateTime dt = DateTime.Now;Label1.Text = dt.ToString();//2009-07-5 13:21:25Label2.Text = dt.ToFileTime().ToString();//127756416859912816Label3.Text = ...
  • C# 導出CSV文件
    C# 導出CSV文件 由於工作需要，需要在Web端請求後，將查詢的數據寫入CSV文檔，返回給Web。 註意點： 1.長字元串的的數字，比如身份證號碼之類的，在csv中顯示的是用科學計數法顯示的，因此需要轉換一下，例如：字元串“12345678987654321”, 寫入時為"=\"123456789 ...
  • C#6新特性，讓你的代碼更乾凈
    前言 前幾天看一個朋友的博客時，看他用到了C#6的特性，而6出來這麼長時間還沒有正兒八經看過它，今兒專門看了下新特性，說白了也不過是語法糖而已。但是用起來確實能讓你的代碼更加乾凈些。Let's try it. 1、集合初始化器 public class Post { public DateTime ...
  • Java的21個技術點和知識點歸納
    1. JVM相關(包括了各個版本的特性) 對於剛剛接觸Java的人來說，JVM相關的知識不一定需要理解很深，對此裡面的概念有一些簡單的瞭解即可。不過對於一個有著3年以上Java經驗的資深開發者來說，不會JVM幾乎是不可接受的。 JVM作為java運行的基礎，很難相信對於JVM一點都不瞭解的人可以把j ...
  • python的二維數組操作
    需要在程式中使用二維數組，網上找到一種這樣的用法： 1 2 3 4 5 6 #創建一個寬度為3，高度為4的數組 #[[0,0,0], # [0,0,0], # [0,0,0], # [0,0,0]] myList = [[0] * 3] * 4 1 2 3 4 5 6 #創建一個寬度為3，高度為4的 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類