mybatis include标签传参特性测试

1 前言

mybatis的include标签主要是用于sql语句的可重用，并且可以接收参数来生成动态sql。为了进一步了解include标签的传参特性，我写了一段测试代码来测试一下include标签的特性。

2 测试代码

mapper.xml

	<!--需要include的代码块-->
	<sql id="luck">
		#{luck}||'${luck}'
	</sql>
	<!--property标签name属性和参数名一样,但值不同-->
	<select id="test1" resultType="java.lang.String">
		select
		<include refid="luck">
			<property name="luck" value="lucktheuniverse"/>
		</include>
		from dual
	</select>
	<!--property标签name属性和参数名一样,但值为#号方式传值-->
	<select id="test2" resultType="java.lang.String">
		select
		<include refid="luck">
			<property name="luck" value="#{luck}"/>
		</include>
		from dual
	</select>
	<!--property标签name属性和参数名一样,但值为$方式传值-->
	<select id="test3" resultType="java.lang.String">
		select
		<include refid="luck">
			<property name="luck" value="${luck}"/>
		</include>
		from dual
	</select>
	<!--property标签name属性和参数名不同-->
	<select id="test4" resultType="java.lang.String">
		select
		<include refid="luck">
			<property name="luck1" value="lucktheuniverse"/>
		</include>
		from dual
	</select>

mapper.java

String test1(@Param(value = "luck") String luck);
String test2(@Param(value = "luck") String luck);
String test3(@Param(value = "luck") String luck);
String test4(@Param(value = "luck") String luck);

test.java

String test1 = mapper.test1("luck123");
String test2 = mapper.test2("luck123");
String test3 = mapper.test1("luck123");
String test4 = mapper.test2("luck123");

测试结果

test1: luck123lucktheuniverse
test2: 报错
test3: luck123luck123
test4: luck123luck123

3 结论

1.采用${}取参数时，include标签的property属性的优先级要高于外围mapper的参数；
2.采用#{}取参数只能取到外围mapper传过来的参数。

4 test2报错原因

test2报错是因为，include中${luck}取了property中的#{luck}，但是#{}自带了双引号。所以得到的sql就成了

select #{luck}||'#{luck}' from dual

最终转化为preparedStatement，会报java.sql.SQLException: 无效的列索引

select ?||'?' from dual

'?'是不能被单引号 ' 包围的
所以要谨慎，不要在#{}传入的参数周围加上单引号
把include代码块修改为，可以得到输出为luck123luck123

	<sql id="luck">
		#{luck}||${luck}
	</sql>

参考文献

https://www.cnblogs.com/huhuan123/p/6068721.html