SmartWiki開發Laravel快取擴展

因為SmartWiki的演示站點部署在阿里雲上，阿里雲有一個128M免費的Memcache服務，剛開始按照Memcached的配置方式配置完後，發現Laravel報錯，查看日誌報錯位置是addServer出錯，連不上阿里雲的Memcache。

很無奈，於是安裝阿里雲的手冊寫了一個腳本放到伺服器上，結果可以連接，也可以寫入。

阿里雲提供的腳本如下：

<?php
$connect = new Memcached;  //声明一个新的memcached链接
$connect->setOption(Memcached::OPT_COMPRESSION, false); //关闭压缩功能
$connect->setOption(Memcached::OPT_BINARY_PROTOCOL, true); //使用binary二进制协议
$connect->addServer(&#39;00000000.ocs.aliyuncs.com&#39;, 11211); //添加OCS实例地址及端口号
//$connect->setSaslAuthData(&#39;aaaaaaaaaa, &#39;password&#39;); //设置OCS帐号密码进行鉴权，如已开启免密码功能，则无需此步骤
$connect->set("hello", "world");
echo &#39;hello: &#39;,$connect->get("hello");
print_r( $connect->getVersion());
$connect->quit();

翻看laravel的Memcached驅動，在/vendor/laravel/framework/src/Illuminate/Cache/MemcachedConnector.php 中創建Memced對象的程式碼如下：

laravel的Memcached沒有設定setOption方法的選項，僅包含最簡連接建立，緊接著就呼叫getVersion來測試是否連通。而阿里雲的示範程式碼是設定了關閉壓縮和使用binary二進位協定的選項的。

沒辦法只能自己來擴充Memcached的功能實作自訂選項。 laravel中擴充快取可以使用Cache::extend來擴充。擴充代碼如下：

public function connect(array $servers)
{
    $memcached = $this->getMemcached();
    // For each server in the array, we'll just extract the configuration and add
    // the server to the Memcached connection. Once we have added all of these
    // servers we'll verify the connection is successful and return it back.
    foreach ($servers as $server) {
        $memcached->addServer(
            $server['host'], $server['port'], $server['weight']
        );
    }
    $memcachedStatus = $memcached->getVersion();
    if (! is_array($memcachedStatus)) {
        throw new RuntimeException('No Memcached servers added.');
    }
    if (in_array('255.255.255', $memcachedStatus) && count(array_unique($memcachedStatus)) === 1) {
        throw new RuntimeException('Could not establish Memcached connection.');
    }
    return $memcached;
}

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

    $memcached = $this->createMemcached($app);

    // 从配置文件中读取缓存前缀
    $prefix = $app['config']['cache.prefix'];

    // 创建 MemcachedStore 对象
    $store = new MemcachedStore($memcached, $prefix);

    // 创建 Repository 对象，并返回
    return new Repository($store);
});

快取擴充後的程式碼是需要建立一個ServiceProvider來註冊服務提供者。服務提供者是Laravel應用程式啟動的中心，你自己的應用程式以及所有Laravel的核心服務都是透過服務提供者啟動。

但是，我們所謂的「啟動」指的是什麼？通常，這意味著註冊事物，包括註冊服務容器綁定、事件監聽器、中間件甚至路由。服務提供者是應用程式配置的中心。

如果你打開Laravel自帶的config/app.php文件，將會看到一個providers數組，這裡就是應用所要加載的所有服務提供者類，當然，其中很多是延遲加載的，也就是說不是每次請求都會被加載，只有真的用到它們的時候才會加載。

所有的服務提供者都繼承自IlluminateSupportServiceProvider類別。服務提供者大多包含兩種方法： register 和 boot 。在register方法中，你唯一要做的事情就是綁事物到服務容器，不要嘗試在其中註冊事件監聽器，路由或任何其它功能。

透過Artisan指令make:provider可以簡單產生一個新的提供者：

php artisan make:provider MemcachedExtendServiceProvider

所有服務提供者都是透過設定檔config/app.php中進行註冊，該檔案包含了php設定一個列出所有服務提供者名字的providers數組，預設情況下，其中列出了所有核心服務提供者，這些服務提供者啟動Laravel核心元件，例如郵件、佇列、快取等等。

要註冊自己的服務提供者，只需要將其追加到該數組中即可：

/**
 * 创建Memcached对象
 * @param $app
 * @return mixed
 */
protected function createMemcached($app)
{
    // 从配置文件中读取 Memcached 服务器配置
    $servers = $app['config']['cache.stores.MemcachedExtend.servers'];


    // 利用 Illuminate\Cache\MemcachedConnector 类来创建新的 Memcached 对象
    $memcached = new \Memcached;

    foreach ($servers as $server) {
        $memcached->addServer(
            $server['host'], $server['port'], $server['weight']
        );
    }

    // 如果服务器上的 PHP Memcached 扩展支持 SASL 认证
    if (ini_get('memcached.use_sasl') && isset($app['config']['cache.storess.MemcachedExtend.memcached_user']) && isset($app['config']['cache.storess.MemcachedExtend.memcached_pass'])) {

        // 从配置文件中读取 sasl 认证用户名
        $user = $app['config']['cache.storess.MemcachedExtend.memcached_user'];

        // 从配置文件中读取 sasl 认证密码
        $pass = $app['config']['cache.storess.MemcachedExtend.memcached_pass'];

        // 指定用于 sasl 认证的账号密码
        $memcached->setSaslAuthData($user, $pass);
    }

    //扩展
    if (isset($app['config']['cache.stores.MemcachedExtend.options'])) {
        foreach ($app['config']['cache.stores.MemcachedExtend.options'] as $key => $option) {
            $memcached->setOption($key, $option);
        }
    }
    $memcachedStatus = $memcached->getVersion();

    if (! is_array($memcachedStatus)) {
        throw new RuntimeException('No Memcached servers added.');
    }

    if (in_array('255.255.255', $memcachedStatus) && count(array_unique($memcachedStatus)) === 1) {
        throw new RuntimeException('Could not establish Memcached connection.');
    }

    return $memcached;
}

同時在config/cache.php中配置Memcached配置：

'providers' => [
    SmartWiki\Providers\MemcachedExtendServiceProvider::class //
    在providers节点添加实现的provider
    ]

如果需要把Session也儲存到我們擴展的快取中還需要呼叫Session::extend來擴充我們的Session儲存：

'MemcachedExtend' => [
    'driver' => 'MemcachedExtend',
    'servers' => [
        [
            'host' => env('MEMCACHED_EXTEND_HOST', '127.0.0.1'),
            'port' => env('MEMCACHED_EXTEND_PORT', 11211),
            'weight' => 100,
        ],
    ],
    'options' => [
        \Memcached::OPT_BINARY_PROTOCOL => true,
        \Memcached::OPT_COMPRESSION => false
    ]
]

之後再.env中就可以配置我們擴充後的快取了。完整程式碼如下：

Session::extend('MemcachedExtend',function ($app){    
$memcached = $this->createMemcached($app);   
 return new MemcachedSessionHandler($memcached);
});