Laravel 是我最近用得非常多而且越用就越喜歡的一款PHP框架,由於沒有向下兼容的歷史包袱,完全面向對象的風格,借助 Facades 優雅的IoC Container 實現,采用 Composer 進行包管理,可以方便地引入和使用開源社區裡的優秀組件……總而言之,這是一款真正讓你能夠 "code happy" 的“巨匠級PHP開發框架”。
在嘗試把自己的 Laravel App 部署到阿裡雲的時候,遇到了一個問題: Laravel 支持 Memcached 緩存,阿裡雲的 OCS 也是基於 Memcached 的緩存,但是阿裡雲 OCS 采用 SASL 認證,而 Laravel 的 Memcached 驅動並沒有實現相關的方法,即使在服務器上編譯PHP Memcached 的時候啟用了 SASL 認證選項,也沒辦法設定用戶名和密碼。
在 Laravel 中,解決這樣的問題,有很多方法。我選擇了最快捷最省事的方法:擴展 Laravel 自己的 Memcached 驅動,通過 Memcached 對象自身的 setSaslAuthData 方法,指定用戶名和密碼。
背景知識
這是利用了 Illuminate\Cache\CacheManager 的 extend 方法(繼承自Illuminate\Support\Manager)。先看一下這個方法的定義:
復制代碼 代碼如下:
/**
* Register a custom driver creator Closure.
*
* @param string $driver
* @param Closure $callback
* @return \Illuminate\Support\Manager|static
*/
public function extend($driver, Closure $callback){}
這個方法接收兩個參數,第一個是代表你自定義的驅動名稱的字符串,第二個是一個閉包回調函數,這個函數就是當調用你的自定義驅動時要執行的方法。通過閱讀 Illuminate\Cache\CacheManager 的源代碼,我們可以發現創建驅動的函數要返回一個 Illuminate\Cache\Repository 的實例,Illuminate\Cache\Repository 的構造函數如下:
復制代碼 代碼如下:
/**
* Create a new cache repository instance.
*
* @param \Illuminate\Cache\StoreInterface $store
*/
public function __construct(StoreInterface $store)
{
$this->store = $store;
}
它需要一個實現了 Illuminate\Cache\StoreInterface 接口的對象,這個接口中定義了 Cache 對象能夠執行的方法。由於我計劃是擴展原有的 Memcached 緩存驅動,在 Illuminate\Cache\CacheManager 的源代碼中,可以看到 Laravel 是這樣創建 Memcached 驅動的:
復制代碼 代碼如下:
/**
* Create an instance of the Memcached cache driver.
*
* @return \Illuminate\Cache\MemcachedStore
*/
protected function createMemcachedDriver()
{
$servers = $this->app['config']['cache.memcached'];
$memcached = $this->app['memcached.connector']->connect($servers);
return $this->repository(new MemcachedStore($memcached, $this->getPrefix()));
}
它先從配置文件中讀取你定義的 Memcached 服務器,然後創建一個 Memcached 對象(通過 Illuminate\Cache\MemcachedConnector 實現,實際上就是創建一個標准的 Memcached 對象,然後調用 Memcached 的 addServer 方法來指定要連接的服務器,然後返回實例化的 Memcached 對象。)
擴展自己的緩存驅動
了解了上述的背景知識之後,就可以來擴展自己的緩存驅動了。思路如下:
1.在 app/config/cache.php 文件中,增加三個配置項,用來設定“是否使用sasl認證”,“sasl認證賬戶”,“sasl認證密碼”。
2.在 bootstrap/start.php 文件中,調用 Cache::extend 方法擴展驅動。
3.在 app/config/cache.php 文件中,修改 driver 配置項,指定系統使用自己擴展的驅動。
增加配置項
首先,打開 app/config/cache.php 文件,找到:
復制代碼 代碼如下:
'memcached' => array(
array('host' => '127.0.0.1', 'port' => 11211, 'weight' => 100),
),
修改為:
復制代碼 代碼如下:
'memcached' => array(
array('host' => '127.0.0.1', 'port' => 11211, 'weight' => 100),
),
'memcached_sasl' => 'true', // 啟用sasl認證
'memcached_user' => 'your ocs username', // 你的 OCS 用戶名
'memcached_pass' => 'your ocs password', // 你的 OCS 密碼
擴展驅動
然後,打開 bootstrap/start.php 文件,在最後一行 return $app; 前面插入代碼:
復制代碼 代碼如下:
// 基於系統自己的 Memcached 緩存驅動,擴展一個名為 saslMemcached 的緩存驅動
Cache::extend('saslMemcached', function($app){
// 從配置文件中讀取 Memcached 服務器配置
$servers = $app['config']['cache.memcached'];
// 利用 Illuminate\Cache\MemcachedConnector 類來創建新的 Memcached 對象
$memcached = $app['memcached.connector']->connect($servers);
// 如果服務器上的 PHP Memcached 擴展支持 SASL 認證
if(ini_get('memcached.use_sasl')){
// 從配置文件中讀取 sasl 認證用戶名
$user = $app['config']['cache.memcached_user'];
// 從配置文件中讀取 sasl 認證密碼
$pass = $app['config']['cache.memcached_pass'];
// 禁用 Memcached 壓縮 (阿裡雲的文檔裡這樣做了……)
$memcached->setOption(Memcached::OPT_COMPRESSION, false);
// 指定 Memcached 使用 binary protocol ( sasl 認證要求 )
$memcached->setOption(Memcached::OPT_BINARY_PROTOCOL, true);
// 指定用於 sasl 認證的賬號密碼
$memcached->setSaslAuthData($user, $pass);
}
// 從配置文件中讀取緩存前綴
$prefix = $app['config']['cache.prefix'];
// 創建 MemcachedStore 對象
$store = new \Illuminate\Cache\MemcachedStore($memcached, $prefix);
// 創建 Repository 對象,並返回
return new \Illuminate\Cache\Repository($store);
});
修改配置,使用自己擴展的緩存驅動
打開 app/config/cache.php 文件,找到:
復制代碼 代碼如下:
"driver" => "file", // 默認是使用文件緩存
修改為:
復制代碼 代碼如下:
"driver" => "saslMemcached", // 剛才擴展實現的驅動名稱
現在,你就可以在你的 阿裡雲 ECS 服務器上, 讓 Laravel 使用 阿裡雲 OCS 緩存服務了。(前提是你的 PHP 支持 Memcached 擴展,並且啟用了 SASL 認證,參考:http://help.aliyun.com/doc/view/13553932.html