PHP的命名空間

来源:https://www.cnblogs.com/skl-bobo/archive/2019/02/26/10438792.html
-Advertisement-
Play Games

1.什麼是命名空間，官方文檔定義為： 什麼是命名空間？從廣義上來說，命名空間是一種封裝事物的方法。在很多地方都可以見到這種抽象概念。例如，在操作系統中目錄用來將相關文件分組，對於目錄中的文件來說，它就扮演了命名空間的角色。具體舉個例子，文件 foo.txt 可以同時在目錄/home/greg 和 / ...


1.什麼是命名空間，官方文檔定義為：

　　　　什麼是命名空間？從廣義上來說，命名空間是一種封裝事物的方法。在很多地方都可以見到這種抽象概念。例如，在操作系統中目錄用來將相關文件分組，對於目錄中的文件來說，它就扮演了命名空間的角色。具體舉個例子，文件 foo.txt 可以同時在目錄/home/greg 和 /home/other 中存在，但在同一個目錄中不能存在兩個 foo.txt 文件。另外，在目錄 /home/greg 外訪問 foo.txt 文件時，我們必須將目錄名以及目錄分隔符放在文件名之前得到 /home/greg/foo.txt。這個原理應用到程式設計領域就是命名空間的概念。

 

2.命名空間的作用，官方定義為：

  1. 用戶編寫的代碼與PHP內部的類/函數/常量或第三方類/函數/常量之間的名字衝突。
  2. 為很長的標識符名稱(通常是為了緩解第一類問題而定義的)創建一個別名（或簡短）的名稱，提高源代碼的可讀　　

　　 其實命名空間的作用就是解決類、函數、常量重名的問題，變數名重覆，可以放到不同的函數中，函數名重覆可以放到不同的類中，那類名重覆呢？就可以用命名空間解決

 

3.如何定義一個命名空間

namespace  xx;

　　範圍：從這一行開始到下一個命名空間的開始

　　註意事項：在聲明命名空間之前唯一合法的代碼是用於定義源文件編碼方式的 declare 語句。另外，所有非 PHP 代碼包括空白符都不能出現在命名空間的聲明之前

 

　　雖然任意合法的PHP代碼都可以包含在命名空間中，但只有以下類型的代碼受命名空間的影響，它們是：類（包括抽象類和traits）、介面、函數和常量。另外，與PHP其它的語言特征不同，同一個命名空間可以定義在多個文件中，即允許將同一個命名空間的內容分割存放在不同的文件中。

 

4.定義子命名空間

　　與目錄和文件的關係很象，PHP 命名空間也允許指定層次化的命名空間的名稱。因此，命名空間的名字可以使用分層次的方式定義：

　　<?php
　　namespace MyProject\Sub\Level;

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }

　　?>

　　上面的例子創建了常量MyProject\Sub\Level\CONNECT_OK，類 MyProject\Sub\Level\Connection和函數 MyProject\Sub\Level\connect。

 

5.也可以在同一個文件中定義多個命名空間。在同一個文件中定義多個命名空間有兩種語法形式。

　　<?php
　　namespace MyProject;

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }

　　namespace AnotherProject;

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }

　　?>

　　不建議使用這種語法在單個文件中定義多個命名空間，建議使用下麵大括弧的語法定義命名空間

　　<?php
　　namespace MyProject {

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }
　　}

　　namespace AnotherProject {

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }
　　}
　　?>

　　在實際編程中非常不提倡在一個文件中定義多個命名空間。這種方式的主要用於將多個 PHP 腳本合併在同一個文件中。

　　將全局的非命名空間中的代碼與命名空間中的代碼組合在一起，只能使用大括弧形式的語法。全局代碼必須用一個不帶名稱的 namespace 語句加上大括弧括起來，例如：

　　<?php

　　declare(encoding='UTF-8');       //  除了開始的declare語句外，命名空間的括弧外不得有任何PHP代碼。
　　namespace MyProject {

　　const CONNECT_OK = 1;
　　class Connection { /* ... */ }
　　function connect() { /* ... */  }
　　}

　　namespace { // global code
　　session_start();
　　$a = MyProject\connect();
　　echo MyProject\Connection::start();
　　}
　　?>

 

6.使用命名空間　

註明：

本文提到的常量：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為什麼要這樣做），但是為了正確區分元素，還是建議調用函數的時候加上 \

 

7.名稱術語

在說別名和導入之前，需要知道關於空間三種名稱的術語，以及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
更多相關文章
  • vue項目中vux的使用
    vux VUX 是基於 WeUI 和 Vue.js 的 移動端 UI 組件庫,提供豐富的組件滿足移動端(微信)頁面常用業務需求。 在vue cli中使用步驟如下： 1、安裝： npm i vux S 2、vux2必須配合vux loader使用，並配置build/webpack.base.conf. ...
  • vue2.0 實現全選和全不選
    實現思路： 1、 v model 一個收集所有input（除全選框外）數組checkModel ，vue會動態將其checked為true的input的value值存入數組checkModel里 2 、watch函數來監聽checkModel 屬性，當其長度==input元素時 全選按鈕選中 否則取 ...
  • Vue2.5開發去哪兒網App 城市列表開發 上
    1. 在 router目錄下 的 index.js文件中，新增路由 import City from '@/pages/city/City' { path: '/city', name: 'City', component: City } 2. 在city 目錄下新建city文件夾，然後新建 Cit ...
  • vue 目錄結構解析
    ├── README.md 項目介紹├── index.html 入口頁面├── build 構建腳本目錄│ ├── webpack.base.conf.js webpack基礎配置,開發環境,生產環境都依賴 │ ├── webpack.dev.conf.js webpack開發環境配置│ ├── ...
  • .Net Core應用框架Util介紹（六）
    前面介紹了Util是如何封裝以降低Angular應用的開發成本。 現在把關註點移到服務端，本文將介紹分層架構各構造塊及基類，並對不同層次的開發人員應如何進行業務開發提供一些建議。 Util分層架構介紹 為了控制業務邏輯複雜性，Util引入了DDD分層架構，這意味著如果你想使用DDD，Util會為你提 ...
  • 資料庫分庫分表和帶來的唯一ID、分頁查詢問題的解決
    需求緣起（用一個公司的發展作為背景） 1.還是個小公司的時候，註冊用戶就20w，每天活躍用戶1w，每天最大單表數據量就1000，然後高峰期每秒併發請求最多就10，此時一個16核32G的伺服器，每秒請求支撐在2000左右，負載合理，沒有太大壓力，基本沒有宕機風險。 2.當註冊用戶達到2000W，每天活 ...
  • Django的視圖函數
    一.Django的視圖函數view 一個視圖函數(類),簡稱視圖,是一個簡單的Python函數(類),它接受WEB請求並返回Web響應. 響應可以是一張網頁的HTML內容,一個重定向,一個404錯誤,一個XML文檔,或者一張圖片. 無論視圖本身包含什麼邏輯,都要返迴響應.代碼寫在哪裡也無所謂,只要它 ...
  • 軟體架構應關心的若幹要素
    本篇文章主要分析，架構師在設計系統架構時，應關心哪些關鍵要素？ 一 業務場景 A公司是一家服裝公司，主要提供服裝一體化服務(服裝設計，服裝銷售，售後服務等)，該公司主要通過淘寶，天貓，京東等平臺進行銷售，由於公司 良好的服裝質量，高效的服務水平和良好的信譽等，使得公司的銷售量不斷地增長，到了第五年， ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類