SQL解析工具JSQLParser及常见类

更新时间：2025年05月29日 10:29:30 作者：changelzj

JSQLParser是一个Java语言的SQL语句解析工具,功能十分强大,它可以将SQL语句解析成为Java类的层次结构,还支持改写SQL,常见的持久层框架MyBatis-Plus就采用它作为SQL解析工具来实现某些功能,下面给大家介绍SQL解析工具JSQLParser,感兴趣的朋友一起看看吧

一、引言

JSQLParser(GitHub：https://github.com/JSQLParser/JSqlParser)是一个Java语言的SQL语句解析工具，功能十分强大，它可以将SQL语句解析成为Java类的层次结构，还支持改写SQL，常见的持久层框架MyBatis-Plus就采用它作为SQL解析工具来实现某些功能。

二、JSQLParser常见类

2.1 Class Diagram

2.2 Statement

可以理解为能够表示任意一种SQL语句的对象，Select、Update、Delete、Insert都是它的子类，例如以下用法：

Statement statement = JsqlParserGlobal.parse(sql);
if (statement instanceof Insert) {
    this.processInsert((Insert) statement, index, sql, obj);
} else if (statement instanceof Select) {
    this.processSelect((Select) statement, index, sql, obj);
} else if (statement instanceof Update) {
    this.processUpdate((Update) statement, index, sql, obj);
} else if (statement instanceof Delete) {
    this.processDelete((Delete) statement, index, sql, obj);
}

2.3 Expression

是JSqlParser库中的一个核心接口，是用于表示SQL语句中的各种表达式的基类接口，通过调用对象的.toString()方法，就能看到具体的语句结构。

例如：

基本值
- LongValue（整数值）、StringValue（字符串值）、DoubleValue（浮点数值）等。
列引用
- Column（表示列名，如 column_name 或 table.column）。
运算符
- Addition（+）、Subtraction（-）、Multiplication（*）、Division（/）等。
函数调用
- Function（如 COUNT(*)、SUBSTRING(str, 1, 2)）。
条件表达式
- EqualsTo（=）、NotEqualsTo（<> 或 !=）、GreaterThan（>）、LikeExpression（LIKE）等。
逻辑表达式(BinaryExpression)
- AndExpression（AND）、OrExpression（OR）、NotExpression（NOT）。
子查询
- SubSelect（如 (SELECT ...)）。
Case 表达式
- CaseExpression（CASE WHEN ... THEN ... END）。
其他复杂表达式
- CastExpression（CAST(... AS ...)）、IntervalExpression（时间间隔）等。

2.4 Select

用于表示查询SQL语句，有三个常见子类：PlainSelect，ParenthesedSelect，SetOperationList

2.5 Update

用于表示更新的SQL语句

获得对应表

Table table = update.getTable();

获得要更新的值

List<UpdateSet> sets = update.getUpdateSets();

获取where条件

Expression expression = update.getWhere()

2.6 Delete

用于表示删除的SQL语句

获得对应表

Table table = delete.getTable();

获取where条件

Expression expression = delete.getWhere()

2.7 Insert

用于表示添加SQL语句，有以下几种常见方法

获取添加的列

List<Column> columns = insert.getColumns();

获取添加的值

Values values = insert.getValues();

获取添加时冲突进行更新的结构

INSERT INTO ... VALUES ...ON DUPLICATE KEY UPDATE ...

List<UpdateSet> duplicateUpdateColumns = insert.getDuplicateUpdateSets();

insert select的结构，获取select

INSERT ... SELECT ...

Select select = insert.getSelect();

2.8 PlainSelect

用于表示最常规的那种查询结构，例如：

select...from...join...where...

获取select后面的结构

List<SelectItem<?>> selectItems = plainSelect.getSelectItems();

获取select语句的where结构

Expression where = plainSelect.getWhere();

获取查询的from后的结构（表，子查询等）

FromItem fromItem = plainSelect.getFromItem();

存在连接查询时，获取连接查询（left/right/inner）join后的结构

List<Join> joins = plainSelect.getJoins();

2.9 SetOperationList

用于表示多个select语句通过union，union all连接在一起的联合查询SQL对象

select...from...
union all
select...from...
union all
select...from...

将语句拆分，获取构成它的若干select

SetOperationList operationList = (SetOperationList) selectBody;
List<Select> selectBodyList = operationList.getSelects();

2.10 ParenthesedSelect

用于表示子查询，被小括号包裹的一个查询结构，例如：

(select....from...) as t

“去括号”，得到一个PlainSelect

ParenthesedSelect parenthesedSelect = (ParenthesedSelect) selectBody;
Select select = parenthesedSelect.getSelect();

2.11 FromItem

接口，from后面的SQL结构，ParenthesedSelect，ParenthesedFromItem，Table都是它的实现

FromItem fromItem = plainSelect.getFromItem();
if (fromItem instanceof Table) {
}
else if (fromItem instanceof ParenthesedSelect) {
}
else if (fromItem instanceof ParenthesedFromItem) {
}

2.12 Table

用于表示SQL中的表

2.13 ParenthesedFromItem

小括号包裹的可被查询的结构，但不是子查询，不常用，例如小括号包裹的join：

(tab1 join tab2)

2.14 SelectItem

用于表示select语句中，select和from之间的部分，例如：

select
    fun(1, 2) as a,
    (select x from ...) as b,
    name as c,
    exists (...) AS d
from t

List<SelectItem<?>> selectItems = plainSelect.getSelectItems();
selectItems.forEach(selectItem -> {
    Expression expression = selectItem.getExpression();
    if (expression instanceof Select) {
    }
    else if (expression instanceof Function) {
    }
    else if (expression instanceof ExistsExpression) {
    }
});

2.15 BinaryExpression

泛指比较符号：and or = >= =<，这种结构左右连接着其他结构。EqualsTo，OrExpression，AndExpression都是它的子类。

获取左右两侧的结构：

BinaryExpression expression = (BinaryExpression) obj;
Expression left = expression.getLeftExpression();
Expression right = expression.getRightExpression();

2.16 InExpression

x in (...)

获取右侧的结构，可能是子查询或(*,*,*...)：

InExpression expression = (InExpression) obk;
Expression inExpression = expression.getRightExpression();

2.17 ExistsExpression

exists (...)

获取右侧结构

ExistsExpression expression = (ExistsExpression) obj;
Expression e = expression.getRightExpression() ;

2.18 NotExpression

not，与其他的配合使用，例如：

not in (...)
not exists (...)

获取not后面的结构，会提取出in exists等结构

NotExpression expression = (NotExpression) obj;
Expression e = expression.getExpression();

2.19 Parenthesis

代表小括号()括起来的结构

(...)

去括号，拿到括号中的结构：

Parenthesis expression = (Parenthesis) obj;
Expression e = expression.getExpression();

2.20 Function

函数结构，通常会获取参数，对参数进行操作

fun()

ExpressionList<?> parameters = function.getParameters();
if (parameters != null) {
    parameters.forEach(expression -> {
        if (expression instanceof Select) {
        } 
        else if (expression instanceof Function) {
        } 
    });
}

2.21 EqualsTo

2.22 OrExpression

or

2.23 AndExpression

and

2.24 Join

SQL中连接查询的join结构，从Select中获得。

获取join后的结构，一般可能是表也可能是子查询

FromItem joinItem = join.getRightItem();

判断是否为隐式内连接

join.isSimple();

判断是内/左/右连接

join.isRight();
join.isInner();
join.isLeft();

获取join的on条件

Collection<Expression> originOnExpressions = join.getOnExpressions();

改写join的on条件

join.setOnExpressions(onExpressions);

2.25 Column

用于表示SQL中的字段对象，例如从一个Insert对象获取SQL要添加的全部字段：name，age，tenant_id

INSERT INTO t_user (name, age, tenant_id) VALUES ('liming', 15), ('zhaoying', 16)

List<Column> columns = insert.getColumns();

2.26 UpdateSet

UpdateSet是一种类似xx = xx, ...的结构，出现在update的set后面

update user set username = 5 where id = 1

List<UpdateSet> sets = update.getUpdateSets();

也能在insert语句处理添加的数据冲突的情况时，出现在ON DUPLICATE KEY UPDATE后面

INSERT INTO table_name (col1, col2) VALUES (val1, val2)
ON DUPLICATE KEY UPDATE col1 = val3, col2 = col4 + 1;

List<UpdateSet> duplicateUpdateColumns = insert.getDuplicateUpdateSets();

2.27 ExpressionList

Expression列表，本质上是List<Expression>，当insert语句values后面批量跟了多组值，就能得到这种结构。

('liming', 15), ('zhaoying', 16)

Values values = insert.getValues();
ExpressionList<Expression> expressions = (ExpressionList<Expression>) values.getExpressions();

2.28 ParenthesedExpressionList

继承自ExpressionList，本质上也是List<Expression>，一种带着括号的Expression结构，例如获取insert语句values后面的值就能得到这种结构

('liming', 15)

Values values = insert.getValues();
ExpressionList<Expression> expressions = (ExpressionList<Expression>) values.getExpressions();
if (expressions instanceof ParenthesedExpressionList) {
    // ParenthesedExpressionList
} else {
    // ExpressionList
}

原文首发：https://blog.liuzijian.com/post/jsqlparser.html

附：类路径

net.sf.jsqlparser.statement.Statement
net.sf.jsqlparser.statement.select.Select
net.sf.jsqlparser.statement.update.Update
net.sf.jsqlparser.statement.delete.Delete
net.sf.jsqlparser.statement.insert.Insert
net.sf.jsqlparser.schema.Table
net.sf.jsqlparser.expression.Expression
net.sf.jsqlparser.statement.select.ParenthesedSelect
net.sf.jsqlparser.statement.select.SetOperationList
net.sf.jsqlparser.statement.select.SelectItem
net.sf.jsqlparser.expression.BinaryExpression
net.sf.jsqlparser.expression.operators.relational.InExpression
net.sf.jsqlparser.expression.operators.relational.ExistsExpression
net.sf.jsqlparser.expression.NotExpression
net.sf.jsqlparser.expression.Parenthesis
net.sf.jsqlparser.statement.select.ParenthesedFromItem
net.sf.jsqlparser.statement.select.FromItem
net.sf.jsqlparser.expression.Function
net.sf.jsqlparser.expression.operators.relational.EqualsTo
net.sf.jsqlparser.expression.operators.conditional.OrExpression
net.sf.jsqlparser.expression.operators.conditional.AndExpression
net.sf.jsqlparser.statement.select.Join
net.sf.jsqlparser.schema.Column
net.sf.jsqlparser.expression.operators.relational.ExpressionList
net.sf.jsqlparser.expression.operators.relational.ParenthesedExpressionList

到此这篇关于SQL解析工具JSQLParser的文章就介绍到这了,更多相关SQL解析工具JSQLParser内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

解决bootstrap.yml不生效,无法优先于application.yml文件加载问题
文章主要讨论了在Spring Boot项目中,`bootstrap.yml`文件无法优先于`application.yml`文件加载的问题,原因是缺少了`nacos-config`依赖,且需要确保Spring Boot版本与`nacos-config`版本匹配,作者希望通过分享个人经验,帮助他人解决类似问题
2024-12-12
RabbitMQ 的七种队列模式和应用场景
最近学习RabbitMQ，本文就记录一下RabbitMQ 的七种队列模式和应用场景，方便以后使用,也方便和大家共享,相互交流
2021-05-05
IDEA中的Structure模块使用图文详解
IDEA 的 Structure 功能,也是在看代码中一个十分常用的功能,最通用的方法,就是点击 IDEA 左下角的 Structure 标签页即可,本文重点介绍IDEA中的Structure模块使用详解,感兴趣的朋友跟随小编一起看看吧
2024-03-03
Mybatis返回插入的主键问题解决方案
这篇文章主要介绍了Mybatis返回插入的主键问题解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-09-09
Java中使用Closeable接口自动关闭资源详解
这篇文章主要介绍了Java中使用Closeable接口自动关闭资源详解,Closeable接口继承于AutoCloseable,主要的作用就是自动的关闭资源,其中close()方法是关闭流并且释放与其相关的任何方法,如果流已被关闭,那么调用此方法没有效果,需要的朋友可以参考下
2023-12-12
解决Process.getInputStream()阻塞的问题
这篇文章主要介绍了解决Process.getInputStream()阻塞的问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-06-06
Spring注解之@validated使用详解
spring-boot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理，这篇文章主要介绍了Spring注解之@validated使用,需要的朋友可以参考下
2023-01-01
在SpringBoot中实现一个订单号生成系统的示例代码
在Spring Boot中设计一个订单号生成系统,主要考虑到生成的订单号需要满足的几个要求：唯一性、可扩展性、以及可能的业务相关性,本文给大家介绍了几种常见的解决方案及相应的示例代码,需要的朋友可以参考下
2024-02-02
SpringBoot整合WebSocket实现后端向前端发送消息的实例代码
WebSocket使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据,下面这篇文章主要给大家介绍了关于SpringBoot整合WebSocket实现后端向前端发送消息的相关资料,需要的朋友可以参考下
2023-03-03
Java并发编程加锁导致的活跃性问题详解方案
所谓并发编程是指在一台处理器上"同时"处理多个任务。并发是在同一实体上的多个事件。多个事件在同一时间间隔发生，所以编写正确的程序很难，而编写正确的并发程序则难上加难
2021-10-10