作為開發者,我們一直在嘗試通過使用設計模式和嘗試新的健壯型框架來尋找新的方式來編寫設計良好且健壯的程式碼。在本篇文章中,我們將通過 Laravel 的 IoC 元件探索依賴注入設計模式,並瞭解它如何改進我們的設計。
依賴注入
依賴注入一詞是由 Martin Fowler 提出的術語,它是將元件注入到應用程式中的一種行為。就像 Ward Cunningham 說的:
依賴注入是敏捷架構中關鍵元素。
讓我們看一個例子:
class UserProvider{
protected $connection;
public function __construct(){
$this->connection = new Connection;
}
public function retrieveByCredentials( array $credentials ){
$user = $this->connection
->where( 'email', $credentials['email'])
->where( 'password', $credentials['password'])
->first();
return $user;
}
}
複製程式碼
如果你要測試或者維護這個類,你必須訪問資料庫的例項來進行一些查詢。為了避免必須這樣做,你可以將此類與其他類進行 解耦 ,你有三個選項之一,可以將 Connection
類注入而不需要直接使用它。
將元件注入類時,可以使用以下三個選項之一:
構造方法注入
class UserProvider{
protected $connection;
public function __construct( Connection $con ){
$this->connection = $con;
}
...
複製程式碼
Setter 方法注入
同樣,我們也可以使用 Setter 方法注入依賴關係:
class UserProvider{
protected $connection;
public function __construct(){
...
}
public function setConnection( Connection $con ){
$this->connection = $con;
}
...
複製程式碼
介面注入
interface ConnectionInjector{
public function injectConnection( Connection $con );
}
class UserProvider implements ConnectionInjector{
protected $connection;
public function __construct(){
...
}
public function injectConnection( Connection $con ){
$this->connection = $con;
}
}
複製程式碼
當一個類實現了我們的介面時,我們定義了 injectConnection
方法來解決依賴關係。
優勢
現在,當測試我們的類時,我們可以模擬依賴類並將其作為引數傳遞。每個類必須專注於一個特定的任務,而不應該關心解決它們的依賴性。這樣,你將擁有一個更專注和可維護的應用程式。
如果你想了解更多關於 DI 的資訊,Alejandro Gervassio 在 本系列 文章中對其進行了廣泛而專業的介紹,所以一定要去讀這些文章。那麼,什麼又是 IoC 呢?IoC (控制反轉)不需要使用依賴注入,但它可以幫助你有效的管理依賴關係。
控制反轉
Ioc 是一個簡單的元件,可以更加方便地解析依賴項。你可以將物件形容為容器,並且每次解析類時,都會自動注入依賴項。
Laravel Ioc
當你請求一個物件時, Laravel Ioc 在解決依賴關係的方式上有些特殊:
我們使用一個簡單的例子,將在本文中改進它。
SimpleAuth
類依賴於 FileSessionStorage
,所以我們的程式碼可能是這樣的:
class FileSessionStorage{
public function __construct(){
session_start();
}
public function get( $key ){
return $_SESSION[$key];
}
public function set( $key, $value ){
$_SESSION[$key] = $value;
}
}
class SimpleAuth{
protected $session;
public function __construct(){
$this->session = new FileSessionStorage;
}
}
//建立一個 SimpleAuth
$auth = new SimpleAuth();
複製程式碼
這是一種經典的方法,讓我們從使用建構函式注入開始。
class SimpleAuth{
protected $session;
public function __construct( FileSessionStorage $session ){
$this->session = $session;
}
}
複製程式碼
現在我們建立一個物件:
$auth = new SimpleAuth( new FileSessionStorage() );
複製程式碼
現在我想使用 Laravel Ioc 來管理這一切。
因為 Application
類繼承自 Container
類,所以你可以通過 App
門面來訪問容器。
App::bind( 'FileSessionStorage', function(){
return new FileSessionStorage;
});
複製程式碼
bind
方法第一個引數是要繫結到容器的唯一 ID ,第二個引數是一個回撥函式每當執行 FileSessionStorage
類時執行,我們還可以傳遞一個表示類名的字串,如下所示。
Note: 如果你檢視 Laravel 包時,你將看到繫結有時會分組,比如( view
, view.finder
……)。
假設我們將會話儲存轉換為 Mysql 儲存,我們的類應該類似於:
class MysqlSessionStorage{
public function __construct(){
//...
}
public function get($key){
// do something
}
public function set( $key, $value ){
// do something
}
}
複製程式碼
現在我們已經更改了依賴項,我們還需要更改 SimpleAuth
建構函式,並將新物件繫結到容器中!
高階模組不應該依賴於低階模組,兩者都應該依賴於抽象物件。 抽象不應該依賴於細節,細節應該取決於抽象。
Robert C. Martin
我們的 SimpleAuth
類不應該關心我們的儲存是如何完成的,相反它更應該關注於消費的服務。
因此,我們可以抽象實現我們的儲存:
interface SessionStorage{
public function get( $key );
public function set( $key, $value );
}
複製程式碼
這樣我們就可以實現並請求 SessionStorage
介面的例項:
class FileSessionStorage implements SessionStorage{
public function __construct(){
//...
}
public function get( $key ){
//...
}
public function set( $key, $value ){
//...
}
}
class MysqlSessionStorage implements SessionStorage{
public function __construct(){
//...
}
public function get( $key ){
//...
}
public function set( $key, $value ){
//...
}
}
class SimpleAuth{
protected $session;
public function __construct( SessionStorage $session ){
$this->session = $session;
}
}
複製程式碼
如果我們使用 App::make('SimpleAuth')
通過容器解析 SimpleAuth
類,容器將會丟擲 BindingResolutionException
,嘗試從繫結解析類之後,返回到反射方法並解析所有依賴項。
Uncaught exception 'Illuminate\Container\BindingResolutionException' with message 'Target [SessionStorage] is not instantiable.'
複製程式碼
容器正試圖將介面例項化。我們可以為該介面做一個具體的繫結。
App:bind( 'SessionStorage', 'MysqlSessionStorage' );
複製程式碼
現在每次我們嘗試從容器解析該介面時,我們會得到一個 MysqlSessionStorage
例項。如果我們想要切換我們的儲存服務,我們只要變更一下這個繫結。
Note: 如果你想要檢視一個類是否已經在容器中被繫結,你可以使用 App::bound('ClassName')
,或者可以使用 App::bindIf('ClassName')
來註冊一個還未被註冊過的繫結。
Laravel Ioc 也提供 App::singleton('ClassName', 'resolver')
來處理單例的繫結。
你也可以使用 App::instance('ClassName', 'instance')
來建立單例的繫結。
如果容器不能解析依賴項就會丟擲 ReflectionException
,但是我們可以使用 App::resolvingAny(Closure)
方法以回撥函式的形式來解析任何指定的型別。
Note: 如果你為某個型別已經註冊了一個解析方式 resolvingAny
方法仍然會被呼叫,但它會直接返回 bind
方法的返回值。
小貼士
- 這些繫結寫在哪兒:
如果只是一個小型應用你可以寫在一個全域性的起始檔案
global/start.php
中,但如果專案變得越來越龐大就有必要使用 Service Provider 。 - 測試:
當需要快速簡易的測試可以考慮使用
php artisan tinker
,它十分強大,且能幫你提升你的 Laravel 測試流程。 - Reflection API: PHP 的 Reflection API 是非常強大的,如果你想要深入 Laravel Ioc 你需要熟悉 Reflection API ,可以先看下這個 教程 來獲得更多的資訊。
最後
和往常一樣,學習或者瞭解某些東西最好的方法就是檢視原始碼。Laravel Ioc 僅僅只是一個檔案,不會花費你太多時間來完成所有功能。你想了解更多關於 Laravel Ioc 或者 Ioc 的一般情況嗎?那請告訴我們吧!