devbox
知新_RL
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

JSqlParser-解析SQL工具类

作者：知新_RL | 2024-06-19 02:36:06

赞

踩

jsqlparser

 一、介绍 

        JSqlParse是一款很精简的sql解析工具，将sql语句转成Java对象。

官网：JSqlParser - Home

用法：可以用于数据权限处理，拦截sql解析改写sql等等。

1. 首先引入jar包

  1. <dependency>
  2.      <groupId>com.github.jsqlparser</groupId>
  3.      <artifactId>jsqlparser</artifactId>
  4.      <version>1.2</version>
  5. </dependency>

二、结构

  1. expression：SQL构建相关类，比如ArrayExpression、CaseExpression、JsonExpression等表达式用于构建SQL。
  2. parser： SQL解析相关类，比如CCJSqlParserUtil主要类。
  3. schema：主要存放数据库schema相关的类 ，比如表、列等。
  4. statement：封装了数据库操作对象，create、insert、delete、select等
  5. util： 各种工具类、不同DB版本、SQL标准等处理类，如SelectUtils、DatabaseType、TablesNamesFinder等

三、工具类封装

网上有相关讲解，但是没有进行整合的例子，我写了个工具类供参考！！！直接上代码

 3.1 定义SQL枚举类型

  1. package com.test.enums;
  2.  
  3. /**
  4.  * @className: SqlType
  5.  * @description: SQL 类型
  6.  * @version: 1.0
  7.  */
  8. public enum SqlType {
  9.     ALTER,
  10.     CREATEINDEX,
  11.     CREATETABLE,
  12.     CREATEVIEW,
  13.     DELETE,
  14.     DROP,
  15.     EXECUTE,
  16.     INSERT,
  17.     MERGE,
  18.     REPLACE,
  19.     SELECT,
  20.     TRUNCATE,
  21.     UPDATE,
  22.     UPSERT,
  23.     NONE
  24. }
  25.

3.2 封装工具类

  1. package com.test.utils;
  2.  
  3. import com.test.enums.SqlType;
  4. import net.sf.jsqlparser.JSQLParserException;
  5. import net.sf.jsqlparser.expression.LongValue;
  6. import net.sf.jsqlparser.parser.CCJSqlParserUtil;
  7. import net.sf.jsqlparser.schema.Table;
  8. import net.sf.jsqlparser.statement.Statement;
  9. import net.sf.jsqlparser.statement.alter.Alter;
  10. import net.sf.jsqlparser.statement.create.index.CreateIndex;
  11. import net.sf.jsqlparser.statement.create.table.CreateTable;
  12. import net.sf.jsqlparser.statement.create.view.CreateView;
  13. import net.sf.jsqlparser.statement.delete.Delete;
  14. import net.sf.jsqlparser.statement.drop.Drop;
  15. import net.sf.jsqlparser.statement.execute.Execute;
  16. import net.sf.jsqlparser.statement.insert.Insert;
  17. import net.sf.jsqlparser.statement.merge.Merge;
  18. import net.sf.jsqlparser.statement.replace.Replace;
  19. import net.sf.jsqlparser.statement.select.FromItem;
  20. import net.sf.jsqlparser.statement.select.Join;
  21. import net.sf.jsqlparser.statement.select.Limit;
  22. import net.sf.jsqlparser.statement.select.PlainSelect;
  23. import net.sf.jsqlparser.statement.select.Select;
  24. import net.sf.jsqlparser.statement.select.SelectBody;
  25. import net.sf.jsqlparser.statement.select.SelectItem;
  26. import net.sf.jsqlparser.statement.select.SubSelect;
  27. import net.sf.jsqlparser.statement.select.WithItem;
  28. import net.sf.jsqlparser.statement.truncate.Truncate;
  29. import net.sf.jsqlparser.statement.update.Update;
  30. import net.sf.jsqlparser.statement.upsert.Upsert;
  31. import net.sf.jsqlparser.util.TablesNamesFinder;
  32.  
  33. import java.io.StringReader;
  34. import java.util.ArrayList;
  35. import java.util.List;
  36.  
  37. /**
  38.  * @projectName: springboot_demo
  39.  * @packageName: com.test.utils
  40.  * @description: jsqlparser解析SQL工具类
  41.  * PlainSelect类不支持union、union all等请使用SetOperationList接口
  42.  * @version: 1.0
  43.  */
  44. public class SqlParserTool {
  45.     /**
  46.      * 由于jsqlparser没有获取SQL类型的原始工具，并且在下面操作时需要知道SQL类型，所以编写此工具方法
  47.      *
  48.      * @param sql sql语句
  49.      * @return sql类型，
  50.      * @throws JSQLParserException
  51.      */
  52.     public static SqlType getSqlType(String sql) throws JSQLParserException {
  53.         Statement sqlStmt = CCJSqlParserUtil.parse(new StringReader(sql));
  54.         if (sqlStmt instanceof Alter) {
  55.             return SqlType.ALTER;
  56.         } else if (sqlStmt instanceof CreateIndex) {
  57.             return SqlType.CREATEINDEX;
  58.         } else if (sqlStmt instanceof CreateTable) {
  59.             return SqlType.CREATETABLE;
  60.         } else if (sqlStmt instanceof CreateView) {
  61.             return SqlType.CREATEVIEW;
  62.         } else if (sqlStmt instanceof Delete) {
  63.             return SqlType.DELETE;
  64.         } else if (sqlStmt instanceof Drop) {
  65.             return SqlType.DROP;
  66.         } else if (sqlStmt instanceof Execute) {
  67.             return SqlType.EXECUTE;
  68.         } else if (sqlStmt instanceof Insert) {
  69.             return SqlType.INSERT;
  70.         } else if (sqlStmt instanceof Merge) {
  71.             return SqlType.MERGE;
  72.         } else if (sqlStmt instanceof Replace) {
  73.             return SqlType.REPLACE;
  74.         } else if (sqlStmt instanceof Select) {
  75.             return SqlType.SELECT;
  76.         } else if (sqlStmt instanceof Truncate) {
  77.             return SqlType.TRUNCATE;
  78.         } else if (sqlStmt instanceof Update) {
  79.             return SqlType.UPDATE;
  80.         } else if (sqlStmt instanceof Upsert) {
  81.             return SqlType.UPSERT;
  82.         } else {
  83.             return SqlType.NONE;
  84.         }
  85.     }
  86.  
  87.     /**
  88.      * 获取sql操作接口,与上面类型判断结合使用
  89.      * example:
  90.      * String sql = "create table a(a string)";
  91.      * SqlType sqlType = SqlParserTool.getSqlType(sql);
  92.      * if(sqlType.equals(SqlType.SELECT)){
  93.      * Select statement = (Select) SqlParserTool.getStatement(sql);
  94.      * }
  95.      *
  96.      * @param sql
  97.      * @return
  98.      * @throws JSQLParserException
  99.      */
  100.     public static Statement getStatement(String sql) throws JSQLParserException {
  101.         Statement sqlStmt = CCJSqlParserUtil.parse(new StringReader(sql));
  102.         return sqlStmt;
  103.     }
  104.  
  105.     /**
  106.      * 获取tables的表名
  107.      *
  108.      * @param statement
  109.      * @return
  110.      */
  111.     public static List<String> getTableList(Select statement) {
  112.         TablesNamesFinder tablesNamesFinder = new TablesNamesFinder();
  113.         List<String> tableList = tablesNamesFinder.getTableList(statement);
  114.         return tableList;
  115.     }
  116.  
  117.     /**
  118.      * 获取join层级
  119.      *
  120.      * @param selectBody
  121.      * @return
  122.      */
  123.     public static List<Join> getJoins(SelectBody selectBody) {
  124.         if (selectBody instanceof PlainSelect) {
  125.             List<Join> joins = ((PlainSelect) selectBody).getJoins();
  126.             return joins;
  127.         }
  128.         return new ArrayList<Join>();
  129.     }
  130.  
  131.     /**
  132.      * @param selectBody
  133.      * @return
  134.      */
  135.     public static List<Table> getIntoTables(SelectBody selectBody) {
  136.         if (selectBody instanceof PlainSelect) {
  137.             List<Table> tables = ((PlainSelect) selectBody).getIntoTables();
  138.             return tables;
  139.         }
  140.         return new ArrayList<Table>();
  141.     }
  142.  
  143.     /**
  144.      * @param selectBody
  145.      * @return
  146.      */
  147.     public static void setIntoTables(SelectBody selectBody, List<Table> tables) {
  148.         if (selectBody instanceof PlainSelect) {
  149.             ((PlainSelect) selectBody).setIntoTables(tables);
  150.         }
  151.     }
  152.  
  153.     /**
  154.      * 获取limit值
  155.      *
  156.      * @param selectBody
  157.      * @return
  158.      */
  159.     public static Limit getLimit(SelectBody selectBody) {
  160.         if (selectBody instanceof PlainSelect) {
  161.             Limit limit = ((PlainSelect) selectBody).getLimit();
  162.             return limit;
  163.         }
  164.         return null;
  165.     }
  166.  
  167.     /**
  168.      * 为SQL增加limit值
  169.      *
  170.      * @param selectBody
  171.      * @param l
  172.      */
  173.     public static void setLimit(SelectBody selectBody, long l) {
  174.         if (selectBody instanceof PlainSelect) {
  175.             Limit limit = new Limit();
  176.             limit.setRowCount(new LongValue(String.valueOf(l)));
  177.             ((PlainSelect) selectBody).setLimit(limit);
  178.         }
  179.     }
  180.  
  181.     /**
  182.      * 获取FromItem不支持子查询操作
  183.      *
  184.      * @param selectBody
  185.      * @return
  186.      */
  187.     public static FromItem getFromItem(SelectBody selectBody) {
  188.         if (selectBody instanceof PlainSelect) {
  189.             FromItem fromItem = ((PlainSelect) selectBody).getFromItem();
  190.             return fromItem;
  191.         } else if (selectBody instanceof WithItem) {
  192.             SqlParserTool.getFromItem(((WithItem) selectBody).getSelectBody());
  193.         }
  194.         return null;
  195.     }
  196.  
  197.     /**
  198.      * 获取子查询
  199.      *
  200.      * @param selectBody
  201.      * @return
  202.      */
  203.     public static SubSelect getSubSelect(SelectBody selectBody) {
  204.         if (selectBody instanceof PlainSelect) {
  205.             FromItem fromItem = ((PlainSelect) selectBody).getFromItem();
  206.             if (fromItem instanceof SubSelect) {
  207.                 return ((SubSelect) fromItem);
  208.             }
  209.         } else if (selectBody instanceof WithItem) {
  210.             SqlParserTool.getSubSelect(((WithItem) selectBody).getSelectBody());
  211.         }
  212.         return null;
  213.     }
  214.  
  215.     /**
  216.      * 判断是否为多级子查询
  217.      *
  218.      * @param selectBody
  219.      * @return
  220.      */
  221.     public static boolean isMultiSubSelect(SelectBody selectBody) {
  222.         if (selectBody instanceof PlainSelect) {
  223.             FromItem fromItem = ((PlainSelect) selectBody).getFromItem();
  224.             if (fromItem instanceof SubSelect) {
  225.                 SelectBody subBody = ((SubSelect) fromItem).getSelectBody();
  226.                 if (subBody instanceof PlainSelect) {
  227.                     FromItem subFromItem = ((PlainSelect) subBody).getFromItem();
  228.                     return subFromItem instanceof SubSelect;
  229.                 }
  230.             }
  231.         }
  232.         return false;
  233.     }
  234.  
  235.     /**
  236.      * 获取查询字段
  237.      *
  238.      * @param selectBody
  239.      * @return
  240.      */
  241.     public static List<SelectItem> getSelectItems(SelectBody selectBody) {
  242.         if (selectBody instanceof PlainSelect) {
  243.             List<SelectItem> selectItems = ((PlainSelect) selectBody).getSelectItems();
  244.             return selectItems;
  245.         }
  246.         return null;
  247.     }
  248.  
  249.     public static void main(String[] args) throws JSQLParserException {
  250.         Statement sqlStmt = CCJSqlParserUtil.parse(new StringReader("show databases"));
  251.         //获取到子查询语句
  252.         String sql = "select * from (select userid from a) a";
  253.         SqlType sqlType = SqlParserTool.getSqlType(sql);
  254.         if(sqlType.equals(SqlType.SELECT)){
  255.             Select statement = (Select) SqlParserTool.getStatement(sql);
  256.             SubSelect subSelect = SqlParserTool.getSubSelect(statement.getSelectBody());
  257.             System.out.println(subSelect.getSelectBody());
  258.         } 
  259.     }
  260. }

该文章基于原文链接：https://blog.csdn.net/ciqingloveless/article/details/82626304

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/知新_RL/article/detail/735097
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号