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

陌丽酱_1261

陌丽酱_1261

2026-01-20

669人浏览

原创

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.java → UserMapper.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 必须和接口方法名一致。

Build Java agent transport gateways with Atmosphere
Build Java agent transport gateways with Atmosphere

使用Atmosphere构建通过WebSocket、SSE、gRPC、WebTransport、MCP、A2A和AG-UI流传输的JVM代理网关,并带有治理钩子。

下载
<?xml version="1.0" encoding="UTF-8"?><mapper namespace="com.example.mapper.UserMapper"><select id="findById" resulttype="com.example.model.User">
    SELECT * FROM user WHERE id = #{id}
  </select></mapper>

注意点:

  • #{id} 是预编译参数占位符,防 SQL 注入;${id} 是字符串拼接,仅用于动态表名/列名等极少数场景
  • resultType 和 resultMap 二选一: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.addMapper 和 XMLMapperBuilder.parse 成功记录。

相关文章

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

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

下载

相关标签:

java apache

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

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

2023.10.12

5063

8

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.27

1031

4

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

2024.02.23

1329

5

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

7141

10

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

3783

4

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

2024.04.07

7140

11

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

2024.04.29

10001

6

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1350

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1192

5

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习