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
来源: https://www.php1.cn/detail/php-1cb373789b.html