当前位置：首页 > news >正文

MyBatis 中 CDATA 的实战应用与避坑指南

news 2026/5/11 21:36:20

1. 为什么MyBatis需要CDATA

在MyBatis的日常开发中，我们经常需要在XML映射文件中编写SQL语句。但XML本身对特殊字符有着严格的限制，比如小于号(<)、大于号(>)、和号(&)等字符在XML中都有特殊含义。这就导致了一个很现实的问题：当我们的SQL语句中包含这些特殊字符时，XML解析器会误认为它们是标签的一部分，从而引发解析错误。

举个例子，假设我们要写一个简单的条件查询：

<select id="findUsersByAge" resultType="User"> SELECT * FROM users WHERE age > 18 </select>

这个查询看起来很简单，但实际上会报错，因为XML会把">"解析为标签的结束符号。这时候CDATA就派上用场了。

CDATA的全称是Character Data，它的作用就是告诉XML解析器："这段内容只是纯文本，不要解析里面的任何符号"。在MyBatis中，我们可以这样使用：

<select id="findUsersByAge" resultType="User"> <![CDATA[ SELECT * FROM users WHERE age > 18 ]]> </select>

2. CDATA的正确使用姿势

2.1 基础用法

CDATA的基本语法非常简单，就是在需要保护的SQL语句前后加上<![CDATA[和]]>标记。我建议在编写包含以下特殊字符的SQL时使用CDATA：

比较运算符：>、<、>=、<=
逻辑运算符：&&、||
位运算符：&、|
XML特殊字符：<、>、&、'、"

一个典型的例子是范围查询：

<select id="findUsersInRange" resultType="User"> <![CDATA[ SELECT * FROM users WHERE age > #{minAge} AND age < #{maxAge} ]]> </select>

2.2 与动态SQL结合

CDATA和MyBatis的动态SQL标签可以很好地配合使用。比如下面这个复杂查询：

<select id="findUsers" resultType="User"> <![CDATA[ SELECT * FROM users WHERE 1=1 ]]> <if test="name != null"> AND name LIKE CONCAT('%', #{name}, '%') </if> <if test="minAge != null"> <![CDATA[ AND age >= #{minAge} ]]> </if> <if test="maxAge != null"> <![CDATA[ AND age <= #{maxAge} ]]> </if> </select>

这里我们只在真正需要的地方使用CDATA，而不是包裹整个SQL语句，这样既解决了特殊字符问题，又保持了代码的可读性。

3. 那些年我踩过的CDATA坑

3.1 CDATA嵌套问题

有一次我在项目中遇到了一个奇怪的错误：SQL语句明明在数据库客户端执行正常，但在MyBatis中就是报错。排查了半天才发现是因为CDATA的嵌套问题：

<!-- 错误示例 --> <select id="wrongExample"> <![CDATA[ SELECT * FROM table WHERE <![CDATA[ column > 10 ]]> ]]> </select>

XML不允许CDATA嵌套，这种写法会导致解析失败。正确的做法是：

<select id="correctExample"> <![CDATA[ SELECT * FROM table WHERE column > 10 ]]> </select>

3.2 CDATA与注释的冲突

另一个常见的坑是在CDATA块中使用XML注释：

<!-- 危险示例 --> <select id="dangerousExample"> <![CDATA[ SELECT * FROM users <!-- 这里是一个注释 --> WHERE age > 18 ]]> </select>

这种写法在某些版本的MyBatis中可能会导致解析异常。安全的做法是：

<select id="safeExample"> <![CDATA[ SELECT * FROM users /* 这里使用SQL注释 */ WHERE age > 18 ]]> </select>

4. 什么时候可以不用CDATA

虽然CDATA很好用，但并不是所有情况都需要它。根据我的经验，以下情况可以避免使用CDATA：

4.1 使用转义字符

对于简单的特殊字符，可以直接使用XML转义字符：

<select id="findYoungUsers" resultType="User"> SELECT * FROM users WHERE age &lt; 18 </select>

常用转义字符对应表：

字符	XML转义形式
<	<
>	>
&	&
'	'
"	"

4.2 使用MyBatis动态SQL

MyBatis强大的动态SQL功能可以帮我们避免很多CDATA的使用场景。比如：

<select id="findUsers" resultType="User"> SELECT * FROM users <where> <if test="minAge != null"> AND age >= #{minAge} </if> <if test="maxAge != null"> AND age &lt;= #{maxAge} </if> </where> </select>

这里我们只需要转义一个<=运算符，其他逻辑都通过动态SQL标签实现。

4.3 使用注解方式

如果你使用的是MyBatis的注解方式，完全不需要考虑CDATA的问题：

@Select("SELECT * FROM users WHERE age > #{minAge} AND age < #{maxAge}") List<User> findUsersByAgeRange(@Param("minAge") int minAge, @Param("maxAge") int maxAge);

5. 性能与可读性权衡

在实际项目中，我们需要在代码可读性和性能之间找到平衡点。过度使用CDATA会让XML文件变得臃肿难读，而完全不使用又可能导致转义字符满天飞。

我的经验法则是：

对于简单的比较运算符，优先使用转义字符
对于复杂的SQL片段，特别是包含多个特殊字符的，使用CDATA
动态SQL能实现的逻辑，尽量用动态SQL标签
保持整个项目的风格统一，要么都转义，要么都用CDATA

一个比较好的实践示例：

<select id="complexQuery" resultType="User"> <![CDATA[ SELECT u.* FROM users u JOIN departments d ON u.dept_id = d.id WHERE u.status = 'ACTIVE' ]]> <if test="deptName != null"> AND d.name LIKE CONCAT('%', #{deptName}, '%') </if> <if test="minSalary != null"> <![CDATA[ AND u.salary >= #{minSalary} ]]> </if> <choose> <when test="orderBy == 'name'"> ORDER BY u.name </when> <otherwise> ORDER BY u.id </otherwise> </choose> </select>