Yii2框架redis key前綴可以配置嗎

1. 如果只是單純地使用Redis作為cache組件：

'components' => [
    'cache' => [
        'class' => 'yii\redis\Cache',
    ],
],

只需要在配置文件中添加 keyPrefix 屬性即可：

'components' => [
    'cache' => [
        'class' => 'yii\redis\Cache',
        'keyPrefix' => 'webapp:'
    ],
]

2. 如果是直接使用Redis組件：

'components' => [
    'redis' => [
        'class' => 'yii\redis\Connection',
        'hostname' => 'localhost',
        'port' => 6379,
        'database' => 0,
    ],
],

這樣就沒有辦法實(shí)現(xiàn)自動(dòng)加前綴，只能自己去實(shí)現(xiàn)。

如果是我的話，我會(huì)單獨(dú)寫一個(gè)Redis的helper類，只在這個(gè) Redis helper類中調(diào)用 \Yii::$app->redis 組件。

Redis 基礎(chǔ)類，放一些基礎(chǔ)方法，各個(gè)數(shù)據(jù)類型都適用，每個(gè)數(shù)據(jù)類型都編寫一個(gè)子類，繼承這個(gè)類

class RedisBase
{
    /**
     * 這個(gè)方法中給 key 增加前綴
     * 所有與key相關(guān)的方法都要調(diào)用這個(gè)方法
     * @param $key
     * @return string
     */
    protected static function buildKey($key)
    {
        return \Yii::$app->params['redis.prefix'] . $key;
    }

    /**
     * @return \yii\redis\Connection
     */
    protected static function getRedis()
    {
        return \Yii::$app->redis;
    }

    /**
     * # exists key
     *
     * 檢查key是否存在
     * @param string $key
     * @return bool
     */
    public static function exists($key)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        return (bool) $redis->exists($key);
    }

    /**
     * # del key [key2 key3 …]
     *
     * 刪除指定數(shù)據(jù)
     *
     * @param string $key
     * @param bool $strict
     * 是否使用嚴(yán)格模式
     * true: 當(dāng)指定鍵不存在時(shí)，返回false
     * false: 當(dāng)指定鍵不存在時(shí)，但會(huì)true
     * @return bool
     */
    public static function del($key, $strict = false)
    {
        $key = self::buildKey($key);

        // 非嚴(yán)格模式,當(dāng)指定鍵不存在時(shí)，但會(huì)true
        if (! $strict && ! self::exists($key)) return true;

        $redis = self::getRedis();
        return (bool) $redis->del($key);
    }

    /**
     * # expire key seconds
     *
     * 設(shè)置 key在seconds秒后過期
     *
     * @param $key
     * @param $seconds
     * @return bool
     */
    public static function expire($key, $seconds)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        return (bool) $redis->expire($key, $seconds);
    }

    /**
     * # ttl key
     *
     * 大于等于0時(shí)，表示剩余過期秒數(shù)
     * -1 表示key存在，并且沒有過期時(shí)間
     * -2 表示key已經(jīng)不存在了
     *
     * 查看key的剩余過期時(shí)間
     * @param $key
     * @return int
     */
    public static function ttl($key)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        return (int) $redis->ttl($key);
    }

    /**
     * # dbsize
     *
     * 當(dāng)前db 鍵的總數(shù)量
     * @return int
     */
    public static function dbSize()
    {
        $redis = self::getRedis();
        return (int) $redis->dbsize();
    }

    // ... 其他redis基礎(chǔ)方法
}

Redis 字符串類型的方法，單獨(dú)放置在RedisString類中，繼承 RedisBase 方法

class RedisString extends RedisBase
{

    /**
     * # SET key value options
     *
     * 設(shè)置指定 key 的值
     *
     * @param $key
     * @param $value
     * @param array $options
     *
     * EX seconds -- 設(shè)置指定key的過期時(shí)間，以秒為單位
     * PX milliseconds -- 設(shè)置指定key的過期時(shí)間，以毫秒為單位
     * NX -- 只有在key不存在的情況下才設(shè)置.
     * XX -- 只有在key存在的情況下才設(shè)置.
     *
     * eg: ['NX', 'EX', '3600']
     *
     * @return bool
     */
    public static function set($key, $value, array $options = [])
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        $param = array_merge([$key, $value], $options);
        return (bool) call_user_func_array([$redis, 'set'], $param);
    }

    /**
     * # GET key
     *
     * 獲取指定 key 的值。
     * @param $key
     * @return string
     */
    public static function get($key)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        return $redis->get($key);
    }

    // ...其他String類型的方法
}

Redis 集合類型的方法，單獨(dú)放置在RedisSet類中，繼承 RedisBase 方法

class RedisSet extends RedisBase
{
    /**
     * # SADD key member1 [member2]
     *
     * 向集合添加一個(gè)或多個(gè)成員
     *
     * @param $key
     * @param $members
     * @return int 成功添加數(shù)量
     */
    public static function sAdd($key, $members)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();

        // php >= 5.6
        return (int) $redis->sadd($key, ...(array) $members);

        // 通用寫法
//        $params = array_merge([$key], (array) $members);
//        return (int) call_user_func_array([$redis, 'sadd'], $params);
    }

    /**
     * # SREM key member1 [member2]
     *
     * 移除集合中一個(gè)或多個(gè)成員
     * @param $key
     * @param $members
     * @return int
     */
    public static function sRem($key, $members)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();

        $params = array_merge([$key], (array) $members);
        return (int) call_user_func_array([$redis, 'srem'], $params);
    }

    /**
     * # SISMEMBER key member
     *
     * 判斷 member 元素是否是集合 key 的成員
     * @param $key
     * @param $member
     * @return bool
     */
    public static function sIsMember($key, $member)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();

        return (bool) $redis->sismember($key, $member);
    }

    /**
     * # SMEMBERS key
     *
     * 返回集合中的所有成員
     * @param $key
     * @return array
     */
    public static function sMembers($key)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();

        return $redis->smembers($key);
    }

    /**
     * # SCARD key
     *
     * 獲取集合的成員數(shù)
     * @param $key
     * @return bool
     */
    public static function sCard($key)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();

        return (int) $redis->scard($key);
    }
    
    // ...其他Set類型的方法

Redis 有序集合類型的方法，單獨(dú)放置在RedisSortedSet類中，繼承 RedisBase 方法

class RedisSortedSet extends RedisBase
{
    /**
     * # ZADD key score1 member1 [score2 member2]
     *
     * 向有序集合添加一個(gè)或多個(gè)成員，或者更新已存在成員的分?jǐn)?shù)
     * @param $key
     * @param array $options
     * [
     *     'value1' => score1,
     *     'value2' => score2,
     *     'value3' => score3,
     * ]
     *
     * @return int
     */
    public static function zAdd($key, array $options)
    {
        $key = self::buildKey($key);
        $redis = self::getRedis();
        $param = [$key];

        foreach ($options as $value => $score) {
            $param[] = $score;
            $param[] = $value;
        }

        return (int) call_user_func_array([$redis, 'zadd'], $param);
    }
    
    // ...其他SortedSet類型的方法
}

Redis List類型的方法，單獨(dú)放置在RedisList類中，繼承 RedisBase 方法

class RedisList extends RedisBase
{
    // ...方法省略
}

Redis Hash類型的方法，單獨(dú)放置在RedisHash類中，繼承 RedisBase 方法

class RedisHash extends RedisBase
{
    // ...方法省略
}

這樣寫的好處：

1.在調(diào)用redis的原始方法前，可以對(duì)數(shù)據(jù)進(jìn)行預(yù)處理
2.后期維護(hù)方便，若想修改，只需要修改這里的方法即可
3.方便添加一些注釋信息
4.這種方法對(duì)IDE更友好，可以直接跳轉(zhuǎn)到這個(gè)類中的方法，若處處使用 \Yii::$app->redis，則會(huì)比較難維護(hù)

另外，關(guān)于Redis的一些數(shù)據(jù)類型，可以查看Redis學(xué)習(xí)筆記 - 數(shù)據(jù)類型與API