mybatis写mapper文件注意事项

本文介绍了在XML文件中如何正确处理特殊符号以保持文件的有效性,并详细探讨了在MyBatis mapper文件中使用CDATA标记来避免特殊符号引发的问题。特别强调了在包含动态SQL元素的情况下,如何合理使用CDATA以确保SQL语句的正确执行。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

xml中某些特殊符号作为内容信息时需要做转义,否则会对文件的合法性和使用造成影响

&lt; < 
&gt; > 
&amp; & 
&apos; ' 
&quot; "
 

 

在mapper文件中写sql语句时,为避免不必要的麻烦(如<等),建议使用<![CDATA[ ]]>来标记不应由xml解析器进行解析的文本数据,由<![CDATA[  ]]>包裹的所有的内容都会被解析器忽略 <![CDATA[ sql语句 ]]> 

 

<select id="getAccountsByBranch" resultType="Account" parameterType="string">
	<![CDATA[SELECT * FROM t_acctreg_accounts where acctno < #{acctno}]]>
</select>

 将整个sql语句用<![CDATA[   ]]>标记来避免冲突,在一般情况下都是可行的,但是如果这样写

 

<select id="getAccountErrorCount" resultType="int" parameterType="map">
	<![CDATA[
	select count(*) from t_acctreg_accounterror
	<where>
		<if test="enddate != null and enddate != ''">
			createdate <= #{enddate}
		</if>
		<if test="acctno != null and acctno != ''">
			AND acctno LIKE '%'||#{acctno}||'%'
		</if>
	</where>
	]]>
</select>

 就会收到错误信息:

    org.springframework.jdbc.UncategorizedSQLException: Error setting null parameter. Most JDBC drivers require that the JdbcType must be specified for all nullable parameters. Cause: java.sql.SQLException: 无效的列类型: 1111 ; uncategorized SQLException for SQL []; SQL state [99999]; error code [17004]; 无效的列类型: 1111; nested exception is java.sql.SQLException: 无效的列类型: 1111

    这是由于该sql配置中有动态语句(where,if),where,if 条件不能放在<![CDATA[ ]]>中,否则将导致无法识别动态判断部分,导致整个sql语句非法.应该缩小范围,只对有字符冲突部分进行合法性调整

 

<select id="getAccountErrorCount" resultType="int" parameterType="map">
	select count(*) from t_acctreg_accounterror
	<where>
		<if test="enddate != null and enddate != ''">
			<![CDATA[createdate <= #{enddate}]]>
		</if>
		<if test="acctno != null and acctno != ''">
			<![CDATA[AND acctno LIKE '%'||#{acctno}||'%']]>
		</if>
	</where>
</select>
 

还有在向oracle插入数据时,mybatis3报Error setting null parameter. Most JDBC drivers require that the JdbcType must be specified for all nullable parameters,是由于参数出现了null值,对于Mybatis,如果进行操作的时候,没有指定jdbcType类型的参数,mybatis默认jdbcType.OTHER导致,给参数加上jdbcType可解决(注意大小写)

http://code.google.com/p/mybatis/issues/detail?id=224&q=Error%20setting%20null%20parameter&colspec=ID


<insert id="insertAccountError" statementType="PREPARED"
	parameterType="AccountError">
	INSERT INTO t_acctreg_accounterror(createdate,acctno, errorinfo)
	VALUES(#{createdate,jdbcType=DATE},#{acctno,jdbcType=VARCHAR},#{errorinfo,jdbcType=VARCHAR})
</insert>
 

 

在编 MyBatis 的 XML 文件时,有一些注意事项需要牢记: 1. 命名空间(namespace):确保每个 XML 文件都有唯一的命名空间,避免冲突。命名空间应与对应的 Mapper 接口相对应。 2. SQL 语句的书规范:在编 SQL 语句时,建议使用标准的 SQL 语法,并且注意避免使用特定数据库的语法,以保持代码的可移植性。 3. 参数传递:在 XML 文件中,可以通过使用 `#{}` 或 `${}` 来引用参数。`#{}` 会将参数进行预编译,可以防止 SQL 注入。`${}` 则是直接替换参数,但存在 SQL 注入的风险。 4. 结果集映射:MyBatis 提供了丰富的结果集映射功能,可以将查询结果映射为 Java 对象或集合。在 XML 文件中,可以使用 `<resultMap>` 标签定义映射规则。 5. 动态 SQL:MyBatis 支持动态 SQL,可以根据条件动态生成 SQL 语句。在 XML 文件中,可以使用 `<if>`、`<choose>`、`<when>`、`<otherwise>` 等标签来实现动态 SQL。 6. 缓存配置:MyBatis 默认开启了一级缓存,可以通过配置来开启或关闭缓存。在 XML 文件中,可以使用 `<cache>` 标签来配置缓存。 7. 异常处理:在 XML 文件中,可以使用 `<tryCatch>` 标签来捕获异常并进行处理。可以根据需要定义不同的异常处理逻辑。 8. 代码的可读性和可维护性:尽量保持 XML 文件的结构清晰、简洁,并且按照功能或模块进行分组,方便查找和维护。 这些是编 MyBatis XML 文件时需要注意的一些事项,希望对你有帮助!
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值