Java多租户实现核心是不侵入业务、统一拦截、动态注入TenantId:1.定义@TenantAutoFill注解标记实体类;2.实体中声明tenantId字段并标注ORM注解;3.通过MetaObjectHandler自动填充INSERT/UPDATE;4.用MyBatis拦截器为SELECT追加WHERE条件。

Java中实现多租户场景下的 TenantId 自动填充与 SQL 拼接,核心在于:**不侵入业务代码、统一拦截、动态注入租户标识**。自定义注解只是“开关”和“元数据载体”,真正起作用的是配合 AOP + MyBatis 拦截器(或 JPA 的 Hibernate Filter)完成字段填充与 SQL 改写。
1. 定义 @TenantAutoFill 注解用于标记实体类
该注解声明在实体类上,表示该表支持多租户隔离,需自动填充 tenant_id 字段:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TenantAutoFill {
String value() default "tenant_id"; // 可配置租户字段名
}
说明:仅作标记用途,不带逻辑;value() 支持不同表用不同字段名(如 org_id),提升灵活性。
2. 实体类中声明 tenantId 字段并加注解
在实体类中显式声明字段,并用标准 ORM 注解(如 @TableField 或 @Column)标注,同时保留 @TenantAutoFill 在类上:
- MyBatis-Plus 示例:
@TenantAutoFill
public class User {
private Long id;
private String name;
@TableField(fill = FieldFill.INSERT) // 触发自动填充
private Long tenantId; // 字段名需与 @TenantAutoFill.value() 一致
}
- JPA 示例:
@TenantAutoFill("org_id")
@Entity
public class Order {
@Id private Long id;
private String orderNo;
@Column(name = "org_id")
private Long orgId; // 注意字段名映射一致性
}
3. 利用 MyBatis-Plus MetaObjectHandler 实现 INSERT/UPDATE 自动填充
这是最轻量、最常用的方式——不改 SQL,只改参数对象:
- 从 ThreadLocal 或 Spring Security Context 中获取当前租户 ID(例如通过
SecurityContextHolder或网关透传的 Header) - 扫描实体类是否含
@TenantAutoFill,且字段存在、类型匹配(Long / String) - 对 INSERT 和 UPDATE 操作,设置对应字段值
@Component
public class TenantMetaObjectHandler implements MetaObjectHandler {
@Override
public void insertFill(MetaObject metaObject) {
Object entity = metaObject.getOriginalObject();
Class> clazz = entity.getClass();
if (clazz.isAnnotationPresent(TenantAutoFill.class)) {
TenantAutoFill anno = clazz.getAnnotation(TenantAutoFill.class);
String field = anno.value();
Long tenantId = TenantContext.getCurrentTenantId(); // 自定义上下文工具类
if (tenantId != null) {
metaObject.setValue(field, tenantId);
}
}
}
<pre class="brush:php;toolbar:false;">@Override
public void updateFill(MetaObject metaObject) {
// 同理,可选是否更新 tenant_id(通常只插入时填充)
}}
4. 使用 MyBatis 拦截器实现 SELECT SQL 自动追加 WHERE 条件
防止租户数据越权访问,必须在查询时强制加上 tenant_id = ? 过滤。推荐用 Executor 拦截器(比 StatementHandler 更底层,兼容分页插件):
- 拦截
query方法,解析 SQL,识别是否为带@TenantAutoFill的实体查询 - 利用
SqlParserHelper或正则提取表名 → 查找对应实体类 → 判断是否启用租户过滤 - 使用
ParameterHandler动态追加参数,并重写 SQL(如SELECT * FROM user→SELECT * FROM user WHERE tenant_id = ?)
关键点:只对带注解的实体生效,避免影响系统表或公共表;SQL 改写需兼容别名、子查询等常见写法(建议用 MyBatis-Plus 内置的 SqlParserHandler 或 Apache Calcite 做安全解析)。
不复杂但容易忽略:租户上下文必须在线程内可靠传递(尤其异步、定时任务、Feign 调用场景),建议封装 TenantContext 工具类 + MDC + Spring Cloud Gateway Header 透传闭环。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南











