Java JSQLParser解析SQL的使用指南

2025-05-26 03:50

本文主要是介绍Java JSQLParser解析SQL的使用指南,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

《JavaJSQLParser解析SQL的使用指南》JSQLParser是一个Java语言的SQL语句解析工具,可以将SQL语句解析成为Java类的层次结构,还支持改写SQL,下面我们就来看看它的具...

一、引言

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

二、JSQLParser常见类

2.1 Class Diagram

Java JSQLParser解析SQL的使用指南

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()方法,就能看到具体的语句结构。

例如:

1.基本值

LongValue(整数值)、StringValue(字符串值)、DoubleValue(浮点数值)等。

2.列引用

Column(表示列名,如 column_name 或 table.column)。

3.运算符

Addition+)、Subtraction-)、Multiplication*)、Division/)等。

4.函数调用

Function(如 COUNT(*)SUBSTRING(str, 1, 2))。

5.条件表达式

EqualsTo=)、NotEqualsTo<> 或 !=)、GreaterThan>)、LikeExpressionLIKE)等。

6.逻辑表达式(BinaryExpression)

AndExpressionAND)、OrExpressionOR)、NotExpressionNOT)。

7.子查询

SubSelect(如 (SELECT ...))。

8.Case 表达式

CaseExpressionCASE WHEN ... THEN ... END)。

9.其他复杂表达式

CastExpressionCAST(... 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语句通过unionunion 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 Tabpythonle

用于表示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(sTHSlfpElOelectItem -> {
    Expression expression = selectItem.getExpression();

    if (expression instanceof Select) {
        
    }
    else if (expression instancewww.chinasem.cnof Function) {

    }
    el编程se 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 China编程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
}

附:类路径

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

以上就是Java JSQLParser解析SQL的使用指南的详细内容,更多关于JSQLParser解析SQL的资料请关注China编程(www.chinasem.cn)其它相关文章!

这篇关于Java JSQLParser解析SQL的使用指南的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1154776

相关文章

SpringBoot如何对密码等敏感信息进行脱敏处理

《SpringBoot如何对密码等敏感信息进行脱敏处理》这篇文章主要为大家详细介绍了SpringBoot对密码等敏感信息进行脱敏处理的几个常用方法,文中的示例代码讲解详细,感兴趣的小伙伴可以了解下... 目录​1. 配置文件敏感信息脱敏​​2. 日志脱敏​​3. API响应脱敏​​4. 其他注意事项​​总结

SpringBoot实现多环境配置文件切换

《SpringBoot实现多环境配置文件切换》这篇文章主要为大家详细介绍了如何使用SpringBoot实现多环境配置文件切换功能,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 示例代码结构2. pom文件3. application文件4. application-dev文

JavaScript实战:智能密码生成器开发指南

本文通过JavaScript实战开发智能密码生成器,详解如何运用crypto.getRandomValues实现加密级随机密码生成,包含多字符组合、安全强度可视化、易混淆字符排除等企业级功能。学习密码强度检测算法与信息熵计算原理,获取可直接嵌入项目的完整代码,提升Web应用的安全开发能力 目录

mysql中的group by高级用法详解

《mysql中的groupby高级用法详解》MySQL中的GROUPBY是数据聚合分析的核心功能,主要用于将结果集按指定列分组,并结合聚合函数进行统计计算,本文给大家介绍mysql中的groupby... 目录一、基本语法与核心功能二、基础用法示例1. 单列分组统计2. 多列组合分组3. 与WHERE结合使

java对接第三方接口的三种实现方式

《java对接第三方接口的三种实现方式》:本文主要介绍java对接第三方接口的三种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录HttpURLConnection调用方法CloseableHttpClient调用RestTemplate调用总结在日常工作

python进行while遍历的常见错误解析

《python进行while遍历的常见错误解析》在Python中选择合适的遍历方式需要综合考虑可读性、性能和具体需求,本文就来和大家讲解一下python中while遍历常见错误以及所有遍历方法的优缺点... 目录一、超出数组范围问题分析错误复现解决方法关键区别二、continue使用问题分析正确写法关键点三

MySQL数据库实现批量表分区完整示例

《MySQL数据库实现批量表分区完整示例》通俗地讲表分区是将一大表,根据条件分割成若干个小表,:本文主要介绍MySQL数据库实现批量表分区的相关资料,文中通过代码介绍的非常详细,需要的朋友可以参考... 目录一、表分区条件二、常规表和分区表的区别三、表分区的创建四、将既有表转换分区表脚本五、批量转换表为分区

宝塔安装的MySQL无法连接的情况及解决方案

《宝塔安装的MySQL无法连接的情况及解决方案》宝塔面板是一款流行的服务器管理工具,其中集成的MySQL数据库有时会出现连接问题,本文详细介绍两种最常见的MySQL连接错误:“1130-Hostisn... 目录一、错误 1130:Host ‘xxx.xxx.xxx.xxx’ is not allowed

Spring 缓存在项目中的使用详解

《Spring缓存在项目中的使用详解》Spring缓存机制,Cache接口为缓存的组件规范定义,包扩缓存的各种操作(添加缓存、删除缓存、修改缓存等),本文给大家介绍Spring缓存在项目中的使用... 目录1.Spring 缓存机制介绍2.Spring 缓存用到的概念Ⅰ.两个接口Ⅱ.三个注解(方法层次)Ⅲ.

Spring Boot 整合 Redis 实现数据缓存案例详解

《SpringBoot整合Redis实现数据缓存案例详解》Springboot缓存,默认使用的是ConcurrentMap的方式来实现的,然而我们在项目中并不会这么使用,本文介绍SpringB... 目录1.添加 Maven 依赖2.配置Redis属性3.创建 redisCacheManager4.使用Sp