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

r囧r小猫 2023-09-25 16:34 52阅读 0赞

#### 文章目录 ####

*  1. 文章引言
 *  2. 概述＜!\[CDATA\[ \]\]＞
 *  3. 书写规范
 *  4. 文末总结

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

## 1. 文章引言 ##

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

![在这里插入图片描述][a7736587bdd34f73bc480fbac2cbf12f.png]

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`比较火，借助它来分析我的错误，如下图所示：

![在这里插入图片描述][eecd2076d7954454a497a67e9698ad01.png]

`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>

![在这里插入图片描述][1de0e4c6157044a0b69b36b2303bc0a7.png]

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

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

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

![在这里插入图片描述][2b6af500f95d4aea9993071c66ab5c07.png]

## 4. 文末总结 ##

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

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

但要注意的是：

1.  此部分不能再包含`]]>`
2.  不允许嵌套使用
3.  `]]>`这部分不能包含空格或者换行。

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

1.  `<![CDATA[]]>`不能适用所有情况，转义字符可以
2.  对于短字符串`<![CDATA[]]>`写起来啰嗦，对于长字符串转义字符写起来可读性差；
3.  `<![CDATA[]]>`表示`xml`解析器忽略解析，所以更快。

[a7736587bdd34f73bc480fbac2cbf12f.png]: https://img-blog.csdnimg.cn/a7736587bdd34f73bc480fbac2cbf12f.png
[eecd2076d7954454a497a67e9698ad01.png]: https://img-blog.csdnimg.cn/eecd2076d7954454a497a67e9698ad01.png
[1de0e4c6157044a0b69b36b2303bc0a7.png]: https://img-blog.csdnimg.cn/1de0e4c6157044a0b69b36b2303bc0a7.png
[2b6af500f95d4aea9993071c66ab5c07.png]: https://img-blog.csdnimg.cn/2b6af500f95d4aea9993071c66ab5c07.png