包简介

A persistent object cache backend for WordPress powered by Redis. Supports Predis, PhpRedis, Relay, replication, sentinels, clustering and WP-CLI.

README 文档

README

A persistent object cache backend powered by Redis®¹. Supports Predis, PhpRedis (PECL), Relay, replication, sentinels, clustering and WP-CLI.

Object Cache Pro

A business class Redis®¹ object cache backend. Truly reliable, highly optimized, fully customizable and with a dedicated engineer when you most need it.

Rewritten for raw performance
100% WordPress API compliant
Faster serialization and compression
Easy debugging & logging
Cache prefetching and advanced analytics
Fully unit tested (100% code coverage)
Optimized for WooCommerce, Jetpack & Yoast SEO
And much more...

Installation

To get started, please see the installation instructions.

FAQ & Troubleshooting

Answers to common questions and troubleshooting of common errors can be found in the FAQ.

Configuration

The Redis Object Cache plugin comes with vast set of configuration options. If you're unsure how to use them read the installation instructions.

Configuration constant	Default	Description
`WP_REDIS_HOST`	`127.0.0.1`	The hostname of the Redis server
`WP_REDIS_PORT`	`6379`	The port of the Redis server
`WP_REDIS_PATH`		The path to the unix socket of the Redis server
`WP_REDIS_SCHEME`	`tcp`	The scheme used to connect: `tcp` or `unix`
`WP_REDIS_DATABASE`	`0`	The database used by the cache: `0-15`
`WP_REDIS_PREFIX`		The prefix used for all cache keys to avoid data collisions (replaces `WP_CACHE_KEY_SALT`), should be human readable and not a "salt"
`WP_REDIS_PASSWORD`		The password of the Redis server, supports Redis ACLs arrays: `['user', 'password']`
`WP_REDIS_MAXTTL`	`0`	The maximum time-to-live of cache keys
`WP_REDIS_CLIENT`		The client used to communicate with Redis (defaults to `phpredis` when installed, otherwise `predis`), supports `phpredis`, `predis`, `relay`
`WP_REDIS_TIMEOUT`	`1`	The connection timeout in seconds
`WP_REDIS_READ_TIMEOUT`	`1`	The timeout in seconds when reading/writing
`WP_REDIS_IGNORED_GROUPS`	`[]`	Groups that should not be cached between requests in Redis (read more)

Advanced configuration options

Configuration constant	Default	Description
`WP_CACHE_KEY_SALT`		Deprecated. Replaced by `WP_REDIS_PREFIX`
`WP_REDIS_SSL_CONTEXT`	`[]`	TLS connection options for `tls` or `rediss` scheme
`WP_REDIS_FLUSH_TIMEOUT`	`5`	Experimental. The timeout in seconds when flushing
`WP_REDIS_RETRY_INTERVAL`		The number of milliseconds between retries (PhpRedis only)
`WP_REDIS_GLOBAL_GROUPS`	`[]`	Additional groups that are considered global on multisite networks
`WP_REDIS_CHART_COLOR`		Override admin metrics chart color using a hex value (`#RGB` or `#RRGGBB`)
`WP_REDIS_METRICS_MAX_TIME`	`3600`	The maximum number of seconds metrics should be stored
`WP_REDIS_IGBINARY`	`false`	Whether to use the igbinary PHP extension for serialization
`WP_REDIS_DISABLED`	`false`	Emergency switch to bypass the object cache without deleting the drop-in
`WP_REDIS_DISABLE_ADMINBAR`	`false`	Disables admin bar display
`WP_REDIS_DISABLE_METRICS`	`false`	Disables metrics collection and display
`WP_REDIS_DISABLE_DROPIN_CHECK`	`false`	Disables the extended drop-in write test
`WP_REDIS_DISABLE_DROPIN_AUTOUPDATE`	`false`	Disables the drop-in auto-update
`WP_REDIS_DISABLE_GROUP_FLUSH`	`false`	Disables group flushing with Lua script and uses `flushdb` call instead
`WP_REDIS_DISABLE_BANNERS`	`false`	Disables promotional banners and notices
`WP_REDIS_DISABLE_COMMENT`	`false`	Disables HTML source comment
`WP_REDIS_LOAD_APEXCHARTS`	`true`	Whether to load the ApexCharts script
`WP_REDIS_MANAGER_CAPABILITY`		The capability a user must have to manage the plugin

Unsupported configuration options

Options that exist, but should not, may break without notice in future releases and won't receive any support whatsoever from our team:

Configuration constant	Default	Description
`WP_REDIS_GRACEFUL`	`false`	Prevents exceptions from being thrown, but will cause data corruption
`WP_REDIS_SELECTIVE_FLUSH`	`false`	Uses terribly slow Lua script for flushing
`WP_REDIS_UNFLUSHABLE_GROUPS`	`[]`	Uses terribly slow Lua script to prevent groups from being flushed

Connections

Connecting over Unix socket

define( 'WP_REDIS_SCHEME', 'unix' );
define( 'WP_REDIS_PATH', '/var/run/redis.sock' );

Connecting over TCP+TLS

define( 'WP_REDIS_SCHEME', 'tls' );
define( 'WP_REDIS_HOST', 'master.ncit.ameaqx.use1.cache.amazonaws.com' );
define( 'WP_REDIS_PORT', 6379 );

Additional TLS/SSL stream connection options for connections can be defined using WP_REDIS_SSL_CONTEXT:

define( 'WP_REDIS_SSL_CONTEXT', [
    'verify_peer' => false,
    'verify_peer_name' => false,
]);

Connecting using ACL authentication

define( 'WP_REDIS_PASSWORD', [ 'username', 'password' ] );

Scaling

Redis Object Cache offers various replication, sharding, cluster and sentinel setups to users with advanced technical knowledge of Redis and PHP, that have consulted the Predis, PhpRedis or Relay documentation.

Relay

Relay is a next-generation cache that keeps a partial replica of Redis' dataset in PHP's memory for ridiculously fast lookups, especially when Redis Server is not on the same machine as WordPress.

define( 'WP_REDIS_CLIENT', 'relay' );

define( 'WP_REDIS_HOST', '127.0.0.1' );
define( 'WP_REDIS_PORT', 6379 );

// when using Relay, each WordPress installation
// MUST a dedicated Redis database and unique prefix
define( 'WP_REDIS_DATABASE', 0 );
define( 'WP_REDIS_PREFIX', 'db3:' );

// consume less memory
define( 'WP_REDIS_IGBINARY', true );

Replication

https://redis.io/docs/management/replication/

define( 'WP_REDIS_CLIENT', 'predis' );

define( 'WP_REDIS_SERVERS', [
    'tcp://127.0.0.1:6379?database=5&role=master',
    'tcp://127.0.0.2:6379?database=5&alias=replica-01',
] );

Sharding

This is a PhpRedis specific feature using RedisArray.

define( 'WP_REDIS_CLIENT', 'phpredis' );

define( 'WP_REDIS_SHARDS', [
    'tcp://127.0.0.1:6379?database=10&alias=shard-01',
    'tcp://127.0.0.2:6379?database=10&alias=shard-02',
    'tcp://127.0.0.3:6379?database=10&alias=shard-03',
] );

Redis Sentinel

https://redis.io/docs/management/sentinel/

define( 'WP_REDIS_CLIENT', 'predis' );

define( 'WP_REDIS_SENTINEL', 'my-sentinel' );
define( 'WP_REDIS_SERVERS', [
    'tcp://127.0.0.1:5380',
    'tcp://127.0.0.2:5381',
    'tcp://127.0.0.3:5382',
] );

Redis Cluster

https://redis.io/docs/management/scaling/

define( 'WP_REDIS_CLIENT', 'phpredis' );

define( 'WP_REDIS_CLUSTER', [
    'tcp://127.0.0.1:6379?alias=node-01',
    'tcp://127.0.0.2:6379?alias=node-02',
    'tcp://127.0.0.3:6379?alias=node-03',
] );

WP CLI commands

Redis Object Cache has various WP CLI commands, for more information run wp help redis.

Command	Description
`wp redis status`	Shows the object cache status and diagnostics
`wp redis enable`	Enables the object cache
`wp redis disable`	Disables the object cache
`wp redis update-dropin`	Updates the object cache drop-in

Actions & Filters

Redis Object Cache has various hooks and the commonly used ones are listed below.

Filter / Action	Description
`redis_cache_expiration`	Filters the cache expiration for individual keys
`redis_cache_validate_dropin`	Filters whether the drop-in is valid
`redis_cache_add_non_persistent_groups`	Filters the groups to be marked as non persistent
`redis_cache_manager_capability`	Filters the capability a user needs to manage the plugin

Footnotes

¹ Redis is a registered trademark of Redis Ltd. Any rights therein are reserved to Redis Ltd. Any use by Redis Object Cache is for referential purposes only and does not indicate any sponsorship, endorsement or affiliation between Redis and Redis Object Cache.

rhubarbgroup/redis-cache 适用场景与选型建议

rhubarbgroup/redis-cache 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 101.44k 次下载、GitHub Stars 达 527，最近一次更新时间为 2020 年 06 月 05 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「redis」「wordpress」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 rhubarbgroup/redis-cache 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 rhubarbgroup/redis-cache 我们能提供哪些服务？

定制开发 / 二次开发

基于 rhubarbgroup/redis-cache 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 rhubarbgroup/redis-cache 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

bitninja/ninjarpc 0

Microservice RPC through message queues.

maykonn/codeigniter-predis 12

The CodeIgniter Redis package

beidu/codis 1

贝嘟分布式缓存扩展

zilveer/laravel-redlock 0

Redis distributed locks for laravel

torawallet/php-resque 0

Redis backed library for creating background jobs and processing them later.

lucassaraiva5/queue-bundle 0

Symfony Queue Bundle

rhubarbgroup/redis-cache

包简介

关键字：