# Laravel 的缓存系统
- [配置信息](#configuration)
- [驱动前提条件](#driver-prerequisites)
- [缓存的使用](#cache-usage)
- [获取一个缓存实例](#obtaining-a-cache-instance)
- [从缓存中获取项目](#retrieving-items-from-the-cache)
- [存放项目到缓存中](#storing-items-in-the-cache)
- [删除缓存中的项目](#removing-items-from-the-cache)
- [Cache 帮助函数](#the-cache-helper)
- [缓存标签](#cache-tags)
- [写入被标记的缓存项](#storing-tagged-cache-items)
- [访问被标记的缓存项](#accessing-tagged-cache-items)
- [移除被标记的缓存项](#removing-tagged-cache-items)
- [增加自定义的缓存驱动](#adding-custom-cache-drivers)
- [写驱动](#writing-the-driver)
- [注册驱动](#registering-the-driver)
- [缓存事件](#events)
<a name="configuration"></a>
## 配置信息
Laravel 给多种缓存系统提供丰富而统一的 API，缓存配置信息位于 `config/cache.php`，在这个文件中你可以为你的应用程序指定默认的缓存驱动，Laravel 支持当前流行的缓存系统，如非常棒的 [Memcached](https://memcached.org) 和 [Redis](http://redis.io) 。
缓存配置信息文件中也包括很多其他选项，你可以在文件中找到这些选项，请确保你看过这些选项说明。Laravel 默认使用将序列化缓存对象保存在文件系统中的 `file` 缓存驱动，对于大型应用程序而言，推荐你使用如 Memcached 或者 Redis 这样更强大的缓存驱动。你甚至可以为一个驱动配置多个缓存配置信息。
<a name="driver-prerequisites"></a>
### 驱动前提条件
#### 数据库
当使用 `database` 缓存驱动时，你需要配置一个用来存放缓存项的数据库表，下面是一个 `Schema` 数据表结构声明的示例：
Schema::create('cache', function ($table) {
$table->string('key')->unique();
$table->text('value');
$table->integer('expiration');
});
> {tip} 你也可以使用 `php artisan cache:table` 这个 Artisan 命令生成一个有合适数据表结构的 migration 。
#### Memcached
使用 Memcached 驱动需要安装 [Memcached PECL 扩展包](https://pecl.php.net/package/memcached) 。你可以把所有 Memcached 服务器都列在 `config/cache.php` 这个配置信息文件中：
'memcached' => [
[
'host' => '127.0.0.1',
'port' => 11211,
'weight' => 100
],
],
当然你也可以把 `host` 选项配置为 UNIX 的 socket 路径。如果你这样配置了， `port` 选项应该设置为 `0`:
'memcached' => [
[
'host' => '/var/run/memcached/memcached.sock',
'port' => 0,
'weight' => 100
],
],
#### Redis
在使用 Redis 作为 Laravel 的缓存驱动前，你需要通过 Composer 安装 `predis/predis` 扩展包 (~1.0) 或者使用 PECL 安装 PhpRedis PHP 拓展。
如需了解更多配置 Redis 的信息，请参考 [Laravel 文档页面](/docs/{{version}}/redis#configuration).
<a name="cache-usage"></a>
## 缓存的使用
<a name="obtaining-a-cache-instance"></a>
### 获取一个缓存实例
`Illuminate\Contracts\Cache\Factory` 和 `Illuminate\Contracts\Cache\Repository` [contracts](/docs/{{version}}/contracts) 提供了访问 Laravel 缓存服务的机制。 `Factory` contract 则为你的应用程序定义了访问所有缓存驱动的机制。 `Repository` contract 是典型的用 `cache` 配置信息文件指定你的应用程序默认缓存驱动的实现。
然而，你也可以使用 `Cache` facade ，我们将在文档的后续中介绍。`Cache` facade 提供了方便又简洁的方法访问缓存实例：
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
class UserController extends Controller
{
/**
* Show a list of all users of the application.
*
* @return Response
*/
public function index()
{
$value = Cache::get('key');
//
}
}
#### 访问多个缓存仓库
使用 `Cache` facade, 你可以通过 `store` 方法来访问缓存仓库。 传入 `store` 方法的键应该对应一个 `cache` 配置信息文件中的 `stores` 配置信息数组中列出的配置值：
$value = Cache::store('file')->get('foo');
Cache::store('redis')->put('bar', 'baz', 10);
<a name="retrieving-items-from-the-cache"></a>
### 从缓存中获取项目
`Cache` facade 中的 `get` 方法用来从缓存中获取缓存项，如果缓存中不存在该缓存项，则返回 `null` 。你也可以向 `get` 方法传递第二个参数，用来指定缓存项不存在时返回的默认值：
$value = Cache::get('key');
$value = Cache::get('key', 'default');
你甚至可以将 `Closure` 作为默认值传递。如果指定的缓存项在缓存中不存在， `Closure` 的结果将被返回。传递一个闭包允许你延迟从数据库或外部服务中取出默认值：
$value = Cache::get('key', function () {
return DB::table(...)->get();
});
#### 确认项目是否存在
`has` 方法可以用来检查一个项目是否存在于缓存中，如果值为 `null` 或 `false` ，则此方法将返回 `false`：
if (Cache::has('key')) {
//
}
#### 递增与递减值
`increment` 和 `decrement` 方法可以用来调整缓存中整数项目值。这两个方法都可以传入一个可选的第二个参数，用来指示要递增或递减多少值：
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);
#### 获取和更新
有时你可能会想从缓存中取出一个项目，但也想在取出的项目不存在时存入一个默认值，例如，你可能会想从缓存中取出所有用户，或者当用户不存在时，从数据库中将这些用户取出并放入缓存中，你可以使用 `Cache::remember` 方法实现：
$value = Cache::remember('users', $minutes, function () {
return DB::table('users')->get();
});
如果缓存项在缓存中不存在，则返回给 `remember` 方法的 `Closure` 将会被运行，其结果将被放置在缓存中。
#### 获取和删除
如果你需要从缓存中获取一个缓存项然后删除它，你可以使用 `pull` 方法。像 `get` 方法一样，如果缓存项在缓存中不存在， 则返回 `null` :
$value = Cache::pull('key');
<a name="storing-items-in-the-cache"></a>
### 存储项目到缓存中
你可以使用 `Cache` facade 的 `put` 方法来存放缓存项到缓存中，当你在缓存中存放缓存项时，你需要使用第三个参数来设定缓存的存放时间：
Cache::put('key', 'value', $minutes);
如果要指定一个缓存项过期的分钟数，你也可以传递一个 `DateTime` 实例来表示该缓存项过期的时间点：
$expiresAt = Carbon::now()->addMinutes(10);
Cache::put('key', 'value', $expiresAt);
#### 写入目前不存在的项目
`add` 方法只会把暂时不存在于缓存中的缓存项放入缓存，如果存放成功将返回 `true` ，否则返回 `false` ：
Cache::add('key', 'value', $minutes);
#### 永久写入项目
`forever` 方法可以用来将缓存项永久存入缓存中，因为这些缓存项不会过期，所以必须通过 `forget` 方法手动删除：
Cache::forever('key', 'value');
> {tip} 如果你使用 Memcached 驱动，那么当缓存达到大小限制时，那些「永久」保存的缓存项可能会被删除。
<a name="removing-items-from-the-cache"></a>
### 从缓存中移除项目
你可以使用 `forget` 方法从缓存中移除一个项目：
Cache::forget('key');
你也可以使用 `flush` 方法清空所有缓存：
Cache::flush();
> {note} 清空缓存并不会遵从缓存的前缀，并且会将缓存中所有的缓存项删除。在清除与其它应用程序共享的缓存时应谨慎考虑这一点。
<a name="the-cache-helper"></a>
### Cache 帮助函数
除了可以使用 `Cache` facade 或者 [cache contract](/docs/{{version}}/contracts)之外，你也可以使用全局帮助函数 `cache` 来获取和保存缓存数据。当 `cache` 只接收一个字符串参数的时候，它将会返回给定键对应的值：
$value = cache('key');
如果你传给函数一个键值对数组和过期时间，它将会把值和过期时间保存在缓存中：
cache(['key' => 'value'], $minutes);
cache(['key' => 'value'], Carbon::now()->addSeconds(10));
> {tip} 如果在测试中使用全局函数 `cache` ，你应该使用 `Cache::shouldReceive` 方法，就好像你在 [测试 facade](/docs/{{version}}/mocking#mocking-facades)一样。
<a name="cache-tags"></a>
## 缓存标签
> {note} 缓存标签并不支持使用 `file` 或 `database` 的缓存驱动。此外，当在缓存使用多个标签并 「永久」写入时，类似 `memcached` 的驱动性能会是最佳的，且会自动清除旧的纪录。
<a name="storing-tagged-cache-items"></a>
### 写入被标记的缓存项
缓存标签允许你在缓存中标记关联的项目，并清空所有已分配指定标签的缓存值。你可以通过传入一组标签名称的有序数组，以访问被标记的缓存。举例来说，让我们访问一个被标记的缓存并 `put` 值给它：
Cache::tags(['people', 'artists'])->put('John', $john, $minutes);
Cache::tags(['people', 'authors'])->put('Anne', $anne, $minutes);
<a name="accessing-tagged-cache-items"></a>
### 访问被标记的缓存项
若要获取一个被标记的缓存项，只要传递一样的有序标签列表至 `tags` 方法，然后通过你希望获取的值对应的键来调用 `get` 方法：
$john = Cache::tags(['people', 'artists'])->get('John');
$anne = Cache::tags(['people', 'authors'])->get('Anne');
<a name="removing-tagged-cache-items"></a>
### 移除被标记的缓存项
你可以清空已分配的单个标签或是一组标签列表中的所有缓存项。例如，下方的语句会把被标记为 `people` ， `authors`，或两者都标记了的缓存都移除。所以， `Anne` 与 `John` 都会从缓存中移除：
Cache::tags(['people', 'authors'])->flush();
相反的，下方的语句只会删除被标记为 `authors` 的缓存，所以 `Anne` 会被移除，但 `John` 不会：
Cache::tags('authors')->flush();
<a name="adding-custom-cache-drivers"></a>
## 增加自定义的缓存驱动
<a name="writing-the-driver"></a>
### 写驱动
为了创建自定义的缓存驱动，首先我们需要部署 `Illuminate\Contracts\Cache\Store` [contract](/docs/{{version}}/contracts) 。所以 MongoDB 缓存实现看起来会像这样：
<?php
namespace App\Extensions;
use Illuminate\Contracts\Cache\Store;
class MongoStore implements Store
{
public function get($key) {}
public function many(array $keys);
public function put($key, $value, $minutes) {}
public function putMany(array $values, $minutes);
public function increment($key, $value = 1) {}
public function decrement($key, $value = 1) {}
public function forever($key, $value) {}
public function forget($key) {}
public function flush() {}
public function getPrefix() {}
}
我们只需要通过一个 MongoDB 的连接来实现这些方法。关于如何实现这些方法，可以查看框架源代码中的 `Illuminate\Cache\MemcachedStore` 。一旦我们的部署完成，我们就可以完成自定义驱动的注册了。
Cache::extend('mongo', function ($app) {
return Cache::repository(new MongoStore);
});
> {tip} 如果你想知道把自定义的缓存驱动代码放置在哪里，你可以在 `app` 目录下创建一个 `Extensions` 命名空间。Laravel 没有硬性规定应用程序的结构，你可以依照你的喜好任意组织你的应用程序。
<a name="registering-the-driver"></a>
### 注册驱动
通过 Laravel 注册自定义缓存驱动，我们将用到 `Cache` facade 的 `extend` 方法。`Cache::extend` 的调用会在最新的 Laravel 应用程序默认的 `App\Providers\AppServiceProvider` 的 `boot` 方法中完成。或者你可以创建你自己的服务提供者来放置这些扩展 - 不要忘记在 `config/app.php` 提供者数组中注册提供者：
<?php
namespace App\Providers;
use App\Extensions\MongoStore;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\ServiceProvider;
class CacheServiceProvider extends ServiceProvider
{
/**
* Perform post-registration booting of services.
*
* @return void
*/
public function boot()
{
Cache::extend('mongo', function ($app) {
return Cache::repository(new MongoStore);
});
}
/**
* Register bindings in the container.
*
* @return void
*/
public function register()
{
//
}
}
传递给 `extend` 方法的第一个参数是驱动名称。这取决于你的 `config/cache.php` 配置信息文件的 `driver` 选项。第二个参数是一个闭包，它应该返回一个 `Illuminate\Cache\Repository` 实例。这个闭包将传递一个[service container](/docs/{{version}}/container)的 `$app` 实例。
一旦你的扩展被注册，就可以轻松的更新 `config/cache.php` 配置信息文件的 `driver` 选项为你的扩展名称。
<a name="events"></a>
## 缓存事件
为了在每一次缓存操作时执行代码，你可以监听缓存触发的事件 [事件](/docs/{{version}}/events) 。一般来说，你应该将这些事件监听器放置在 `EventServiceProvider` 中:
/**
* The event listener mappings for the application.
*
* @var array
*/
protected $listen = [
'Illuminate\Cache\Events\CacheHit' => [
'App\Listeners\LogCacheHit',
],
'Illuminate\Cache\Events\CacheMissed' => [
'App\Listeners\LogCacheMissed',
],
'Illuminate\Cache\Events\KeyForgotten' => [
'App\Listeners\LogKeyForgotten',
],
'Illuminate\Cache\Events\KeyWritten' => [
'App\Listeners\LogKeyWritten',
],
];
## 译者署名
| 用户名 | 头像 | 职能 | 签名 |
| ---------------------------------------- | ---------------------------------------- | ---- | ---------------------------------------- |
| [@GanymedeNil](https://github.com/GanymedeNil) | <img class="avatar-66 rm-style" src="https://dn-phphub.qbox.me/uploads/avatars/6859_1487055454.jpg?imageView2/1/w/100/h/100"> | 翻译 | 争做一个 Full Stack Developer [@GanymedeNil](http://weibo.com/jinhongyang) |
---
> {note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。
>
> 转载请注明：本文档由 Laravel China 社区 [laravel-china.org](https://laravel-china.org) 组织翻译，详见 [翻译召集帖](https://laravel-china.org/topics/5756/laravel-55-document-translation-call-come-and-join-the-translation)。
>
> 文档永久地址： https://d.laravel-china.org
- 说明
- 翻译说明
- 发行说明
- 升级说明
- 贡献导引
- 入门指南
- 安装
- 配置信息
- 文件夹结构
- HomeStead
- Valet
- 核心架构
- 请求周期
- 服务容器
- 服务提供者
- 门面（Facades）
- Contracts
- 基础功能
- 路由
- 中间件
- CSRF 保护
- 控制器
- 请求
- 响应
- 视图
- 重定向
- Session
- 表单验证
- 错误与日志
- 前端开发
- Blade 模板
- 本地化
- 前端指南
- 编辑资源 Mix
- 安全
- 用户认证
- API认证
- 用户授权
- 加密解密
- 哈希
- 重置密码
- 综合话题
- Artisan 命令行
- 广播系统
- 缓存系统
- 集合
- 事件系统
- 文件存储
- 辅助函数
- 邮件发送
- 消息通知
- 扩展包开发
- 队列
- 任务调度
- 数据库
- 快速入门
- 查询构造器
- 分页
- 数据库迁移
- 数据填充
- Redis
- Eloquent ORM
- 快速入门
- 模型关联
- Eloquent 集合
- 修改器
- API 资源
- 序列化
- 测试
- 快速入门
- HTTP 测试
- 浏览器测试 Dusk
- 数据库测试
- 测试模拟器
- 官方扩展包
- Cashier 交易工具包
- Envoy 部署工具
- Horizon
- Passport OAuth 认证
- Scout 全文搜索
- Socialite 社交化登录
- 交流说明