Java MyBatis 存储过程映射中 `mode=OUT` 参数怎么通过 `Map` 或实体类接收

冬明吖_5714

冬明吖_5714

2026-09-15

341人浏览

原创

mybatis调用存储过程的out参数必须绑定到可修改对象(如预初始化map或含setter的实体类),xml中需用statementtype="callable"并声明mode="out"及jdbctype;不可用基本类型或非null不可变对象直接接收。

java mybatis 存储过程映射中 `mode=out` 参数怎么通过 `map` 或实体类接收

MyBatis 调用存储过程时,若存储过程有 OUT 参数(如 Oracle 的 OUT、MySQL 的 OUT 或 SQL Server 的输出参数),不能直接用普通字段赋值,必须显式声明为可修改的容器类型——推荐使用 Map 或自定义实体类配合 @Param + resultMap,但核心前提是:OUT 参数必须绑定到一个可被 MyBatis 修改的对象属性上

✅ 正确做法:用 Map 接收 OUT 参数(最常用)

MyBatis 会自动将 OUT 参数的值写入 Map 对应 key 的 value 中(前提是该 key 已存在且为可变对象,如 new HashMap())。

  • Mapper 接口方法需传入一个预初始化的 Map(不能是空构造后未 put 的 Map,否则 MyBatis 找不到目标 key)
  • XML 中 <parametermap></parametermap> 已废弃,统一用 <select></select><update></update>statementType="CALLABLE" + <paramter></paramter> 子标签声明 OUT 参数
  • mode="OUT" 的参数必须指定 jdbcType(如 JDBCType.VARCHAR),且 javaType 通常可省略(MyBatis 自动推断)

示例(Oracle 存储过程 proc_get_user_by_id(id IN NUMBER, name OUT VARCHAR2)):

// Java 调用
Map<string object> params = new HashMap();
params.put("id", 123);
params.put("name", null); // 必须先 put,key 名与 XML 中 property 一致
<p>userMapper.callGetUserByName(params);</p><div class="aritcle_card flexRow artxards">
											<div class="artcardd flexRow">
												<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill2773" title="Java Development Manual"><img
														src="https://img.php.cn/upload/skill/000/000/081/178936208989088.jpg" alt="Java Development Manual" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
												<div class="aritcle_card_info flexColumn">
													<a rel="nofollow" href="/xiazai/skill2773" title="Java Development Manual" class="overflowclass">Java Development Manual</a>
													<p class="overflowclass">Java开发手册规约集合,基于阿里巴巴Java开发手册(嵩山版)。 涵盖7大维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构、设计规约。 当用户需要:(1) 编写或审查Java代码 (2) 检查命名/代码规范 (3) 处理异常和日志 (4) 编写单元测试 (5) 安全编码 (6) 数据库设...</p>
												</div>
												<a rel="nofollow" href="/xiazai/skill2773" title="Java Development Manual" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
												</a>
											</div>
										</div>
<p>String resultName = (String) params.get("name"); // ✅ 获取 OUT 值
</p></string>
<!-- Mapper XML -->
<select id="callGetUserByName" statementtype="CALLABLE">
  { CALL proc_get_user_by_id(
      #{id, mode=IN, jdbcType=NUMERIC},
      #{name, mode=OUT, jdbcType=VARCHAR}
  ) }
</select>

✅ 实体类接收 OUT 参数(需保证属性可写)

实体类方式本质仍是“引用传递”,MyBatis 会通过反射调用 setter 或直接设 field(取决于配置),因此要求:

  • 实体类字段必须有 public setter,或开启 configuration.setMapUnderscoreToCamelCase(true) 并确保命名匹配
  • 调用前必须 new 出实例,并确保 OUT 字段初始值不为 final / 不可变(如 String 可为 null,List 建议 new ArrayList())
  • XML 中 property 名必须与实体类字段/Setter 名完全一致(区分大小写)

示例:

public class UserResult {
    private Integer id;
    private String name;
    // getter/setter...
}
UserResult result = new UserResult();
result.setId(123);
userMapper.callGetUserByName(result); // 传入实例,MyBatis 写入 name 字段
<p>String name = result.getName(); // ✅ 获取 OUT 结果
</p>
<select id="callGetUserByName" statementtype="CALLABLE">
  { CALL proc_get_user_by_id(
      #{id, mode=IN, jdbcType=NUMERIC},
      #{name, mode=OUT, jdbcType=VARCHAR}
  ) }
</select>

⚠️ 常见错误和注意事项

  • 不能用基本类型(int/long)或不可变对象(如 String 非 null 初始值)直接接收 OUT —— MyBatis 无法修改其值,只会替换引用,原变量不变
  • MySQL 存储过程的 OUT 参数实际是用户变量(@var),MyBatis 不直接支持;建议改用 SELECT @out_var AS out_name 方式转为结果集,或用 CallableStatement 原生调用
  • SQL Server 需在 JDBC URL 加 sendStringParametersAsUnicode=false 避免 NVARCHAR 乱码,且 OUT 参数要显式注册 registerOutParameter(2, Types.VARCHAR)(MyBatis 内部已处理,但需确保驱动版本兼容)
  • 多个 OUT 参数时,Map/实体类中所有对应 key/field 都必须提前存在,否则抛 BindingException

? 小技巧:混合使用 IN/OUT/INOUT

一个存储过程可同时含多种模式参数,写法一致:

<select id="procMixed" statementtype="CALLABLE">
  { CALL my_proc(
      #{inId, mode=IN, jdbcType=INTEGER},
      #{outName, mode=OUT, jdbcType=VARCHAR},
      #{inoutCount, mode=INOUT, jdbcType=INTEGER}
  ) }
</select>

调用前在 Map 或实体类中同时设置 inIdoutName(可为 null)、inoutCount(必须有初值),执行后三者都会被更新。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

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

2023.06.15

8657

6

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

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

2023.07.05

5862

9

java自学难吗
java自学难吗

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

2023.07.31

5272

8

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

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

2023.08.01

964

3

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

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

2023.08.02

808

3

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

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

2023.08.02

1136

5

java有什么用
java有什么用

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

2023.08.02

2289

5

java在线网站
java在线网站

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

2023.08.03

19631

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1035

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习