＜![CDATA[ ]]＞基于实例详述其用法及说明

在这篇文章中，通过实际项目详述＜![CDATA[ ]]＞用法及说明。

1. 文章引言

今天在写完根据账户名查询除本身之外的用户接口后，在启动项目时报出如下错误：

Caused by: org.apache.ibatis.builder.BuilderException: Error creating document instance.  Cause: org.xml.sax.SAXParseException; lineNumber: 50; columnNumber: 21; 元素内容必须由格式正确的字符数据或标记组成。
	at org.apache.ibatis.parsing.XPathParser.createDocument(XPathParser.java:263)
	at org.apache.ibatis.parsing.XPathParser.<init>(XPathParser.java:127)
	at org.apache.ibatis.builder.xml.XMLMapperBuilder.<init>(XMLMapperBuilder.java:81)
	at com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean.buildSqlSessionFactory(MybatisSqlSessionFactoryBean.java:573)
	... 67 common frames omitted
Caused by: org.xml.sax.SAXParseException: 元素内容必须由格式正确的字符数据或标记组成。
	at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.createSAXParseException(ErrorHandlerWrapper.java:203)
	at com.sun.org.apache.xerces.internal.util.ErrorHandlerWrapper.fatalError(ErrorHandlerWrapper.java:177)
	at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:400)
	at com.sun.org.apache.xerces.internal.impl.XMLErrorReporter.reportError(XMLErrorReporter.java:327)
	at com.sun.org.apache.xerces.internal.impl.XMLScanner.reportFatalError(XMLScanner.java:1472)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl$FragmentContentDriver.startOfMarkup(XMLDocumentFragmentScannerImpl.java:2635)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl$FragmentContentDriver.next(XMLDocumentFragmentScannerImpl.java:2732)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentScannerImpl.next(XMLDocumentScannerImpl.java:602)
	at com.sun.org.apache.xerces.internal.impl.XMLDocumentFragmentScannerImpl.scanDocument(XMLDocumentFragmentScannerImpl.java:505)
	at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:841)
	at com.sun.org.apache.xerces.internal.parsers.XML11Configuration.parse(XML11Configuration.java:770)
	at com.sun.org.apache.xerces.internal.parsers.XMLParser.parse(XMLParser.java:141)
	at com.sun.org.apache.xerces.internal.parsers.DOMParser.parse(DOMParser.java:243)
	at com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderImpl.parse(DocumentBuilderImpl.java:339)
	at org.apache.ibatis.parsing.XPathParser.createDocument(XPathParser.java:261)
	... 70 common frames omitted

即Caused by: org.xml.sax.SAXParseException: 元素内容必须由格式正确的字符数据或标记组成。

正赶上最近ChatGPT比较火，借助它来分析我的错误，如下图所示：

ChatGPT说我的XML文件中存在格式不正确的字符或标记导致的，让我检查XML文件的语法是否正确。

如果说xml文件中的格式不正确，那么，可以确定的是我在userMapper.xml文件中，写的sql语句不符合xml定义的语法。

于是，前去查看我的sql语句，如下代码所示：

<select id="queryByUsernameAndId" resultType="com.test.entity.po.User">
    SELECT 
    	* 
    FROM 
    	`user`
    <where>
        username = #{username}
        AND id <> #{userId}
        and deleted = 0
        and user_status = 1 LIMIT 1
    </where>
</select>

并没有看出我的代码，哪里存在不合理的地方。

通过查阅网上的资料可知，原来在xml中，不能存在如下的特殊字符：

1. 大于等于符号：>=

2. 小于等于符号：<=

3. 不等于符号：<>

4. 大于符号：>

5. 小于符号：<

6. 且符号：&

7. 英文双引号符号："

8. 英文单引号符号：'

9. …

如果xml中需要写入特殊符号，则需要添加<![CDATA[]]>。

2. 概述＜![CDATA[ ]]＞

上文提到了<![CDATA[]]>，那么，我就简要概述它。

被<![CDATA[]]>这个标记，所包含的内容将表示为纯文本，比如<![CDATA[ < ]]>表示文本内容"<"。

平时在mybatis的映射文件写sql时，很多时候都需要写一些特殊的字符。例如：<字符、>字符、>=字符、<=字符，但是在xml文件中并不能直接写上述列举的字符，否则就会报错。

因为在解析xml文件时，我们如果书写了特殊字符，在没有特殊处理的情况下。

这些字符会被转义，但我们并不希望它被转义，所以我们要使用<![CDATA[ ]]>来解决。

那为什么要这样书写呢？<![CDATA[ ]]>是XML语法，在CDATA内部的所有内容都会被解析器忽略。

所以，当我们在xml文本中包含了很多的<、<= 和 &字符，就像程序代码一样，那么最好把他们都放到CDATA部件中。

3. 书写规范

需要注意的问题就是，在我们的mybatis的映射文件中，以下<where>、<select> 等这些标签都不会被解析，所以，我们只把有特殊字符的语句放在<![CDATA[ ]]>中，尽量缩小<![CDATA[ ]]>的范围。

因而，我在上文的sql语句中，存在不等于符号(<>)，那么，我可以进行如下修改：

<select id="queryByUsernameAndId" resultType="com.test.entity.po.User">
    SELECT 
    	* 
    FROM 
    	`user`
    <where>
        username = #{username}
        AND id <![CDATA[ <> ]]> #{userId}
        and deleted = 0
        and user_status = 1 LIMIT 1
    </where>
</select>

修改完后，测试该方法，如下代码所示：

@Resource
UserMapper userMapper;

@Test
public void test() {
  User user = userMapper.queryByUsernameAndId("zhangsan", 1L);
  System.out.println(user);
}

能够正常执行queryByUsernameAndId防范，如下图所示：

4. 文末总结

不管怎么样，转义前的字符也好，转义后的字符也好，都会被xml解析器解析。

为了方便起见，使用<![CDATA[]]>来包含不被xml解析器解析的内容。

但要注意的是：

1. 此部分不能再包含]]>

2. 不允许嵌套使用

3. ]]>这部分不能包含空格或者换行。

最后，说说<![CDATA[]]>和xml转移字符的关系，它们两个看起来是不是感觉功能重复了？
　　
是的，它们的功能就是一样的，只是应用场景和需求有些不同：

1. <![CDATA[]]>不能适用所有情况，转义字符可以

2. 对于短字符串<![CDATA[]]>写起来啰嗦，对于长字符串转义字符写起来可读性差；

3. <![CDATA[]]>表示xml解析器忽略解析，所以更快。