0

0

XML Mapper是什么 如何在MyBatis中用它来编写SQL

煙雲

煙雲

发布时间:2026-01-20 10:17:02

|

589人浏览过

|

来源于php中文网

原创

XML Mapper 是 MyBatis 中定义 SQL 映射关系的 XML 文件,用于解耦 Java 接口方法与 SQL 语句,需满足命名、路径约定并显式配置才能被正确加载。

xml mapper是什么 如何在mybatis中用它来编写sql

XML Mapper 是什么

XML Mapper 是 MyBatis 中用于定义 SQL 映射关系的 XML 文件,它把 Java 接口方法和 SQL 语句解耦,让 SQL 集中管理、便于维护。它不是运行时生成的代理类,也不是注解替代品——而是 MyBatis 加载 Mapper 接口时,按命名约定查找并绑定的外部 SQL 定义载体。

如何让 MyBatis 找到并加载 XML Mapper 文件

MyBatis 不会自动扫描任意路径下的 XML 文件,必须满足命名与路径双重约定:

  • XML 文件名必须和对应 Mapper 接口类名一致(如 UserMapper.javaUserMapper.xml
  • XML 文件必须放在与接口相同的包路径下(如 com.example.mapper.UserMapper 对应 resources/com/example/mapper/UserMapper.xml
  • mybatis-config.xml 或 Spring Boot 的 application.yml 中显式配置 mapper 路径(Spring Boot 默认扫描 mapper-locations: classpath*:mapper/**/*.xml,但若改过包结构或用了非标准路径,就得手动配)

常见错误:IDE 编译后 .xml 没进 target/classes —— 检查 pom.xml 是否漏了 resources 配置,Maven 默认不复制非 *.java 文件到输出目录。

XML Mapper 中写 SQL 的基本结构

每个 UserMapper.xml 必须有 根标签,并通过 namespace 绑定接口全限定名。SQL 语句用 等标签包裹,id 必须和接口方法名一致。

短影AI
短影AI

长视频一键生成精彩短视频

下载



  

注意点:

  • #{id} 是预编译参数占位符,防 SQL 注入;${id} 是字符串拼接,仅用于动态表名/列名等极少数场景
  • resultTyperesultMap 二选一:resultType 适用于字段名与 POJO 属性名完全匹配;复杂映射(如字段别名、嵌套对象、类型转换)必须用
  • MyBatis 3.4+ 支持在 XML 中使用 或 OGNL 表达式做简单逻辑,但别写业务逻辑——XML 只管 SQL 结构,不该承担判断职责

为什么有时 XML Mapper 没生效?几个典型卡点

不是语法错,而是绑定失败或加载遗漏,最常发生在以下环节:

  • 接口方法有重载(如两个 findById),XML 中 id 冲突 → MyBatis 只认名字,不看参数,直接报 BindingException: Invalid bound statement
  • XML 文件编码不是 UTF-8,含中文注释或字段名时乱码 → 导致解析失败,日志里可能只报 “Error parsing SQL Mapper” 无明细
  • 用了 @MapperScan 但没扫到 XML 所在包,或用了 @Mapper 注解在接口上却忘了加 @MapperScan(后者仅对当前接口有效,不递归子包)
  • Spring Boot + MyBatis-Plus 混用时,MP 默认禁用 XML(mybatis-plus.configuration.map-underscore-to-camel-case=false 不影响 XML,但 MP 的自动扫描可能绕过 XML)→ 查 MybatisConfiguration 日志确认是否加载了该 XML

调试建议:启动时加 logging.level.org.apache.ibatis=DEBUG,看日志里有没有 MapperRegistry.addMapperXMLMapperBuilder.parse 成功记录。

相关专题

更多
java
java

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

841

2023.06.15

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

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

742

2023.07.05

java自学难吗
java自学难吗

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

737

2023.07.31

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

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

397

2023.08.01

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

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

399

2023.08.02

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

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

446

2023.08.02

java有什么用
java有什么用

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

430

2023.08.02

java在线网站
java在线网站

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

16926

2023.08.03

Java JVM 原理与性能调优实战
Java JVM 原理与性能调优实战

本专题系统讲解 Java 虚拟机(JVM)的核心工作原理与性能调优方法,包括 JVM 内存结构、对象创建与回收流程、垃圾回收器(Serial、CMS、G1、ZGC)对比分析、常见内存泄漏与性能瓶颈排查,以及 JVM 参数调优与监控工具(jstat、jmap、jvisualvm)的实战使用。通过真实案例,帮助学习者掌握 Java 应用在生产环境中的性能分析与优化能力。

19

2026.01.20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.1万人学习

Java 教程
Java 教程

共578课时 | 48.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号