0

0

Mybatis Mapper XML文件怎么写 Mybatis SQL映射文件编写指南

星降

星降

发布时间:2025-12-14 15:35:04

|

113人浏览过

|

来源于php中文网

原创

MyBatis Mapper XML 文件需规范命名与路径、正确配置 namespace 和 id,合理使用 #{} 与 ${} 传参,显式定义 resultMap 处理结果映射,善用动态 SQL 标签提升灵活性与安全性。

mybatis mapper xml文件怎么写 mybatis sql映射文件编写指南

MyBatis 的 Mapper XML 文件本质是把 SQL 语句从 Java 代码里抽出来,集中管理、方便维护。写对的关键不是堆语法,而是理清“谁映射谁”“参数怎么传”“结果怎么回”。下面直接说实用要点。

命名和位置要规范

XML 文件名必须和对应 Mapper 接口名一致(如 UserMapper.java 对应 UserMapper.xml),且放在相同包路径下(或通过 显式注册)。否则 MyBatis 找不到映射关系,报 Invalid bound statement 错误。

  • 推荐放在 resources/mapper/ 目录下,用 注册
  • namespace 必须写全限定名,即对应接口的完整类名(如 com.example.mapper.UserMapper
  • 每个 SQL 语句用 标签包裹,id 值必须和接口方法名完全一致

参数传递:#{} 和 ${} 别乱用

#{} 是预编译占位符,防 SQL 注入,适用于大多数场景;${} 是字符串拼接,只在动态表名、列名、排序字段等无法预编译的地方才用,且必须确保输入安全。

  • 单个参数:直接写 #{id}#{username}(参数名来自方法形参或 @Param 注解)
  • 多个参数:必须用 @Param("xxx") 注解命名,XML 中用 #{xxx} 引用
  • 对象参数:用点号取属性,如 #{user.username}#{user.createTime}
  • 动态列/表名示例:ORDER BY ${orderByColumn}(注意校验该变量是否白名单)

结果映射:别总依赖自动映射

字段名和属性名不一致时,自动映射(mapUnderscoreToCamelCase=true)能解决部分问题,但复杂场景必须显式配置

Magic Eraser
Magic Eraser

AI移除图片中不想要的物体

下载
  • 简单一对一:用 指定列与属性映射
  • 关联查询:用 (一对一)或 (一对多),配合 javaType / ofTyperesultMap 属性
  • 避免写 SELECT *,明确列出字段,防止新增字段干扰映射或影响性能
  • 字段别名要和 resultMap 中的 property 名一致,例如 SELECT user_id AS id, user_name AS username FROM user

动态 SQL:用对标签,少写硬编码

MyBatis 提供了 等标签,核心是让 SQL 更灵活,同时保持可读性。

  • 会智能处理开头的 AND/OR,比手写 WHERE 1=1 干净得多
  • 自动剔除末尾逗号,更新语句中推荐使用
  • 遍历集合时,注意 collection(入参集合名)、item(当前元素别名)、open/close/separator 的配合,例如 IN 查询:AND id IN #{id}
  • 多个条件组合优先用 (类似 switch),避免嵌套太多

基本上就这些。写 XML 不是炫技,目标是清晰、安全、易维护。每次加一个 SQL,先想清楚参数来源、结果结构、边界情况,再动手写标签——比后期调试省力得多。

相关专题

更多
java
java

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

838

2023.06.15

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

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

741

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

PS使用蒙版相关教程
PS使用蒙版相关教程

本专题整合了ps使用蒙版相关教程,阅读专题下面的文章了解更多详细内容。

23

2026.01.19

热门下载

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

精品课程

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

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.1万人学习

Java 教程
Java 教程

共578课时 | 48万人学习

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

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