后端Web框架【免費下載鏈接】yii2Yii 2: The Fast, Secure and Professional PHP Framework項目地址https://gitcode.com/gh_mirrors/yi/yii2點擊查看免費下載Service Locator服務定位器是 Yii 2 框架依賴管理體系的核心設計模式它通過 ID 向應用提供統(tǒng)一的服務獲取入口。本文將基于 docs/guide-pt-BR/concept-service-locator.md 與框架源碼系統(tǒng)講解如何在 Yii 2 中注冊、配置與獲取組件深入剖析\Yii::$app背后的單例共享機制、components批量配置方式以及模塊間的樹遍歷查找規(guī)則幫助讀者徹底掌握應用組件與模塊組件的底層工作原理。什么是 Service LocatorService Locator 是一個知道如何提供應用可能需要的各類服務或稱組件的對象。在 Service Locator 中每個組件只存在一個實例并通過唯一的ID進行標識。你使用這個 ID 從 Service Locator 中取回對應組件。在 Yii 2 中Service Locator 就是yii\di\ServiceLocator類本身或其任意子類的一個實例。其核心職責非常清晰維護一張組件 ID → 組件定義的注冊表在首次訪問時按定義創(chuàng)建組件實例并在后續(xù)訪問中復用同一實例對外暴露get()、set()、has()等統(tǒng)一的組件管理接口。Yii 2 中最常用的 Service Locator 是應用對象application可通過\Yii::$app全局訪問。應用對象提供的服務被稱為應用組件application components例如request、response、urlManager、db、cache等。借助 Service Locator 提供的能力你可以輕松地配置這些組件甚至用自己的實現替換它們。除了應用對象之外每個模塊module對象本身也是一個 Service Locator——從源碼可以看到framework/base/Module.php中Module類直接繼承自ServiceLocatorclass Module extends ServiceLocator這意味著模塊可以注冊自己的私有組件也可以沿模塊樹向上查找父級包括應用注冊的組件具體機制將在下文樹遍歷小節(jié)展開。注冊組件set() 的四種方式使用 Service Locator 的第一步是向它注冊組件。注冊通過ServiceLocator::set()方法完成。下面的代碼展示了注冊組件的四種不同方式use yii\di\ServiceLocator; use yii\caching\FileCache; $locator new ServiceLocator; // 方式一使用類名字符串get() 時會自動實例化該類 $locator-set(cache, yii\caching\ApcCache); // 方式二使用配置數組用于創(chuàng)建并配置組件 $locator-set(db, [ class yii\db\Connection, dsn mysql:hostlocalhost;dbnamedemo, username root, password , ]); // 方式三使用匿名函數回調返回一個組件實例 $locator-set(search, function () { return new app\components\SolrService; }); // 方式四直接注冊一個對象實例 $locator-set(pageCache, new FileCache);從源碼看 set() 的合法定義類型ServiceLocator::set()的實現明確了組件定義definition的四種合法形態(tài)并給出了嚴格的校驗邏輯定義類型說明內部處理類名字符串如yii\caching\ApcCache屬于可調用callable形態(tài)直接存入_definitionsPHP 回調匿名函數或[Foo, bar]形式的類方法數組存入_definitionsget()時調用返回對象配置數組必須包含class元素存入_definitionsget()時交給Yii::createObject()創(chuàng)建對象實例已實例化好的對象存入_definitionsget()時原樣返回幾個值得注意的實現細節(jié)重復注冊會覆蓋set()首先執(zhí)行unset($this-_components[$id])清除該 ID 下已緩存的實例再寫入新定義若傳入null則相當于注銷該組件。配置數組必須含class若配置數組既沒有class也沒有__class元素set()會拋出InvalidConfigExceptionThe configuration for the ... component must contain a class element.。從testDi3Compatibility測試可以看出__class是兼容舊版 DI 寫法的別名鍵最終會被統(tǒng)一改寫為class。其他非法類型如整數、字符串但非類名等會拋出InvalidConfigException提示 Unexpected configuration type。ServiceLocator內部使用兩個私有數組維護狀態(tài)_components存放已實例化的組件按 ID 索引_definitions存放組件定義。這兩個數組正是理解單例共享機制的關鍵。獲取組件get() 與屬性訪問組件注冊完成后即可用其 ID 通過以下兩種等價方式獲取$cache $locator-get(cache); // 或者 $cache $locator-cache;第二種寫法之所以可行是因為ServiceLocator重寫了__get()魔術方法framework/di/ServiceLocator.php當訪問的屬性名是一個已注冊的組件 ID 時直接委托給get($name)返回組件否則回退到父類Component::__get()處理普通屬性。同理__isset()也被重寫使得isset($app-inputWidget)這類判斷對組件同樣生效見testModulePropertyIsset測試。共享單例機制get()方法 的核心邏輯如下public function get($id, $throwException true) { if (isset($this-_components[$id])) { // 已實例化過直接返回緩存實例共享單例 return $this-_components[$id]; } if (isset($this-_definitions[$id])) { $definition $this-_definitions[$id]; if (is_object($definition) !$definition instanceof Closure) { // 定義本身就是對象直接緩存并返回 return $this-_components[$id] $definition; } // 其余定義類名/配置數組/回調統(tǒng)一交給 Yii::createObject() return $this-_components[$id] Yii::createObject($definition); } elseif ($throwException) { throw new InvalidConfigException(Unknown component ID: $id); } return null; }可以看到首次訪問時創(chuàng)建get()首次被調用時會根據注冊信息創(chuàng)建組件新實例并返回此后再次訪問時直接從_components返回同一個實例——這就是 Service Locator 的單例語義。測試tests/framework/di/ServiceLocatorTest.php中的testShared用assertSame($object, $object2)驗證了多次get()返回的是同一對象。延遲實例化組件只在被真正訪問時才創(chuàng)建未被訪問的注冊組件不會實例化因此不會產生無謂的內存與性能開銷。無效 ID 拋出異常若調用get()時傳入一個未注冊的 ID會拋出InvalidConfigException異常消息為 Unknown component ID: ...。若將第二個參數$throwException設為false則返回null而不是拋異常。檢查組件是否已注冊has()你可以使用has()檢查某個組件 ID 是否已經注冊if ($locator-has(cache)) { // 已注冊 }has($id, $checkInstance false)的行為取決于第二個參數默認false檢查是否有組件定義傳true則檢查是否已實例化即存在于_components中。通過 components 配置批量注冊組件由于 Service Locator 通常是通過配置創(chuàng)建的ServiceLocator專門提供了可寫屬性components對應setComponents()方法允許一次性配置并注冊多個組件。下面的配置數組展示了如何為一個 Service Locator例如一個應用注冊db、cache、tz和search組件return [ // ... components [ db [ class yii\db\Connection, dsn mysql:hostlocalhost;dbnamedemo, username root, password , ], cache yii\caching\ApcCache, tz function() { return new \DateTimeZone(Yii::$app-formatter-defaultTimeZone); }, search function () { $solr new app\components\SolrService(127.0.0.1); // ... 其他初始化 ... return $solr; }, ], ];setComponents()的實現非常簡單——遍歷數組并對每一項調用set()因此數組中每個值的寫法規(guī)則與set()完全一致類名、配置數組、回調、實例均可混用。與之對應的getComponents($returnDefinitions true)則用于取出當前全部定義或已加載實例列表。用靜態(tài)工廠方法替代回調封裝第三方庫的推薦姿勢上面示例中配置search組件還有一種替代思路不必直接寫一個構建SolrService實例的 PHP 回調而是用一個類的靜態(tài)方法返回這樣的回調如下所示class SolrServiceBuilder { public static function build($ip) { return function () use ($ip) { $solr new app\components\SolrService($ip); // ... 其他初始化 ... return $solr; }; } } return [ // ... components [ // ... search SolrServiceBuilder::build(127.0.0.1), ], ];這種替代方式在你發(fā)布一個封裝了第三方庫的 Yii 組件時最值得采用把構造第三方對象的復雜邏輯收斂到靜態(tài)方法內部組件使用者只需調用一次靜態(tài)方法即可完成配置無需了解第三方庫的初始化細節(jié)。樹遍歷模塊中組件查找的父子傳遞模塊允許任意嵌套——一個 Yii 應用本質上就是一棵模塊樹。由于每個模塊都是 Service Locator讓子模塊能夠訪問父模塊就變得順理成章。這樣模塊內部可以直接使用$this-get(db)而無需繞道引用根定位器Yii::$app-get(db)。額外的好處是開發(fā)者可以在模塊中覆蓋父級同名組件的配置。當某個模塊無法滿足一個組件的請求時該請求會沿模塊樹向上傳遞給父模塊繼續(xù)查找。這一行為的源碼位于Module::get()與Module::has()public function get($id, $throwException true) { if (!isset($this-module)) { return parent::get($id, $throwException); } $component parent::get($id, false); if ($component null) { $component $this-module-get($id, $throwException); } return $component; } public function has($id, $checkInstance false) { return parent::has($id, $checkInstance) || (isset($this-module) $this-module-has($id, $checkInstance)); }其查找順序可以概括為先在當前模塊自身注冊的組件中查找未命中則遞歸地向父模塊查找父模塊可能是上一級模塊也可能是應用本身一直向上直到根級若仍找不到且$throwException為true則拋出InvalidConfigException。該樹遍歷能力自 Yii 2.0.13 版本起提供見Module::get()的文檔注釋。需要特別注意一點模塊中組件的配置永遠不會與父模塊中同名組件的配置合并。Service Locator 模式允許定義具名服務但不能假設同名服務使用了相同的配置參數——模塊可以在components中為db提供一套全新的定義來覆蓋父級定義這是有意為之的設計。應用核心組件預注冊機制作為最常用的 Service Locator應用對象在初始化時就會預注冊一組核心組件。Application::coreComponents()framework/base/Application.php返回的默認核心組件包括組件 ID類logyii\log\Dispatcherviewyii\web\Viewformatteryii\i18n\Formatteri18nyii\i18n\I18NurlManageryii\web\UrlManagerassetManageryii\web\AssetManagersecurityyii\base\Securitymailer當yii\swiftmailer\Mailer類存在時yii\swiftmailer\Mailer在Application::preInit()中framework/base/Application.php框架會把核心組件與用戶自定義組件合并如果配置中沒有某個核心組件 ID則自動補上默認定義如果用戶為某個核心組件 ID 提供了配置數組但沒有指定class則沿用核心組件的默認類用戶只需覆蓋其余屬性。這也是為什么你可以在config里只寫components [ cache [ class yii\caching\FileCache, ], ],而不必重新定義view、urlManager等組件的原因。此外ServiceLocator本身繼承自yii\base\Component因此它還具備事件event與行為behavior能力可與其他 Yii 組件一樣被擴展。測試佐證共享、回調與對象注冊倉庫的單元測試tests/framework/di/ServiceLocatorTest.php從多個角度驗證了上述行為testCallable分別用匿名函數和[Creator, create]靜態(tài)方法數組注冊驗證get()能正確創(chuàng)建帶屬性初始化的實例testObject注冊已實例化對象后get()返回的assertSame同一對象testShared注冊配置數組后兩次get()返回同一實例印證共享單例語義testModulePropertyIsset驗證isset()與屬性訪問對組件的可用性testDi3Compatibility驗證__class鍵與class鍵的兼容處理。這些測試與 framework/di/ServiceLocator.php 的實現相互印證可以作為理解本文所講機制的第一手參考。小結Yii 2 的 Service Locator 是一個按 ID 提供單例服務的輕量級容器通過set()/setComponents()注冊通過get()或屬性語法獲取通過has()查詢配合延遲實例化與共享緩存實現高效的組件生命周期管理。應用對象與模塊對象都是它的實例前者預注冊了log、view、urlManager等核心組件后者則通過樹遍歷沿父子鏈向上解析服務。掌握這些機制你就能在配置文件中靈活地注冊、覆蓋和替換應用組件也能在模塊化開發(fā)中正確理解同名組件的覆蓋規(guī)則從而真正駕馭 Yii 2 的應用架構。贊分享后端Web框架【免費下載鏈接】yii2Yii 2: The Fast, Secure and Professional PHP Framework項目地址https://gitcode.com/gh_mirrors/yi/yii2點擊查看免費下載相關推薦Yii 2 服務定位器Service Locator深入解析從組件注冊到模塊樹遍歷Yii 2 服務定位器Service Locator深入解析從組件注冊到模塊樹遍歷 服務定位器Service Locator是 Yii 2 框架依賴管后端Web框架Yii 2 服務定位器Service Locator深度解析組件注冊、單例共享與模塊樹遍歷Yii 2 服務定位器Service Locator深度解析組件注冊、單例共享與模塊樹遍歷 服務定位器Service Locator是 Yii 2 框后端Web框架Yii 2 應用組件Application Components全面解析服務定位、注冊方式與核心組件配置實戰(zhàn)Yii 2 應用組件Application Components全面解析服務定位、注冊方式與核心組件配置實戰(zhàn) 應用組件Application Compo后端Web框架上一篇EmojiOne Color彩色表情字體終極免費跨平臺表情解決方案指南下一篇Broadcast Box社區(qū)貢獻指南如何參與開源項目并提交PR創(chuàng)作聲明：本文部分內容由AI輔助生成（AIGC），僅供參考