深入講解 Laravel 的 IoC 服務容器

来源:https://www.cnblogs.com/a609251438/archive/2019/11/16/11874024.html
-Advertisement-
Play Games

眾所周知，Laravel 控制反轉 (IoC) / 依賴註入 (DI) 的功能非常強大。遺憾的是， 官方文檔 並沒有詳細講解它的所有功能，所以我決定自己實踐一下，並整理成文。下麵的代碼是基於 Laravel 5.4.26 的，其他版本可能會有所不同。 瞭解依賴註入 我在這裡不會詳細講解依賴註入/控制 ...


 

眾所周知，Laravel 控制反轉 (IoC) / 依賴註入 (DI) 的功能非常強大。遺憾的是， 官方文檔 並沒有詳細講解它的所有功能，所以我決定自己實踐一下，並整理成文。下麵的代碼是基於 Laravel 5.4.26 的，其他版本可能會有所不同。

瞭解依賴註入

我在這裡不會詳細講解依賴註入/控制反轉的原則 - 如果你對此還不是很瞭解，建議閱讀 Fabien Potencier （Symfony 框架的創始人）的 What is Dependency Injection? 。

 

訪問容器

通過 Laravel 訪問 Container 實例的方式有很多種，最簡單的就是調用輔助函數 app()：

1 $container = app();

 

為了突出重點 Container 類，這裡就不贅述其他方式了。

註意： 官方文檔中使用的是 $this->app 而不是 $container。

(* 在 Laravel 應用中，Application 實際上是 Container 的一個子類 ( 這也說明瞭輔助函數 app() 的由來 )，不過在這篇文章中我還是將重點講解 Container 類的方法。)

在 Laravel 之外使用 Illuminate\Container

想要不基於 Laravel 使用 Container，安裝 然後：

use Illuminate\Container\Container;

$container = Container::getInstance();

 

基礎用法

最簡單的用法是通過構造函數註入依賴類。

1 class MyClass
2 {
3     private $dependency;
4 
5     public function __construct(AnotherClass $dependency)
6     {
7         $this->dependency = $dependency;
8     }
9 }

 

使用 Container 的 make() 方法實例化 MyClass 類：

$instance = $container->make(MyClass::class);

container 會自動實例化依賴類，所以上面代碼實現的功能就相當於：

$instance = new MyClass(new AnotherClass());

（ 假設 AnotherClass 還有需要依賴的類 - 在這種情況下，Container 會遞歸式地實例化所有的依賴。）

實戰

 phper在進階的時候總會遇到一些問題和瓶頸，業務代碼寫多了沒有方向感，不知道該從那裡入手去提升，對此我整理了一些資料，包括但不限於：分散式架構、高可擴展、高性能、高併發、伺服器性能調優、TP6，laravel，YII2，Redis，Swoole、Swoft、Kafka、Mysql優化、shell腳本、Docker、微服務、Nginx等多個知識點高級進階乾貨需要的可以免費分享給大家需要的（點擊→）我的官方群677079770

下麵是一些基於 PHP-DI 文檔 的例子 - 將發送郵件與用戶註冊的代碼解耦：

 1 class Mailer
 2 {
 3     public function mail($recipient, $content)
 4     {
 5         // 發送郵件
 6         // ...
 7     }
 8 }
 9 class UserManager
10 {
11     private $mailer;
12 
13     public function __construct(Mailer $mailer)
14     {
15         $this->mailer = $mailer;
16     }
17 
18     public function register($email, $password)
19     {
20         // 創建用戶賬號
21         // ...
22 
23         // 給用戶發送問候郵件
24         $this->mailer->mail($email, 'Hello and welcome!');
25     }
26 }
27 use Illuminate\Container\Container;
28 
29 $container = Container::getInstance();
30 
31 $userManager = $container->make(UserManager::class);
32 $userManager->register('[email protected]', 'MySuperSecurePassword!');

 

綁定介面與具體實現

通過 Container 類，我們可以輕鬆實現從介面到具體類到實例的過程。首先定義介面：

interface MyInterface { /* ... */ }
interface AnotherInterface { /* ... */ }

 

聲明實現介面的具體類，具體類還可以依賴其他介面（ 或者是像上個例子中的具體類 ）：

class MyClass implements MyInterface
1 {
2     private $dependency;
3 
4     public function __construct(AnotherInterface $dependency)
5     {
6         $this->dependency = $dependency;
7     }
8 }

 

然後使用 bind() 方法把介面與具體類進行綁定：

$container->bind(MyInterface::class, MyClass::class);
$container->bind(AnotherInterface::class, AnotherClass::class);

 

最後，在 make() 方法中，使用介面作為參數：

$instance = $container->make(MyInterface::class);

 

註意： 如果沒有將介面與具體類進行綁定操作，就會報錯：

Fatal error: Uncaught ReflectionException: Class MyInterface does not exist

 

這是因為 container 會嘗試實例化介面 ( new MyInterface)，這本身在語法上就是錯誤的。

實戰

可更換的緩存層：

 1 interface Cache
 2 {
 3     public function get($key);
 4     public function put($key, $value);
 5 }
 6 class RedisCache implements Cache
 7 {
 8     public function get($key) { /* ... */ }
 9     public function put($key, $value) { /* ... */ }
10 }
11 class Worker
12 {
13     private $cache;
14 
15     public function __construct(Cache $cache)
16     {
17         $this->cache = $cache;
18     }
19 
20     public function result()
21     {
22         // 應用緩存
23         $result = $this->cache->get('worker');
24 
25         if ($result === null) {
26             $result = do_something_slow();
27 
28             $this->cache->put('worker', $result);
29         }
30 
31         return $result;
32     }
33 }
34 use Illuminate\Container\Container;
35 
36 $container = Container::getInstance();
37 $container->bind(Cache::class, RedisCache::class);
38 
39 $result = $container->make(Worker::class)->result();

 

綁定抽象類與具體類

也可以與抽象類進行綁定：

$container->bind(MyAbstract::class, MyConcreteClass::class);

 

或者將具體類與其子類進行綁定：

$container->bind(MySQLDatabase::class, CustomMySQLDatabase::class);

 

自定義綁定

在使用 bind() 方法進行綁定操作時，如果某個類需要額外的配置，還通過閉包函數來實現：

$container->bind(Database::class, function (Container $container) {
    return new MySQLDatabase(MYSQL_HOST, MYSQL_PORT, MYSQL_USER, MYSQL_PASS);
});

 

每次帶著配置信息創建一個 MySQLDatabase 類的實例的時候（ 下麵後講到如何通過 Singletons 創建一個可以共用的實例），都要用到 Database 介面。我們看到閉包函數接收了 Container 的實例作為參數，如果需要的話，還可以用它來實例化其他類：

1 $container->bind(Logger::class, function (Container $container) {
2     $filesystem = $container->make(Filesystem::class);
3 
4     return new FileLogger($filesystem, 'logs/error.log');
5 });

 

還可以通過閉包函數自定義要如何實例化某個類：

1 $container->bind(GitHub\Client::class, function (Container $container) {
2     $client = new GitHub\Client;
3     $client->setEnterpriseUrl(GITHUB_HOST);
4     return $client;
5 });

 

解析回調函數

可以使用 resolving() 方法來註冊一個回調函數，當綁定被解析的時候，就調用這個回調函數：

1 $container->resolving(GitHub\Client::class, function ($client, Container $container) {
2     $client->setEnterpriseUrl(GITHUB_HOST);
3 });

 

所有的註冊的回調函數都會被調用。這種方法也適用於介面和抽象類：

 1 $container->resolving(Logger::class, function (Logger $logger) {
 2     $logger->setLevel('debug');
 3 });
 4 
 5 $container->resolving(FileLogger::class, function (FileLogger $logger) {
 6     $logger->setFilename('logs/debug.log');
 7 });
 8 
 9 $container->bind(Logger::class, FileLogger::class);
10 
11 $logger = $container->make(Logger::class);

 

還可以註冊一個任何類被解析時都會被調用的回調函數 - 但是我想這可能僅適用於登錄和調試：

1 $container->resolving(function ($object, Container $container) {
2     // ...
3 });

 

擴展類

你還可以使用 extend() 方法把一個類與另一個類的實例進行綁定：

1 $container->extend(APIClient::class, function ($client, Container $container) {
2     return new APIClientDecorator($client);
3 });

 

這裡返回的另外一個類應該也實現了同樣的介面，否則會報錯。

單例綁定

只要使用 bind() 方法進行綁定，每次用的時候，就會創建一個新的實例（ 閉包函數就會被調用一次）。為了共用一個實例，可以使用 singleton() 方法來代替 bind() 方法：

$container->singleton(Cache::class, RedisCache::class);

 

或者是閉包：

1 $container->singleton(Database::class, function (Container $container) {
2     return new MySQLDatabase('localhost', 'testdb', 'user', 'pass');
3 });

 

為一個具體類創建單例，就只傳這個類作為唯一的參數：

$container->singleton(MySQLDatabase::class);

 

在以上的每種情況下，單例對象都是一次創建，反覆使用。如果想要復用的實例已經生成了，則可以使用 instance() 方法。例如，Laravel 就是用這種方式來確保Container 的實例有且僅有一個的：

$container->instance(Container::class, $container);

 

自定義綁定的名稱

其實，你可以使用任意字元串作為綁定的名稱，而不一定非要用類名或者介面名 - 但是這樣做的弊端就是不能使用類名實例化了，而只能使用 make() 方法：

$container->bind('database', MySQLDatabase::class);

$db = $container->make('database');

 

為了同時支持類和介面，並且簡化類名的寫法，可以使用 alias() 方法:

1 $container->singleton(Cache::class, RedisCache::class);
2 $container->alias(Cache::class, 'cache');
3 
4 $cache1 = $container->make(Cache::class);
5 $cache2 = $container->make('cache');
6 
7 assert($cache1 === $cache2);

 

存儲值

你也可以使用 container 來存儲任何值 - 比如：配置數據：

$container->instance('database.name', 'testdb');

$db_name = $container->make('database.name');

 

支持以數組的形式存儲：

$container['database.name'] = 'testdb';

$db_name = $container['database.name'];

 

在通過閉包進行綁定的時候，這種存儲方式就顯示出其好用之處了：

$container->singleton('database', function (Container $container) {
    return new MySQLDatabase(
        $container['database.host'],
        $container['database.name'],
        $container['database.user'],
        $container['database.pass']
    );
});

 

（ Laravel 框架沒有用 container 來存儲配置文件，而是用了單獨的 Config 類 - 但是 PHP-DI 用了）

小貼士： 在實例化對象的時候，還可以用數組的形式來代替 make() 方法：

$db = $container['database'];

 

通過方法 / 函數做依賴註入

到目前為止，我們已經看了很多通過構造函數進行依賴註入的例子，其實，Laravel 還支持對任何方法做依賴註入：

function do_something(Cache $cache) { /* ... */ }

$result = $container->call('do_something');

 

除了依賴類，還可以傳其他參數：

1 function show_product(Cache $cache, $id, $tab = 'details') { /* ... */ }
2 
3 // show_product($cache, 1)
4 $container->call('show_product', [1]);
5 $container->call('show_product', ['id' => 1]);
6 
7 // show_product($cache, 1, 'spec')
8 $container->call('show_product', [1, 'spec']);
9 $container->call('show_product', ['id' => 1, 'tab' => 'spec']);

 

可用於任何可調用的方法：

閉包

1 $closure = function (Cache $cache) { /* ... */ };
2 
3 $container->call($closure);

 

靜態方法

1 class SomeClass
2 {
3     public static function staticMethod(Cache $cache) { /* ... */ }
4 }
5 $container->call(['SomeClass', 'staticMethod']);
6 // 或者：
7 $container->call('SomeClass::staticMethod');

 

普通方法

1 class PostController
2 {
3     public function index(Cache $cache) { /* ... */ }
4     public function show(Cache $cache, $id) { /* ... */ }
5 }
6 $controller = $container->make(PostController::class);
7 
8 $container->call([$controller, 'index']);
9 $container->call([$controller, 'show'], ['id' => 1]);

 

調用實例方法的快捷方式

通過這種語法結構 ClassName@methodName，就 可以達到實例化一個類並調用其方法的目：

1 $container->call('PostController@index');
2 $container->call('PostController@show', ['id' => 4]);

 

容器用於實例化類，這意味著：

  1. 依賴項被註入構造函數（以及方法）。
  2. 如果希望重用這個類，則可以將該類定義為單例類。
  3. 你可以使用介面或任意名稱，而不是具體的類。

例如，這將會啟作用：

1 class PostController
2 {
3     public function __construct(Request $request) { /* ... */ }
4     public function index(Cache $cache) { /* ... */ }
5 }
6 $container->singleton('post', PostController::class);
7 $container->call('post@index');

 

最後，你可以將「預設方法」作為第三個參數。如果第一個參數是一個沒有指定方法的類名，則將調用預設的方法。 Laravel 使用 事件處理 來實現：

1 $container->call(MyEventHandler::class, $parameters, 'handle');
2 
3 // Equivalent to:
4 $container->call('MyEventHandler@handle', $parameters);

 

方法調用綁定

可以使用 bindMethod() 方法重寫方法調用，例如傳遞其他參數：

1 $container->bindMethod('PostController@index', function ($controller, $container) {
2     $posts = get_posts(...);
3 
4     return $controller->index($posts);
5 });

 

所有這些都會奏效，調用閉包而不是的原始方法：

1 $container->call('PostController@index');
2 $container->call('PostController', [], 'index');
3 $container->call([new PostController, 'index']);

 

但是， call() 的任何附加參數都不會傳遞到閉包中，因此不能使用它們。

1 $container->call('PostController@index', ['Not used :-(']);

 

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

-Advertisement-
Play Games
更多相關文章
  • JVM原理速記複習Java虛擬機總結思維導圖面試必備
    良心製作，JVM原理速記複習Java虛擬機總結思維導圖面試必備。 一、運行時數據區域 線程私有 程式計數器 記錄正在執行的虛擬機位元組碼指令的地址（如果正在執行的是Native方法則為空），是唯一一個沒有規定OOM（OutOfMemoryError）的區域。 Java虛擬機棧 每個Java方法在執... ...
  • Python讀位元組某一位的值，設置某一位的值，二進位位操作
    Python讀位元組某一位的值，設置某一位的值，二進位位操作 在物聯網實際應用項目開發中，為了提升性能，與設備端配合，往往最終使用的是二進位位元組串方式進行的通信協議封裝，更會把0和1、True和False、Yes和No這樣的布爾值每8個只占用一個位元組，用位元組中的位來表示。減少傳輸量，減少對網路穩定性的 ...
  • 二、工廠模式
    工廠模式 前言 工廠模式又稱為創建模式，它是建對象的一種最佳方式。工廠模式的本質就是用工廠方法代替new操作創建一種實例化對象的方式。 在之前，如果我們想實例化一個對象Simple，一般會想到的方法就是通過構造器來創建Simple simple = new Simple(參數)。但是，如果創建sim ...
  • MySQL系列：MySQL的基本使用
    資料庫的基本操作 在MySQL資料庫中，對於一個MySQL示例，是可以包含多個資料庫的。 在連接MySQL後，我們可以通過 show databases; 來進行查看有那麼資料庫。這裡已經存在一些庫了，其中information_schema、auth、mysql、performance_schem ...
  • python基礎(32):進程(二)
    1. multiprocess模塊 仔細說來，multiprocess不是一個模塊而是python中一個操作、管理進程的包。 之所以叫multi是取自multiple的多功能的意思,在這個包中幾乎包含了和進程有關的所有子模塊。由於提供的子模塊非常多，為了方便大家歸類記憶，我將這部分大致分為四個部分： ...
  • 分享學習 PHP 源碼的方法
    ​每天抽一點時間來看看 PHP 源碼方面的書，說實話，無法在調試器下觀察 PHP 運行狀態的上下文實在是一件痛苦的事情。不過還好不是一無所獲，雖然內容比較多，但是掌握方法挨著看下去還是可以看一些代碼的。而且本身 PHP 源碼講解就有書，所以學習起來還是較為方便的。想要調試源碼，我覺得我最好應該找一個 ...
  • git 刪除誤上傳的.idea文件
    1.解決git誤上傳文件(如.idea)的問題 2. 常用的.gitignore文件 ...
  • 【集合系列】- 深入淺出分析Collection中的List介面
    在上一章《初探java集合框架圖》中，我相信大部分朋友對java容器整體架構都有了初步的瞭解，那麼本章主要是想詳細的介紹以下 List 介面實現類之間的區別！ ...
一周排行
    -Advertisement-
    Play Games
  • WPF 已知問題 監聽 WMI 事件導致觸摸失效
    示例項目結構 在 Visual Studio 中創建一個 WinForms 應用程式後，項目結構如下所示： MyWinFormsApp/ │ ├───Properties/ │ └───Settings.settings │ ├───bin/ │ ├───Debug/ │ └───Release/ ...
  • [STAThread]特性
    [STAThread] 特性用於需要與 COM 組件交互的應用程式，尤其是依賴單線程模型（如 Windows Forms 應用程式）的組件。在 STA 模式下，線程擁有自己的消息迴圈，這對於處理用戶界面和某些 COM 組件是必要的。 [STAThread] static void Main(stri ...
  • UWP WinUI3 傳入 AddHandler 的 RoutedEventHandler 類型與事件所需不匹配將拋出參數異常
    在WinForm中使用全局異常捕獲處理 在WinForm應用程式中，全局異常捕獲是確保程式穩定性的關鍵。通過在Program類的Main方法中設置全局異常處理，可以有效地捕獲並處理未預見的異常，從而避免程式崩潰。 註冊全局異常事件 [STAThread] static void Main() { / ...
  • .NET 多版本 WinForm 開源控制項庫 SunnyUI
    前言 給大家推薦一款開源的 Winform 控制項庫，可以幫助我們開發更加美觀、漂亮的 WinForm 界面。 項目介紹 SunnyUI.NET 是一個基於 .NET Framework 4.0+、.NET 6、.NET 7 和 .NET 8 的 WinForm 開源控制項庫，同時也提供了工具類庫、擴展 ...
  • .net core8 使用Swagger（附當前源碼）
    說明 該文章是屬於OverallAuth2.0系列文章，每周更新一篇該系列文章（從0到1完成系統開發）。 該系統文章，我會儘量說的非常詳細，做到不管新手、老手都能看懂。 說明：OverallAuth2.0 是一個簡單、易懂、功能強大的許可權+可視化流程管理系統。 有興趣的朋友，請關註我吧(*^▽^*) ...
  • WPF 什麼時候 VisualTreeHelper.GetDescendantBounds 將返回無窮大
    一、下載安裝 1.下載git 必須先下載並安裝git，再TortoiseGit下載安裝 git安裝參考教程：https://blog.csdn.net/mukes/article/details/115693833 2.TortoiseGit下載與安裝 TortoiseGit，Git客戶端，32/6 ...
  • C# 開源教程帶你輕鬆掌握數據結構與演算法
    前言 在項目開發過程中，理解數據結構和演算法如同掌握蓋房子的秘訣。演算法不僅能幫助我們編寫高效、優質的代碼，還能解決項目中遇到的各種難題。 給大家推薦一個支持C#的開源免費、新手友好的數據結構與演算法入門教程：Hello演算法。 項目介紹 《Hello Algo》是一本開源免費、新手友好的數據結構與演算法入門 ...
  • 第22篇 生成proto文件bat腳本
    1.生成單個Proto.bat內容 @rem Copyright 2016, Google Inc. @rem All rights reserved. @rem @rem Redistribution and use in source and binary forms, with or with ...
  • 記一次 .NET某上位機視覺程式 卡死分析
    一：背景 1. 講故事 前段時間有位朋友找到我，說他的窗體程式在客戶這邊出現了卡死，讓我幫忙看下怎麼回事？dump也生成了，既然有dump了那就上 windbg 分析吧。 二：WinDbg 分析 1. 為什麼會卡死 窗體程式的卡死，入口門檻很低，後續往下分析就不一定了，不管怎麼說先用 !clrsta ...
  • 醫學DICOM文件與PACS系統進行數據傳輸
    前言 人工智慧時代，人臉識別技術已成為安全驗證、身份識別和用戶交互的關鍵工具。 給大家推薦一款.NET 開源提供了強大的人臉識別 API，工具不僅易於集成，還具備高效處理能力。 本文將介紹一款如何利用這些API，為我們的項目添加智能識別的亮點。 項目介紹 GitHub 上擁有 1.2k 星標的 C# ...
所有分類