缓存¶

配置缓存引擎¶

static Cake\Cache\Cache::setConfig($key, $config = null)¶

您的应用程序可以在其引导过程中配置任意数量的“引擎”。 缓存引擎配置在 config/app.php 中定义。

为了获得最佳性能，CakePHP 需要定义两个缓存引擎。

• _cake_core_ 用于存储文件映射以及 国际化 & 本地化 文件的解析结果。

• _cake_model_ 用于存储应用程序模型的模式描述。

使用多个引擎配置还可以让您根据需要逐步更改存储。 例如，在您的 config/app.php 中，您可以添加以下内容

// ...
'Cache' => [
    'short' => [
        'className' => 'File',
        'duration' => '+1 hours',
        'path' => CACHE,
        'prefix' => 'cake_short_',
    ],
    // Using a fully namespaced name.
    'long' => [
        'className' => 'Cake\Cache\Engine\FileEngine',
        'duration' => '+1 week',
        'probability' => 100,
        'path' => CACHE . 'long' . DS,
    ],
]
// ...

配置选项也可以作为 DSN 字符串提供。 这在使用环境变量或 PaaS 提供商时很有用

Cache::setConfig('short', [
    'url' => 'memcached://user:password@cache-host/?timeout=3600&prefix=myapp_',
]);

使用 DSN 字符串时，您可以将任何其他参数/选项定义为查询字符串参数。

您也可以在运行时配置缓存引擎

// Using a short name
Cache::setConfig('short', [
    'className' => 'File',
    'duration' => '+1 hours',
    'path' => CACHE,
    'prefix' => 'cake_short_'
]);

// Using a fully namespaced name.
Cache::setConfig('long', [
    'className' => 'Cake\Cache\Engine\FileEngine',
    'duration' => '+1 week',
    'probability' => 100,
    'path' => CACHE . 'long' . DS,
]);

// Using a constructed object.
$object = new FileEngine($config);
Cache::setConfig('other', $object);

这些引擎配置的名称（“short” 和 “long”）用作 Cake\Cache\Cache::write() 和 Cake\Cache\Cache::read() 的 $config 参数。 配置缓存引擎时，您可以使用以下语法引用类名

// Short name (in App\ or Cake namespaces)
Cache::setConfig('long', ['className' => 'File']);

// Plugin short name
Cache::setConfig('long', ['className' => 'MyPlugin.SuperCache']);

// Full namespace
Cache::setConfig('long', ['className' => 'Cake\Cache\Engine\FileEngine']);

// An object implementing CacheEngineInterface
Cache::setConfig('long', ['className' => $myCache]);

Cache::setConfig('redis', [
    'className' => 'Redis',
    'duration' => '+1 hours',
    'prefix' => 'cake_redis_',
    'host' => '127.0.0.1',
    'port' => 6379,
    'fallback' => 'default',
]);

Cache::setConfig('redis', [
    'className' => 'Redis',
    'duration' => '+1 hours',
    'prefix' => 'cake_redis_',
    'host' => '127.0.0.1',
    'port' => 6379,
    'fallback' => false
]);

写入缓存¶

static Cake\Cache\Cache::write($key, $value, $config = 'default')¶

Cache::write() 将 $value 写入缓存。您可以稍后通过引用 $key 来读取或删除此值。您也可以指定一个可选配置来存储缓存。如果没有指定 $config，将使用默认配置。 Cache::write() 可以存储任何类型的对象，非常适合存储模型查找的结果。

$posts = Cache::read('posts');
if ($posts === null) {
    $posts = $someService->getAllPosts();
    Cache::write('posts', $posts);
}

使用 Cache::write() 和 Cache::read() 减少访问数据库以获取帖子的次数。

$result = Cache::writeMany([
    'article-' . $slug => $article,
    'article-' . $slug . '-comments' => $comments
]);

// $result will contain
['article-first-post' => true, 'article-first-post-comments' => true]

// Set a key to act as a lock
$result = Cache::add($lockKey, true);
if (!$result) {
    return;
}
// Do an action where there can only be one process active at a time.

// Remove the lock key.
Cache::delete($lockKey);

class IssueService
{
    public function allIssues($repo)
    {
        return Cache::remember($repo . '-issues', function () use ($repo) {
            return $this->fetchAll($repo);
        });
    }
}

从缓存中读取¶

static Cake\Cache\Cache::read($key, $config = 'default')¶

Cache::read() 用于从 $config 中读取存储在 $key 下的缓存值。如果 $config 为 null，将使用默认配置。 Cache::read() 将返回缓存值（如果它是有效的缓存）或 null（如果缓存已过期或不存在）。使用严格的比较运算符 === 或 !== 来检查 Cache::read() 操作的成功与否。

例如

$cloud = Cache::read('cloud');
if ($cloud !== null) {
    return $cloud;
}

// Generate cloud data
// ...

// Store data in cache
Cache::write('cloud', $cloud);

return $cloud;

或者，如果您使用另一个名为 short 的缓存配置，您可以像下面这样在 Cache::read() 和 Cache::write() 调用中指定它。

// Read key "cloud", but from short configuration instead of default
$cloud = Cache::read('cloud', 'short');
if ($cloud === null) {
    // Generate cloud data
    // ...

    // Store data in cache, using short cache configuration instead of default
    Cache::write('cloud', $cloud, 'short');
}

return $cloud;

$result = Cache::readMany([
    'article-' . $slug,
    'article-' . $slug . '-comments'
]);
// $result will contain
['article-first-post' => '...', 'article-first-post-comments' => '...']

从缓存中删除¶

static Cake\Cache\Cache::delete($key, $config = 'default')¶

Cache::delete() 用于从存储中完全删除缓存对象。

// Remove a key
Cache::delete('my_key');

从 4.4.0 版本开始，RedisEngine 还提供了一个 deleteAsync() 方法，该方法使用 UNLINK 操作删除缓存键。

Cache::pool('redis')->deleteAsync('my_key');

$result = Cache::deleteMany([
    'article-' . $slug,
    'article-' . $slug . '-comments'
]);
// $result will contain
['article-first-post' => true, 'article-first-post-comments' => true]

清除缓存数据¶

static Cake\Cache\Cache::clear($config = 'default')¶

销毁缓存配置的所有缓存值。在像 Apcu、Memcached 这样的引擎中，缓存配置的前缀用于删除缓存条目。请确保不同的缓存配置具有不同的前缀。

// Will clear all keys.
Cache::clear();

从 4.4.0 版本开始，RedisEngine 还提供了一个 clearBlocking() 方法，该方法使用 UNLINK 操作删除缓存键。

Cache::pool('redis')->clearBlocking();

使用缓存存储计数器¶

static Cake\Cache\Cache::increment($key, $offset = 1, $config = 'default')¶

static Cake\Cache\Cache::decrement($key, $offset = 1, $config = 'default')¶

应用程序中的计数器是存储在缓存中的好选择。例如，一个简单的比赛剩余“名额”倒计时可以存储在缓存中。Cache 类公开了原子方式来增加/减少计数器值。对于这些值，原子操作非常重要，因为它可以减少竞争风险，以及两个用户同时将值减少一个，从而导致不正确的值。

在设置整数后，可以使用 increment() 和 decrement() 对其进行操作。

Cache::write('initial_count', 10);

// Later on
Cache::decrement('initial_count');

// Or
Cache::increment('initial_count');

使用缓存存储常见查询结果¶

您可以通过将不常改变的结果或频繁读取的结果放入缓存中来极大地提高应用程序的性能。一个完美的例子是 Cake\ORM\Table::find() 的结果。Query 对象允许您使用 cache() 方法缓存结果。有关更多信息，请参阅 Caching Loaded Results 部分。

使用组¶

有时您希望将多个缓存条目标记为属于某个组或命名空间。这对于在某些信息发生变化时批量失效键是一个常见的要求，这些信息在同一组中的所有条目之间共享。这可以通过在缓存配置中声明组来实现。

Cache::setConfig('site_home', [
    'className' => 'Redis',
    'duration' => '+999 days',
    'groups' => ['comment', 'article'],
]);

Cake\Cache\Cache::clearGroup($group, $config = 'default')¶

假设您想要将首页生成的 HTML 存储在缓存中，但也希望在每次向数据库添加评论或帖子时自动失效此缓存。通过添加组 comment 和 article，我们实际上用这两个组名标记了存储到此缓存配置中的任何键。

例如，每当添加新帖子时，我们都可以告诉 Cache 引擎删除与 article 组关联的所有条目。

// src/Model/Table/ArticlesTable.php
public function afterSave($event, $entity, $options = [])
{
    if ($entity->isNew()) {
        Cache::clearGroup('article', 'site_home');
    }
}

static Cake\Cache\Cache::groupConfigs($group = null)¶

groupConfigs() 可用于检索组和配置之间的映射，即：具有相同的组。

// src/Model/Table/ArticlesTable.php

/**
 * A variation of previous example that clears all Cache configurations
 * having the same group
 */
public function afterSave($event, $entity, $options = [])
{
    if ($entity->isNew()) {
        $configs = Cache::groupConfigs('article');
        foreach ($configs['article'] as $config) {
            Cache::clearGroup('article', $config);
        }
    }
}

组在所有使用相同引擎和相同前缀的缓存配置之间共享。如果您使用组并希望利用组删除，请为所有配置选择一个通用前缀。

全局启用或禁用缓存¶

static Cake\Cache\Cache::disable¶

在尝试找出与缓存过期相关的问题时，您可能需要禁用所有缓存读写。您可以使用 enable() 和 disable() 来实现。

// Disable all cache reads, and cache writes.
Cache::disable();

禁用后，所有读写都将返回 null。

static Cake\Cache\Cache::enable¶

禁用后，可以使用 enable() 重新启用缓存。

// Re-enable all cache reads, and cache writes.
Cache::enable();

static Cake\Cache\Cache::enabled¶

如果您需要检查缓存的状态，可以使用 enabled()。

创建缓存引擎¶

您可以在 App\Cache\Engine 中以及在插件中使用 $plugin\Cache\Engine 提供自定义的 Cache 引擎。缓存引擎必须位于缓存目录中。如果您有一个名为 MyCustomCacheEngine 的缓存引擎，它将被放置在 src/Cache/Engine/MyCustomCacheEngine.php 中。或者作为插件的一部分，放在 plugins/MyPlugin/src/Cache/Engine/MyCustomCacheEngine.php 中。来自插件的缓存配置需要使用插件点语法。

Cache::setConfig('custom', [
    'className' => 'MyPlugin.MyCustomCache',
    // ...
]);

自定义缓存引擎必须扩展 Cake\Cache\CacheEngine，它定义了一些抽象方法，并提供了一些初始化方法。

CacheEngine 的必需 API 是

class Cake\Cache\CacheEngine¶

所有与 Cache 一起使用的缓存引擎的基类。

Cake\Cache\CacheEngine::write($key, $value)¶

返回值：

布尔值，表示成功。

将键的值写入缓存，如果数据成功缓存，则返回 true，如果失败，则返回 false。

Cake\Cache\CacheEngine::read($key)¶

返回值：

缓存的值，如果失败则返回 null。

从缓存中读取键。返回 null 表示条目已过期或不存在。

Cake\Cache\CacheEngine::delete($key)¶

返回值：

布尔值 true 表示成功。

从缓存中删除键。返回 false 表示条目不存在或无法删除。

Cake\Cache\CacheEngine::clear($check)¶

返回值：

布尔值 true 表示成功。

删除缓存中的所有键。如果 $check 为 true，则应验证每个值是否确实已过期。

Cake\Cache\CacheEngine::clearGroup($group)¶

返回值：

布尔值 true 表示成功。

删除缓存中属于同一组的所有键。

Cake\Cache\CacheEngine::decrement($key, $offset = 1)¶

返回值：

布尔值 true 表示成功。

递减键值下的数字并返回递减后的值

Cake\Cache\CacheEngine::increment($key, $offset = 1)¶

返回值：

布尔值 true 表示成功。

递增键值下的数字并返回递增后的值