Java中 自定义注解怎么实现多租户 TenantId 字段自动填充与 SQL 拼接

风磊小哥_5846

风磊小哥_5846

2026-07-16

778人浏览

原创

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

java中 自定义注解怎么实现多租户 tenantid 字段自动填充与 sql 拼接

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,只改参数对象:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
  • 从 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 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java spring boot

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10257

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7382

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6492

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1124

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1356

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2709

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20011

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习