sql中＜![CDATA[]]＞的具体使用详解_MsSqlserver

在这篇文章中，通过实际项目详述＜![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中，不能存在如下的特殊字符：

大于等于符号：>=
小于等于符号：<=
不等于符号：<>
大于符号：>
小于符号：<
且符号：&
英文双引号符号："
英文单引号符号：'
…

如果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防范，如下图所示：

在这里插入图片描述