bugfix: com.alibaba.druid.sql.parser.EOFParserException: EOF

news2024/11/19 19:19:24

前言

在日常的开发工作中，我们经常会遇到各种各样的问题，其中涉及数据库操作的接口联调尤其容易出现意想不到的状况。今天我就遇到了一个关于Druid SQL解析异常的问题，具体表现为com.alibaba.druid.sql.parser.EOFParserException: EOF。通过细致的排查和分析，最终定位到问题根源并成功修复。现在，我想以博客的形式分享这次问题的排查过程及涉及到的设计知识，希望对你在类似问题的处理上有所启发。

1. 问题描述与现象

在进行接口联调时，系统抛出了一个异常信息：com.alibaba.druid.sql.parser.EOFParserException: EOF。查阅相关资料后了解到，这是一个常见的SQL解析异常，通常表示在解析SQL语句时遇到了预期之外的结束符（End Of File），即解析器未能找到完整的SQL语句。

进一步查看日志输出，发现问题出在我拼接的一条动态SQL语句上，具体为：

and user_id in

在这里插入图片描述

奇怪的是，这条语句似乎并未完成，其后的IN子句中缺少具体的值列表。根据业务逻辑，此处应为：

and user_id in (value1, value2, ...)

显然，IN子句后面的值列表丢失了，导致了上述SQL解析异常。

2. 初步排查与疑问

在代码层面，我使用MyBatis的<if>标签对IN子句进行了条件判断：

<if test="userIds != null ">
    and user_id in
    <foreach item="userId" collection="userIds" open="(" separator="," close=")">
        #{userId}
    </foreach>
</if>

在这里插入图片描述

理论上，当传入的userIds参数为空时，这段SQL片段不应被拼接到最终的查询语句中。然而实际情况却并非如此，这让我产生了疑惑：难道我对userIds的非空判断失效了吗？

3. 问题定位与分析

带着疑问，我决定深入到代码中进行调试。经过仔细检查，我发现userIds的确为空，但问题并不在于非空判断失效，而在于判断条件本身的设计有误。原来，我仅对userIds是否为null进行了检查，却忽略了另一种可能的情况：userIds虽非null，但其大小为0，即它是一个空集合。

在Java中，空集合与null是两种不同的概念。一个集合对象即使不包含任何元素，它仍然存在且不为null。因此，当我仅检查userIds != null时，对于空集合的情况，条件判断实际上是成立的，导致了上述不完整的SQL语句被错误地拼接到了查询语句中。

4. 修复与优化

明确了问题所在，修复就变得简单直接。我将条件判断修改为同时检查userIds是否为null以及其大小是否大于0：

<if test="userIds != null  and userIds.size() > 0">
    and user_id in
    <foreach item="userId" collection="userIds" open="(" separator="," close=")">
        #{userId}
    </foreach>
</if>

在这里插入图片描述

这样一来，只有当userIds既非null且包含至少一个元素时，才会拼接IN子句。重新编译、部署并进行测试，问题得到完美解决，接口恢复正常。

5. 总结与启示

本次问题的排查与解决过程，主要涉及以下几点设计知识与经验教训：

理解数据类型特性：在编程中，准确理解各类数据类型的特性和表现形式至关重要。对于集合类，应清楚区分null、空集合和非空集合的概念，避免因混淆而导致的逻辑错误。
严谨的条件判断：在编写条件判断语句时，务必全面考虑所有可能的情况，确保逻辑严密无遗漏。特别是在处理可变参数、集合或数组等复杂数据结构时，不仅要检查其是否存在（非null），还要关注其实际内容（如长度、元素数量等）。
日志与异常信息的价值：面对问题，充分利用日志输出和异常信息可以帮助我们快速定位问题所在。在本例中，通过查看日志发现了不完整的SQL语句，从而将注意力集中到动态SQL拼接的部分，大大缩小了排查范围。
调试与验证：在怀疑代码逻辑存在问题时，通过调试工具进行现场验证是最直接有效的手段。通过调试，我确认了userIds为空集合的事实，进而找到了问题的真正原因。