SpringBootCodeGenerator使用JSqlParser解析DDL CREATE SQL 语句

🧠 使用 JSqlParser 解析 CREATE TABLE SQL 语句详解

在数据库开发中，我们常常需要从 SQL 中提取表结构信息，比如字段名、类型、注释等。相比使用正则表达式，JSqlParser 提供了更可靠的方式来解析 SQL 语句，尤其适用于复杂的建表语句。本文将带你深入了解如何使用 JSqlParser 解析 CREATE TABLE 语句，并提取核心结构信息。

📦 什么是 JSqlParser？

JSqlParser 是一个用于解析 SQL 的 Java 库，它能将 SQL 转换为抽象语法树（AST），方便我们以结构化方式访问语句内容。它支持多种 SQL 方言，包括 MySQL、PostgreSQL、Oracle 等，适用于各种数据库场景。

🔧 项目依赖配置

在 Maven 项目中引入 JSqlParser 非常简单，只需添加以下依赖：

xml

<dependency>
    <groupId>com.github.jsqlparser</groupId>
    <artifactId>jsqlparser</artifactId>
    <version>4.7</version>
</dependency>

🧪 核心实现逻辑

以下是使用 JSqlParser 解析 CREATE TABLE SQL 的核心代码片段：

java

Statement statement = CCJSqlParserUtil.parse(processedSql);
if (!(statement instanceof CreateTable createTable)) {
    throw new SqlException("检测到SQL语句不是DLL CREATE TABLE语句");
}
String tableName = createTable.getTable().getName().replaceAll("`", "");
List<ColumnDefinition> columnDefinitions = createTable.getColumnDefinitions();

✅ 主要步骤包括：

1. SQL 预处理：统一引号格式，替换中文符号，提高解析成功率。

2. 语法解析 ：使用 CCJSqlParserUtil.parse() 将 SQL 转换为 AST。

3. 类型校验 ：确保语句类型为 CreateTable。

4. 提取表名：从 AST 中获取表名并格式化。

5. 提取字段信息：遍历字段定义，提取字段名、注释、并根据命名规则生成 Java 字段名。

📄 使用示例

假设我们有如下建表语句：

sql

CREATE TABLE `user_info` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '用户ID',
  `username` varchar(50) NOT NULL COMMENT '用户名',
  `email` varchar(100) DEFAULT NULL COMMENT '邮箱',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8 COMMENT='用户信息表';

解析后可提取出：

• 表名：user_info

• 字段：id, username, email

• 注释：字段注释与表注释均可获取

⚠️ 注意事项

• 引号处理：建议统一使用反引号 `\``，避免因数据库差异导致解析失败。

• 异常处理：解析失败时应抛出明确异常，便于定位问题。

• 类型推断：JSqlParser 不会自动推断字段类型，需自行处理。

• 兼容性问题：部分复杂语法（如索引、约束）可能需额外预处理。

✅ 总结

JSqlParser 是一个强大且灵活的 SQL 解析工具，尤其适合用于代码生成、数据库建模、SQL分析等场景。通过它，我们可以轻松提取表结构信息，构建更智能的开发工具。相比正则解析，它更准确、更稳定，是数据库开发中的得力助手。

如果你正在构建一个 SQL 驱动的代码生成器或数据建模平台，不妨试试 JSqlParser，它可能会成为你项目中的"隐藏 MVP"！💪