Laravel中擴展Memcached緩存驅(qū)動實現(xiàn)使用阿里云OCS緩存

更新時間：2015年02月10日 09:20:27 投稿：junjie

這篇文章主要介紹了Laravel中擴展Memcached緩存驅(qū)動實現(xiàn)使用阿里云OCS緩存,本文擴展了一個支持SASL 認證模式的Memcached緩存驅(qū)動,需要的朋友可以參考下

Laravel 是我最近用得非常多而且越用就越喜歡的一款PHP框架，由于沒有向下兼容的歷史包袱，完全面向?qū)ο蟮娘L格，借助 Facades 優(yōu)雅的IoC Container 實現(xiàn)，采用 Composer 進行包管理，可以方便地引入和使用開源社區(qū)里的優(yōu)秀組件……總而言之，這是一款真正讓你能夠 "code happy" 的“巨匠級PHP開發(fā)框架”。

在嘗試把自己的 Laravel App 部署到阿里云的時候，遇到了一個問題： Laravel 支持 Memcached 緩存，阿里云的 OCS 也是基于 Memcached 的緩存，但是阿里云 OCS 采用 SASL 認證，而 Laravel 的 Memcached 驅(qū)動并沒有實現(xiàn)相關(guān)的方法，即使在服務器上編譯PHP Memcached 的時候啟用了 SASL 認證選項，也沒辦法設定用戶名和密碼。

在 Laravel 中，解決這樣的問題，有很多方法。我選擇了最快捷最省事的方法：擴展 Laravel 自己的 Memcached 驅(qū)動，通過 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){}

這個方法接收兩個參數(shù)，第一個是代表你自定義的驅(qū)動名稱的字符串，第二個是一個閉包回調(diào)函數(shù)，這個函數(shù)就是當調(diào)用你的自定義驅(qū)動時要執(zhí)行的方法。通過閱讀 Illuminate\Cache\CacheManager 的源代碼，我們可以發(fā)現(xiàn)創(chuàng)建驅(qū)動的函數(shù)要返回一個 Illuminate\Cache\Repository 的實例，Illuminate\Cache\Repository 的構(gòu)造函數(shù)如下：

復制代碼代碼如下:

/**

 * Create a new cache repository instance.

 *

 * @param  \Illuminate\Cache\StoreInterface  $store

 */

public function __construct(StoreInterface $store)

{

    $this->store = $store;

}

它需要一個實現(xiàn)了 Illuminate\Cache\StoreInterface 接口的對象，這個接口中定義了 Cache 對象能夠執(zhí)行的方法。由于我計劃是擴展原有的 Memcached 緩存驅(qū)動，在 Illuminate\Cache\CacheManager 的源代碼中，可以看到 Laravel 是這樣創(chuàng)建 Memcached 驅(qū)動的：

復制代碼代碼如下:

/**

 * 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 服務器，然后創(chuàng)建一個 Memcached 對象（通過 Illuminate\Cache\MemcachedConnector 實現(xiàn)，實際上就是創(chuàng)建一個標準的 Memcached 對象，然后調(diào)用 Memcached 的 addServer 方法來指定要連接的服務器，然后返回實例化的 Memcached 對象。)

擴展自己的緩存驅(qū)動

了解了上述的背景知識之后，就可以來擴展自己的緩存驅(qū)動了。思路如下：

1.在 app/config/cache.php 文件中，增加三個配置項，用來設定“是否使用sasl認證”,“sasl認證賬戶”，“sasl認證密碼”。
2.在 bootstrap/start.php 文件中，調(diào)用 Cache::extend 方法擴展驅(qū)動。
3.在 app/config/cache.php 文件中，修改 driver 配置項，指定系統(tǒng)使用自己擴展的驅(qū)動。

增加配置項

首先，打開 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 密碼

擴展驅(qū)動

然后，打開 bootstrap/start.php 文件，在最后一行 return $app; 前面插入代碼：

復制代碼代碼如下:

// 基于系統(tǒng)自己的 Memcached 緩存驅(qū)動，擴展一個名為 saslMemcached 的緩存驅(qū)動

Cache::extend('saslMemcached', function($app){

    // 從配置文件中讀取 Memcached 服務器配置

    $servers = $app['config']['cache.memcached'];

    // 利用 Illuminate\Cache\MemcachedConnector 類來創(chuàng)建新的 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'];

    // 創(chuàng)建 MemcachedStore 對象

    $store = new \Illuminate\Cache\MemcachedStore($memcached, $prefix);

    // 創(chuàng)建 Repository 對象，并返回

    return new \Illuminate\Cache\Repository($store);

});