jsqlparser:基于抽象语法树(AST)遍历SQL语句的语法元素

Posted 2022-11-27 10km

jsqlparser是一个java的SQL语句解析器，基于它可以实现很多之前无法完成的工作。

		<!-- maven 依赖库引用 -->
        <dependency>
            <groupId>com.github.jsqlparser</groupId>
            <artifactId>jsqlparser</artifactId>
            <version>4.5</version>
        </dependency

比如如下的SQL语句:

SELECT person.id,person.name,group.name  FROM person JOIN group ON person.group_id = group.id WHERE person.birthdate > '1980-01-01'

在mysql中执行没有任何问题，但是如果用phoenix在HBase数据库中执行，语法是过不去的。因为phoenix中默认字段名，表名都是大写的，如果指定小写的字段和表名，需要加双引号.

SELECT "person"."id","person"."name","group"."name"  FROM "person" JOIN "group" ON "person"."group_id" = "group"."id" WHERE "person"."birthdate" > '1980-01-01'

对于一个SQL语句如何能根据数据库的要求为字段名和表名自动加引号或双引号，就需要用到jsqlparser这个利器。

jsqlparser解析一个SQL语句后会生成一个抽象语法树(AST-- Abstract Syntax Tree)对象SimpleNode,并提供了用于遍历AST的接口CCJSqlParserVisitor，应用层只要实现这个接口我们就可以通过接口方法得到想要的SQL语法元素节点对象，比如Column，Table。当然还可以根据实际需要干点别的。
以下就以为字段名和表名加双引号为例，说明如何用CCJSqlParserVisitor来遍历所有AST节点

	@Test
	public void test10ParseVisitor() throws ParseException 
	    String sql = "SELECT person.id,person.name,group.name  FROM person JOIN group ON person.group_id = group.id WHERE person.birthdat > '1980-01-01'";
		/** 创建SQL语句解析器实例 */
		CCJSqlParser parser = CCJSqlParserUtil.newParser(sql);
		/** 解析SQL语句 */
        Statement stmt = parser.Statement();
		/** 使用 LogVisiter对象遍历AST的所有节点 */
        parser.getASTRoot().jjtAccept(new LogVisitor(), null);
		
		System.out.printf("sql--> %s",stmt);
	
	
	/**
	 * 遍历所有节点的@link net.sf.jsqlparser.parser.CCJSqlParserVisitor 接口实现类
	 * @author guyadong
	 *
	 */
	static class LogVisitor extends CCJSqlParserDefaultVisitor
        @Override
        public Object visit(SimpleNode node, Object data) 
            Object value = node.jjtGetValue();
            /** 根据节点类型找出表名和字段名节点，对名字加上双引号 */
            if (node.getId() == CCJSqlParserTreeConstants.JJTCOLUMN)             	
                System.out.printf("column %s",value.toString());
                Column column = (Column)value;
                column.setColumnName("\\"" + column.getColumnName() + "\\"");
                Table table = column.getTable();
                if(null != table)
                    table.setName("\\"" + table.getName() + "\\"");
                
             else if (node.getId() == CCJSqlParserTreeConstants.JJTTABLE) 
                System.out.printf("table %s",value.toString());
                Table table = (Table)value;
                if(null != table)
                    table.setName("\\"" + table.getName() + "\\"");
                
            else if(null != value)
            	/** 其他类型节点输出节点类型值，Java类型和节点值 */
                System.out.printf("%d %s %s",node.getId(),value.getClass().getSimpleName(),value.toString());
            
            return super.visit(node, data);
        
    

输出：

6 PlainSelect SELECT person.id, person.name, group.name FROM person JOIN group ON person.group_id = group.id WHERE person.birthdat > ‘1980-01-01’
9 SelectExpressionItem person.id
column person.id
9 SelectExpressionItem person.name
column person.name
9 SelectExpressionItem group.name
column group.name
table person
10 Join JOIN group ON person.group_id = group.id
table group
14 EqualsTo person.group_id = group.id
column person.group_id
column group.id
14 GreaterThan person.birthdat > ‘1980-01-01’
column person.birthdat
20 StringValue ‘1980-01-01’
sql–> SELECT “person”.“id”, “person”.“name”, “group”.“name” FROM “person” JOIN “group” ON “person”.“group_id” = “group”.“id” WHERE “person”.“birthdat” > ‘1980-01-01’

从上面最后一行输出可以看到，jsqlparser已经精确的将SQL语句中所有表名和字段名都自动加了双引号。

参考资料

《Parsing table and column names from SQL/HQL Java》