讲师中心 微信公众号
AI工具推荐 视频效率加速

MyBatis 怎么在 XML 中引入公用 SQL 片段 ``

陌萱大大_2964

陌萱大大_2964

发布时间:2026-08-10 15:17:25

|

800人浏览过

|

来源于php中文网

原创

MyBatis中公用SQL片段通过定义+引用实现复用;本文件内引用直接写id,跨XML需用namespace.id全限定格式,嵌套引用也须带namespace,动态传参用配合${}(仅限安全结构参数)。

mybatis 怎么在 xml 中引入公用 sql 片段 `<sql>`

MyBatis 中引入公用 SQL 片段,核心靠 <sql></sql> 定义 + <include></include> 引用,分本文件内复用和跨 XML 复用两种场景,关键在 refid 的写法和参数传递方式。

本 XML 内引用:直接用 id

只要 `` 和 `` 在同一个 mapper 文件里,`refid` 只需写片段的 `id`:

<sql id="userColumns">id, username, email</sql>
<p><select id="listUsers" resultType="User">
SELECT <include refid="userColumns"/> FROM user
</select>

跨 XML 文件引用:必须带 namespace

要引用其他 mapper XML 中的 ``,`refid` 必须是 namespace.id 的完整形式(类似 Java 全限定类名):

  • A.xml 定义:
    <mapper namespace="com.example.dao.UserMapper">
      <sql id="baseQuery">SELECT id, name FROM user</sql>
    </mapper>
  • B.xml 引用:
    <select id="getUserByDept" resultType="User">
      <include refid="com.example.dao.UserMapper.baseQuery"/>
      WHERE dept_id = #{deptId}
    </select>

注意:如果被引用的 `` 内部还嵌套了 ``,这些嵌套引用也得写成带 namespace 的全路径,否则启动时会找不到。

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载

动态传参:用 给片段注入别名或表名

当不同查询中表别名不一致(如 u、o),可在 `` 里传参,片段内用 ${} 接收:

  • 定义可变片段:
    <sql id="byNameCondition">AND ${alias}.name LIKE CONCAT('%', #{keyword}, '%')</sql>
  • 调用时指定别名:
    <select id="searchUsers" resultType="User">
      SELECT * FROM user u
      <where>
        <include refid="byNameCondition">
          <property name="alias" value="u"/>
        </include>
      </where>
    </select>

⚠️ 注意:`${}` 是字符串拼接,不能防 SQL 注入,只适合传固定别名、表名等结构信息,别名应来自配置或白名单,不可由用户输入直接传入。

集中管理公共片段:单独建 common-mapper.xml

推荐把通用 SQL 提取到一个独立 XML 文件中,比如 CommonMapper.xml:

<mapper namespace="common">
  <sql id="pagination">LIMIT #{offset}, #{limit}</sql>
  <sql id="softDelete">AND deleted = 0</sql>
</mapper>

业务 mapper 中引用:

<include refid="common.pagination"/>
确保 Spring Boot 的 `mybatis.mapper-locations` 配置能扫描到这个文件(如 `classpath*:mybatis/**/*Mapper.xml`)。

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

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

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

4783

2023.10.12

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

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

971

2023.10.27

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

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

1249

2024.02.23

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

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

6781

2024.03.06

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

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

3503

2024.03.06

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

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

6760

2024.04.07

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

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

9381

2024.04.29

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

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

1270

2024.04.29

DBeaver怎么导入数据
DBeaver怎么导入数据

DBeaver数据导入专题,整理Excel、CSV、SQL、TXT等常见文件的数据导入方法,涵盖目标数据库选择、数据表创建、字段映射、数据类型设置及导入参数配置等操作,帮助用户将本地文件中的数据写入数据库,并了解批量导入、重复数据处理和导入失败等常见问题的解决方法。

0

2026.11.05

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn