Java MyBatis 插件开发中怎么通过反射安全地修改私有成员变量(如 BoundSql 中的 sql)

落涛大大_2943

落涛大大_2943

2026-09-13

751人浏览

原创

不推荐反射修改BoundSql的sql字段,因其不可变且每次查询新建实例;应改StaticSqlSource中的sql字段,或优先用拦截器、自定义SqlSource、JSQLParser等安全方案。

java mybatis 插件开发中怎么通过反射安全地修改私有成员变量(如 boundsql 中的 sql)

在 MyBatis 插件开发中,**不推荐用反射直接修改 BoundSql 的 sql 字段**——因为 BoundSql 是不可变对象,每次调用 getBoundSql() 都会新建实例,改它内部的 sql 字段对实际执行毫无影响。真正有效且相对可控的做法,是**定位并替换底层 SqlSource(如 StaticSqlSource)中被缓存的 SQL 字符串**,但必须清醒认识其风险边界。

为什么 BoundSql 不能直接反射修改

BoundSql 设计为不可变(immutable),其构造后字段全为 final,且 MyBatis 每次查询都会调用 SqlSource.getBoundSql() 新建一个 BoundSql 实例。即使你用反射强行修改了某个 BoundSql 对象的 sql 字段:

  • 该修改只作用于当前临时对象,下一次查询仍会生成新对象
  • 参数映射(ParameterMapping)未同步更新,可能导致 SQL 与参数不匹配而报错
  • 违反 MyBatis 内部契约,JDK 版本升级或框架迭代后极易失效

安全可行的反射切入点:StaticSqlSource 中的 sql 字段

MyBatis 中多数 XML 或注解定义的 SQL 最终由 StaticSqlSource 封装,它内部持有一个 private final String sql。这个字段在 MappedStatement 初始化时被一次性设置,并被复用——这才是可干预的稳定节点。

操作步骤如下:

Java Development Man
Java Development Man

Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。

下载
  • 从 MappedStatement 获取原始 SqlSource(通常是 RawSqlSource 或 CachingSqlSource)
  • 递归获取其内部包装的 StaticSqlSource(可能需穿透 1–2 层代理)
  • 用 getDeclaredField("sql") 获取私有字段,调用 setAccessible(true)
  • 用 set() 替换字符串值(注意:仅适用于纯静态 SQL;含 ${} 的拼接 SQL 不建议动)

示例关键代码片段:

Field sqlField = staticSqlSource.getClass().getDeclaredField("sql");
sqlField.setAccessible(true);
sqlField.set(staticSqlSource, "SELECT * FROM user WHERE tenant_id = ? AND " + originalSql);

比反射更安全、更推荐的替代方案

反射修改属于“破坏性修补”,应作为最后手段。生产环境优先采用以下正向设计:

  • 使用 MyBatis 拦截器(Interceptor)拦截 Executor.query():在 SQL 执行前,基于原 BoundSql 构造新的 BoundSql,传入修改后的 SQL 和完整 ParameterMapping,完全符合框架语义
  • 自定义 SqlSource 实现类:继承 StaticSqlSource 或实现 SqlSource 接口,在 getBoundSql() 中动态注入条件,避免反射
  • 借助 JSQLParser 等库解析并重写 SQL:在拦截器中解析 AST,安全地插入 WHERE 条件,再生成新 SQL,类型安全、可测试、易维护
  • 通过 MyBatis 的 标签或 OGNL 表达式 在 XML 中预埋权限逻辑,由框架自动处理

JDK 9+ 与模块化下的现实约束

若坚持使用反射(例如在测试或受限环境中),必须面对 JDK 模块系统限制:

  • 运行时抛出 InaccessibleObjectException 是常态,需启动参数显式开放:
    --add-opens java.base/java.lang=ALL-UNNAMED(针对核心类)
    --add-opens org.apache.ibatis/mybatis=ALL-UNNAMED(若自定义模块)
  • 这些参数在容器化、云原生或受管平台(如某些 PaaS)中往往不可配置,导致方案失效
  • Spring Boot 3+ 默认启用严格模块检查,反射路径更易断裂

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

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

2023.06.15

12677

6

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

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

2023.07.05

9782

9

java自学难吗
java自学难吗

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

2023.07.31

8312

8

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

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

2023.08.01

1324

3

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

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

2023.08.02

1068

3

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

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

2023.08.02

1596

5

java有什么用
java有什么用

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

2023.08.02

3329

5

java在线网站
java在线网站

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

2023.08.03

20551

3

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

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

2023.08.03

1435

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习