摘要:概述這份聲明了關于從文件路徑自動加載類的規范。當根據完全限定類名加載對應的文件時由最開始的命名空間開始,連續的一個或多個命名空間組成的序列,不包括最前面的命名空間分隔符,在這個完全限定類名中這個序列稱為命名空間前綴,對應了至少一個基礎目錄。
PSR-4:自動加載
翻譯:薛粲
授權許可:CC BY-NC 4.0
這份文檔是《PSR-4: Autoloader》的非官方譯文。
英文原文使用的關鍵詞 "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", 以及 "OPTIONAL" 遵循 RFC 2119 的描述。譯文中根據上下文可能會使用不同的詞匯來對應這些關鍵詞,并加粗顯示。
1. 概述這份 PSR 聲明了關于從文件路徑自動加載(autoloading)類的規范。它具有完整的互用性,可以結合任何其它關于自動加載機制的規范使用,包括 PSR-0。這份 PSR 還描述了在何處保存文件以便可以根據這份規范實現自動加載。
2. 規范術語“類”指代類、接口、trait 以及其它類似的結構。
一個完全限定(fully qualified)類名形如:
完全限定類名必須包含一個頂級命名空間名,這也被稱為“開發商命名空間”。
完全限定類名可以包含一個或多個子命名空間名稱。
完全限定類名必須以一個類名結束。
完全限定類名各部分中的下劃線沒有任何特殊的含義。
完全限定類名中的字母可以使用任意大小寫組合。
所有類名必須以大小寫敏感的方式被引用。
當根據完全限定類名加載對應的文件時:
由最開始的命名空間開始,連續的一個或多個命名空間組成的序列,不包括最前面的命名空間分隔符,在這個完全限定類名中(這個序列稱為“命名空間前綴,namespace prefix”)對應了至少一個“基礎目錄”。
“命名空間前綴”之后相鄰的子命名空間,對應“基礎目錄”中的子目錄,命名空間分隔符對應目錄分隔符。子目錄名必須與子命名空間名大小寫匹配。
結尾的類名對應一個以 .php 最為后綴的文件名。文件名必須與類名大小寫匹配。
自動加載機制的具體實現不得拋出異常,不得產生任何等級的錯誤,且不應該有返回值。
3. 示例下表列出了一些文件路徑及其相對應的完全限定類名、命名空間前綴和基礎目錄。
完全限定類名 | 命名空間前綴 | 基礎目錄 | 文件路徑 |
---|---|---|---|
AcmeLogWriterFile_Writer | AcmeLogWriter | ./acme-log-writer/lib/ | ./acme-log-writer/lib/File_Writer.php |
AuraWebResponseStatus | AuraWeb | /path/to/aura-web/src/ | /path/to/aura-web/src/Response/Status.php |
SymfonyCoreRequest | SymfonyCore | ./vendor/Symfony/Core/ | ./vendor/Symfony/Core/Request.php |
endAcl | Zend | /usr/includes/Zend/ | /usr/includes/Zend/Acl.php |
PSR-4 提供遵循本規范的自動加載機制實現范例。這些范例不得被當做本規范的一部分,并可能隨時修改。
下面的示例提供了遵循 PSR-4 的參考實現。
使用閉包的范例使用類的范例下面基于類的實現范例可以處理多個命名空間:
register(); * * // register the base directories for the namespace prefix * $loader->addNamespace("FooBar", "/path/to/packages/foo-bar/src"); * $loader->addNamespace("FooBar", "/path/to/packages/foo-bar/tests"); * * 下面的代碼將會嘗試從文件 * /path/to/packages/foo-bar/src/Qux/Quux.php * 加載類 FooBarQuxQuux: * * prefixes[$prefix]) === false) { $this->prefixes[$prefix] = array(); } // retain the base directory for the namespace prefix if ($prepend) { array_unshift($this->prefixes[$prefix], $base_dir); } else { array_push($this->prefixes[$prefix], $base_dir); } } /** * Loads the class file for a given class name. * * @param string $class The fully-qualified class name. * @return mixed The mapped file name on success, or boolean false on * failure. */ public function loadClass($class) { // the current namespace prefix $prefix = $class; // work backwards through the namespace names of the fully-qualified // class name to find a mapped file name while (false !== $pos = strrpos($prefix, "")) { // retain the trailing namespace separator in the prefix $prefix = substr($class, 0, $pos + 1); // the rest is the relative class name $relative_class = substr($class, $pos + 1); // try to load a mapped file for the prefix and relative class $mapped_file = $this->loadMappedFile($prefix, $relative_class); if ($mapped_file) { return $mapped_file; } // remove the trailing namespace separator for the next iteration // of strrpos() $prefix = rtrim($prefix, ""); } // never found a mapped file return false; } /** * Load the mapped file for a namespace prefix and relative class. * * @param string $prefix The namespace prefix. * @param string $relative_class The relative class name. * @return mixed Boolean false if no mapped file can be loaded, or the * name of the mapped file that was loaded. */ protected function loadMappedFile($prefix, $relative_class) { // are there any base directories for this namespace prefix? if (isset($this->prefixes[$prefix]) === false) { return false; } // look through base directories for this namespace prefix foreach ($this->prefixes[$prefix] as $base_dir) { // replace the namespace prefix with the base directory, // replace namespace separators with directory separators // in the relative class name, append with .php $file = $base_dir . str_replace("", "/", $relative_class) . ".php"; // if the mapped file exists, require it if ($this->requireFile($file)) { // yes, we"re done return $file; } } // never found it return false; } /** * If a file exists, require it from the file system. * * @param string $file The file to require. * @return bool True if the file exists, false if not. */ protected function requireFile($file) { if (file_exists($file)) { require $file; return true; } return false; } }單元測試下面的范例是對上面的類加載機制的一種單元測試實現方案:
files = $files; } protected function requireFile($file) { return in_array($file, $this->files); } } class Psr4AutoloaderClassTest extends PHPUnit_Framework_TestCase { protected $loader; protected function setUp() { $this->loader = new MockPsr4AutoloaderClass; $this->loader->setFiles(array( "/vendor/foo.bar/src/ClassName.php", "/vendor/foo.bar/src/DoomClassName.php", "/vendor/foo.bar/tests/ClassNameTest.php", "/vendor/foo.bardoom/src/ClassName.php", "/vendor/foo.bar.baz.dib/src/ClassName.php", "/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php", )); $this->loader->addNamespace( "FooBar", "/vendor/foo.bar/src" ); $this->loader->addNamespace( "FooBar", "/vendor/foo.bar/tests" ); $this->loader->addNamespace( "FooBarDoom", "/vendor/foo.bardoom/src" ); $this->loader->addNamespace( "FooBarBazDib", "/vendor/foo.bar.baz.dib/src" ); $this->loader->addNamespace( "FooBarBazDibimGir", "/vendor/foo.bar.baz.dib.zim.gir/src" ); } public function testExistingFile() { $actual = $this->loader->loadClass("FooBarClassName"); $expect = "/vendor/foo.bar/src/ClassName.php"; $this->assertSame($expect, $actual); $actual = $this->loader->loadClass("FooBarClassNameTest"); $expect = "/vendor/foo.bar/tests/ClassNameTest.php"; $this->assertSame($expect, $actual); } public function testMissingFile() { $actual = $this->loader->loadClass("No_VendorNo_PackageNoClass"); $this->assertFalse($actual); } public function testDeepFile() { $actual = $this->loader->loadClass("FooBarBazDibimGirClassName"); $expect = "/vendor/foo.bar.baz.dib.zim.gir/src/ClassName.php"; $this->assertSame($expect, $actual); } public function testConfusion() { $actual = $this->loader->loadClass("FooBarDoomClassName"); $expect = "/vendor/foo.bar/src/DoomClassName.php"; $this->assertSame($expect, $actual); $actual = $this->loader->loadClass("FooBarDoomClassName"); $expect = "/vendor/foo.bardoom/src/ClassName.php"; $this->assertSame($expect, $actual); } }
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/21466.html
摘要:前言在開始之前,歡迎關注我自己的博客這篇文章是對自動加載功能的一個總結,內容涉及的自動加載功能的命名空間的與標準等內容。要實現第一步,第二步的功能,必須在開發時約定類名與磁盤文件的映射方法,只有這樣我們才能根據類名找到它對應的磁盤文件。 前言 在開始之前,歡迎關注我自己的博客:www.leoyang90.cn 這篇文章是對PHP自動加載功能的一個總結,內容涉及PHP的自動加載功能、P...
摘要:自動加載是指在代碼中,不需要顯式地使用文件路徑將類庫文件包含進來,便可使用該文件中定義的類庫。在里是這樣進行配置的按照的規則,當試圖自動加載這個時,會去尋找這個文件。最后,只要在項目中你所需要的所有類庫都會在適當的時候自動載入。 Composer是PHP中用來管理依賴(dependency)關系的工具。你可以在自己的項目中聲明所依賴的外部工具庫(libraries),Composer...
摘要:接觸過的同學都知道使用作為項目的包管理工具但是并不是獨有的是的包管理工具這兩者的關系就像于于一樣但是發現真正項目中使用還是比較少的所以這里這里寫一遍文章介紹的使用幫助那些對于還是有點模糊的同學此文跟沒有任何聯系安裝的方式就不講了具體安裝方式 接觸過Laravel的同學都知道,Laravel使用Composer作為項目的包管理工具.但是Composer并不是Laravel獨有的,Comp...
摘要:中是如何實現代碼的自動加載的入口腳本的以下兩行代碼其中的作用注冊為自動加載函數。這個負責引入了一個類中的,隨后立即解除注冊。注冊中的為自動加載函數,并利用配置文件即目錄下的文件對這個自動加載函數進行了初始化。 1.基本知識 Include與require 的作用: 當一個文件被包含時,其中所包含的代碼繼承了 include 所在行的變量范圍。從該處開始,調用文件在該行處可用的任何...
摘要:制定的規范,簡稱,是開發的事實標準。原本有四個規范,分別是自動加載基本代碼規范代碼樣式日志接口年底,新出了第個規范。區別在于的規范比較干凈,去除了兼容以前版本的內容,有一點升級版的感覺。 FIG制定的PHP規范,簡稱PSR,是PHP開發的事實標準。 PSR原本有四個規范,分別是: PSR-0 自動加載 PSR-1 基本代碼規范 PSR-2 代碼樣式 PSR-3 日志接口 20...
閱讀 3748·2021-11-24 10:46
閱讀 1710·2021-11-15 11:38
閱讀 3768·2021-11-15 11:37
閱讀 3488·2021-10-27 14:19
閱讀 1946·2021-09-03 10:36
閱讀 1995·2021-08-16 11:02
閱讀 3004·2019-08-30 15:55
閱讀 2258·2019-08-30 15:44