快捷導(dǎo)航

sql中＜![CDATA[]]＞的具體使用詳解

更新時間：2024年06月07日 11:22:50 作者：互聯(lián)網(wǎng)全棧開發(fā)實戰(zhàn)

使用動態(tài)SQL時,如果if、foreach、where等標(biāo)簽一但被 <![CDATA[ ]]>標(biāo)簽包裹,本文主要介紹了sql中＜![CDATA[]]＞的具體使用詳解,具有一定的參考價值,感興趣的可以了解一下

1. 文章引言

今天在寫完根據(jù)賬戶名查詢除本身之外的用戶接口后，在啟動項目時報出如下錯誤：

在這里插入圖片描述

Caused by: org.apache.ibatis.builder.BuilderException: Error creating document instance.  Cause: org.xml.sax.SAXParseException; lineNumber: 50; columnNumber: 21; 元素內(nèi)容必須由格式正確的字符數(shù)據(jù)或標(biāo)記組成。
	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: 元素內(nèi)容必須由格式正確的字符數(shù)據(jù)或標(biāo)記組成。
	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: 元素內(nèi)容必須由格式正確的字符數(shù)據(jù)或標(biāo)記組成。

正趕上最近ChatGPT比較火，借助它來分析我的錯誤，如下圖所示：

在這里插入圖片描述

ChatGPT說我的XML文件中存在格式不正確的字符或標(biāo)記導(dǎo)致的，讓我檢查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>

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

通過查閱網(wǎng)上的資料可知，原來在xml中，不能存在如下的特殊字符：

大于等于符號：>=
小于等于符號：<=
不等于符號：<>
大于符號：>
小于符號：<
且符號：&
英文雙引號符號："
英文單引號符號：'
…

如果xml中需要寫入特殊符號，則需要添加<![CDATA[]]>。

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

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

被<![CDATA[]]>這個標(biāo)記，所包含的內(nèi)容將表示為純文本，比如<![CDATA[ < ]]>表示文本內(nèi)容"<"。

平時在mybatis的映射文件寫sql時，很多時候都需要寫一些特殊的字符。例如：<字符、>字符、>=字符、<=字符，但是在xml文件中并不能直接寫上述列舉的字符，否則就會報錯。

因為在解析xml文件時，我們?nèi)绻麜鴮懥颂厥庾址?，在沒有特殊處理的情況下。

這些字符會被轉(zhuǎn)義，但我們并不希望它被轉(zhuǎn)義，所以我們要使用<![CDATA[ ]]>來解決。

那為什么要這樣書寫呢？<![CDATA[ ]]>是XML語法，在CDATA內(nèi)部的所有內(nèi)容都會被解析器忽略。

所以，當(dāng)我們在xml文本中包含了很多的<、<= 和 &字符，就像程序代碼一樣，那么最好把他們都放到CDATA部件中。

3. 書寫規(guī)范

需要注意的問題就是，在我們的mybatis的映射文件中，以下<where>、<select> 等這些標(biāo)簽都不會被解析，所以，我們只把有特殊字符的語句放在<![CDATA[ ]]>中，盡量縮小<![CDATA[ ]]>的范圍。

因而，我在上文的sql語句中，存在不等于符號(<>)，那么，我可以進(jìn)行如下修改：

<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);
}

能夠正常執(zhí)行queryByUsernameAndId防范，如下圖所示：

在這里插入圖片描述