# [033][缓存模块]基于 Redisson 的租户隔离 Redis Key 前缀设计

本文章代码: [gitee](https://gitee.com/yunjiao-source/tutorials4j) , [gitcode](https://gitcode.com/yun-jiao/tutorials4j) , [github](https://github.com/yunjiao-source/tutorials4j)

在多租户系统中，不同租户的数据必须严格隔离。Redis 作为一种高性能缓存/存储中间件，通常被多个租户共享。一个经典且高效的隔离方案是为每个租户的 Key 自动添加唯一前缀，从而在逻辑上实现命名空间分离。

本文以 `tutorials4j` 框架中的一段代码为例，分析如何通过函数式接口、Redisson 的 `NameMapper` 扩展点以及 Spring Boot 自动配置，优雅地实现租户感知的 Redis Key 前缀管理。

## 一、核心设计目标

- **无侵入**：业务代码只需使用逻辑 Key（如 `"user:123"`），框架层自动转换为 `{tenantId}:user:123`。
- **高性能**：前缀添加和剥离在客户端完成，无额外网络开销。
- **可扩展**：支持多种前缀策略（仅租户、租户+自定义前缀），方便按业务模块细分。
- **与 Redisson 无缝集成**：利用 Redisson 的 `NameMapper` 能力，统一处理所有 Key（包括分布式锁、对象、集合等）。

## 二、租户前缀策略接口：`RedisKeyPrefix`

`RedisKeyPrefix` 是一个函数式接口，定义了 Key 的计算规则：

```java
@FunctionalInterface
public interface RedisKeyPrefix {
    String SEPARATOR = ":";
    String compute(String cacheName);
}
```

### 2.1 租户策略工厂方法

`tenant()` 方法返回一个基于当前租户 ID 的 Key 生成器：

```java
static RedisKeyPrefix tenant() {
    return name -> TenantContextHolder.get() + SEPARATOR + name;
}
```

- `TenantContextHolder.get()` 从线程上下文中获取当前租户标识（通常通过拦截器或过滤器设置）。
- 生成的 Key 格式：`租户ID:原始Key`。

### 2.2 租户+自定义前缀策略

`tenantPrefix(String prefix)` 方法允许在租户 ID 后追加一个固定前缀，便于按模块分组：

```java
static RedisKeyPrefix tenantPrefix(String prefix) {
    // 处理 prefix 是否以分隔符结尾，保证格式统一
}
```

- 例如 `tenantPrefix("order")` 生成 `租户ID:order:原始Key`。
- 不同业务模块（订单、用户、商品）使用不同前缀，有助于监控和管理。

### 2.3 反向解析：`uncompute`

由于 Redis 中实际存储的 Key 是带租户前缀的，当需要从外部（如监控工具或手工查询）还原逻辑 Key 时，可使用：

```java
static String uncompute(String key) {
    // 去除第一个冒号之前的内容
}
```

- 示例：`uncompute("tenantA:user:123")` → `"user:123"`。
- 该方法是静态工具方法，不依赖具体策略。

## 三、与 Redisson 的集成：`PrefixNameMapper`

Redisson 提供了 `NameMapper` 接口，允许在读写 Redis 时动态改写 Key 名。`PrefixNameMapper` 是其实现类：

```java
public class PrefixNameMapper implements NameMapper {
    @Override
    public String map(String s) {
        return RedisKeyPrefix.tenant().compute(s);
    }

    @Override
    public String unmap(String s) {
        return RedisKeyPrefix.uncompute(s);
    }
}
```

- **map**：写入/查询时调用，将业务 Key 加上租户前缀。
- **unmap**：当 Redisson 需要从 Redis 返回的 Key 反向推导原始 Key 时调用（较少使用，但保持对称性）。

注册到 Redisson 配置后，所有通过 Redisson 客户端操作的 Key（`RBucket`、`RMap`、`RLock` 等）都会自动应用该映射，实现全自动租户隔离。

## 四、Spring Boot 自动配置

`RedissonConfiguration` 负责在 Spring 环境中装配上述组件：

```java
@Configuration(proxyBeanMethods = false)
public class RedissonConfiguration {

    @Bean
    @ConditionalOnMissingBean
    PrefixNameMapper prefixNameMapper() {
        return new PrefixNameMapper();
    }

    @Bean
    @ConditionalOnMissingBean
    RedissonAutoConfigurationCustomizer prefixNameRedissonConfigCustomizer(
            PrefixNameMapper prefixNameMapper) {
        return config -> config.setNameMapper(prefixNameMapper);
    }
}
```

- 利用 `@ConditionalOnMissingBean` 允许用户覆盖默认的 `PrefixNameMapper`，例如改用 `tenantPrefix("custom")` 策略。
- 通过 `RedissonAutoConfigurationCustomizer` 在不修改 Redisson 自动配置源码的前提下注入 `NameMapper`。

## 五、租户隔离的效果

假设有两个租户：`tenant_1001` 和 `tenant_1002`。业务代码执行：

```java
RBucket<String> bucket = redissonClient.getBucket("user:profile:123");
bucket.set("some data");
```

实际 Redis 中存储的 Key 分别为：

- `tenant_1001:user:profile:123`
- `tenant_1002:user:profile:123`

两个租户的数据完全隔离，互不可见。如果某个租户需要清除自己的缓存，可以扫描 `tenant_1001:*` 模式删除，不会影响其他租户。

## 六、总结

通过 `RedisKeyPrefix` 函数式接口加 Redisson 的 `NameMapper` 扩展点，我们实现了一套轻量、高效、无侵入的多租户 Redis Key 隔离方案。该方案具备以下优点：

- **透明化**：业务代码零改造，只需确保 `TenantContextHolder` 正确传递租户 ID。
- **灵活性**：可随时切换前缀策略（仅租户、租户+模块前缀等）。
- **性能**：前缀拼接仅发生在客户端，一次内存操作，无额外网络交互。
- **兼容性**：完全兼容 Redisson 的所有功能（分布式锁、集合、队列、发布订阅等）。

对于构建 SaaS 化应用或需要严格数据隔离的系统，这种基于 Key 前缀的租户隔离是一种成熟且高效的实践。

在多租户系统中，不同租户的数据必须严格隔离。Redis 作为一种高性能缓存/存储中间件，通常被多个租户共享。一个经典且高效的隔离方案是为每个租户的 Key 自动添加唯一前缀，从而在逻辑上实现命名空间分离。

[033][缓存模块]基于 Redisson 的租户隔离 Redis Key 前缀设计

编程语言

数据库

后端

本文介绍基于Redisson实现多租户RedisKey前缀隔离方案，通过函数式接口和NameMapper扩展点自动为每个租户的Key添加唯一前缀，实现数据逻辑隔离。方案支持无侵入式集成、高性能前缀处理、灵活策略配置，兼容Redisson所有功能，是构建SaaS应用的理想选择。

代码解释

中间件

Redis

SaaS

文章

问答

视频

教程

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云智能顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

EdgeOne AI 安全实战专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

聚焦“写作效率、视觉美观与运行性能”三方面进行全面升级，为您提供更高效、稳定的创作环境

社区富文本&Markdown编辑器全新改版上线，欢迎大家体验!

诚挚邀请您参与本次调研，分享您的真实使用感受与建议。您的反馈至关重要，感谢您的支持与参与！

社区新版编辑器体验调研

[033][缓存模块]基于 Redisson 的租户隔离 Redis Key 前缀设计-腾讯云开发者社区-腾讯云

[033][缓存模块]基于 Redisson 的租户隔离 Redis Key 前缀设计

[033][缓存模块]基于 Redisson 的租户隔离 Redis Key 前缀设计

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐