解决 Cause: org.xml.sax.SAXParseException； lineNumber: 50； columnNumber: 21； 元素内容必须由格式正确的字符数据或标记组成的错误

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: 元素内容必须由格式正确的字符数据或标记组成。

2. 分析错误

正赶上最近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[]]>。

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

3. 解决错误

因为我在上文的sql语句中，存在不等于符号(<>)，那么，我需要添加<![CDATA[]]>，如下代码所示：

<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文件中，写了不符合xml语法的字符，比如上文出现的不等于符号<>。

如果真的需要在xml文件中写特殊符号，我们需要添加<![CDATA[]]>来转义。