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)能解决部分问题,但复杂场景必须显式配置

Bandy AI
Bandy AI

全球领先的电商设计Agent

下载
  • 简单一对一:用 指定列与属性映射
  • 关联查询:用 (一对一)或 (一对多),配合 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,先想清楚参数来源、结果结构、边界情况,再动手写标签——比后期调试省力得多。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

728

2023.10.12

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

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

328

2023.10.27

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

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

350

2024.02.23

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

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

1263

2024.03.06

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

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

360

2024.03.06

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

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

841

2024.04.07

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

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

581

2024.04.29

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

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

423

2024.04.29

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

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

共23课时 | 3万人学习

C# 教程
C# 教程

共94课时 | 7.9万人学习

Java 教程
Java 教程

共578课时 | 53.3万人学习

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

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