ParserSupport (sql2java manager 5.6.2 API)

java.lang.Object
- gu.sql2java.manager.parser.ParserSupport

```
public class ParserSupport
extends java.lang.Object
```
该类提供了一系列用于解析和处理 SQL 语句的工具方法。

支持的功能包括：
- 解析 SELECT、UPDATE、DELETE 等 SQL 语句
- 生成 count 查询 SQL
- 处理 SQL 语句的 AST（抽象语法树）
- 解析 SQL 语句部件
- 处理表别名和 JOIN 子句
- 规范化 SQL 语句
作者:

guyadong

嵌套类概要

嵌套类
限定符和类型类和说明

static class ParserSupport.SqlParserInfo

嵌套类
限定符和类型	类和说明
`static class`	`ParserSupport.SqlParserInfo`

构造器概要

构造器
构造器和说明

ParserSupport()

构造器
构造器和说明
`ParserSupport()`

方法概要

所有方法静态方法具体方法
限定符和类型	方法和说明
`static net.sf.jsqlparser.expression.Expression`	`addExpressions(net.sf.jsqlparser.expression.Expression whereCause, java.lang.String expression, boolean useAnd)` 为已有的WHERE条件表达式添加新的表达式若原WHERE条件表达式是OrExpression类型，会将其用括号包裹若新表达式为空，则直接返回原WHERE条件表达式若新表达式以"WHERE"开头，会将其作为WHERE子句解析否则将其作为普通表达式解析最后根据useAnd参数决定使用AND还是OR连接新旧表达式
`static net.sf.jsqlparser.statement.Statement`	`addExpressions(net.sf.jsqlparser.statement.Statement statement, java.lang.String joinClause, java.lang.String expression, boolean useAnd)` 为SQL语句对象添加新的WHERE条件表达式和JOIN子句该方法会解析不同类型的SQL语句（如SELECT、DELETE、UPDATE），为这些语句添加新的WHERE条件表达式和JOIN子句，并根据useAnd参数决定使用AND还是OR连接新旧表达式。
`static java.util.List<net.sf.jsqlparser.statement.select.Join>`	`addJoins(java.util.List<net.sf.jsqlparser.statement.select.Join> joins, java.lang.String joinClause)` 为已有的JOIN列表添加新的JOIN子句若传入的JOIN子句为空，则直接返回原JOIN列表；解析传入的JOIN子句为JOIN列表，若原JOIN列表不为空，则将解析后的JOIN列表追加到原列表后返回；若原JOIN列表为空，则直接返回解析后的JOIN列表。
`static com.google.common.base.Function<java.lang.String,java.lang.String>`	`aliasFunctionOf(net.sf.jsqlparser.statement.Statement statement)` 从 SQL 语句对象中创建一个用于根据表名获取对应别名的函数。
`static java.util.Map<java.lang.String,java.lang.String>`	`aliasOf(net.sf.jsqlparser.statement.Statement statement)` 从 SQL 语句对象中提取表名及其对应的别名映射。
`static com.google.common.base.Function<java.lang.String,java.lang.String>`	`asAliasFunction(java.util.Map<java.lang.String,java.lang.String> tableAlias)` 创建一个用于根据表名获取对应别名的函数。
`static java.lang.String`	`countSql(net.sf.jsqlparser.statement.select.Select select, java.lang.String countColumn)` 生成 count 查询 SQL,如果`select`为空则返回`null`
`static java.lang.String`	`countSql(java.lang.String sql, java.lang.String countColumn)` 生成 count 查询 SQL,如果`sql`为空或不是SELECT语句不能生成count语句则返回`null`
`static java.util.Map<java.lang.String,java.lang.String>`	`extractJoinedTables(java.lang.String joinClause)` 解析JOIN子句，获取已连接的表信息对传入的JOIN子句进行解析，处理流程如下： 1.
`static boolean`	`isBoolean(net.sf.jsqlparser.schema.Column column)` 如果`Column`没有定义table,且字段名为true/false(不区分大小写)则视为布尔常量
`static <M extends net.sf.jsqlparser.Model> M`	`normalizeModel(java.lang.String tablename, M model, java.util.Map<java.lang.String,java.lang.String> tableAlias)` 规范化模型对象，使用`CanonicalColumnVisitor`对不同类型的模型对象进行访问，为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的模型对象。
`static java.lang.String`	`normalizeSql(java.lang.String tablename, java.lang.String sql, java.util.Map<java.lang.String,java.lang.String> tableAlias)` 规范化SQL语句字符串若传入的SQL语句为空或null，则直接返回原值；若不为空，则调用`normalizeStatement(String, String, Map)`方法对其进行规范化处理，若解析过程中发生异常，则不做任何处理返回原值。
`static net.sf.jsqlparser.statement.Statement`	`normalizeStatement(java.lang.String tablename, net.sf.jsqlparser.statement.Statement statement, java.util.Map<java.lang.String,java.lang.String> tableAlias)` 规范化SQL语句对应的Statement对象使用`CanonicalColumnVisitor`对传入的Statement对象进行访问，为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的Statement对象。
`static net.sf.jsqlparser.statement.Statement`	`normalizeStatement(java.lang.String tablename, java.lang.String sql, java.util.Map<java.lang.String,java.lang.String> tableAlias)` 规范化SQL语句对应的Statement对象解析传入的SQL语句，获取对应的Statement对象，并使用`CanonicalColumnVisitor`对其进行访问，为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的Statement对象。
`static net.sf.jsqlparser.statement.Statement`	`parse(java.lang.String sql, net.sf.jsqlparser.parser.CCJSqlParserVisitor visitor, SqlSyntaxNormalizer sqlSyntaxNormalizer)` 实现SQL语句解析,解析成功则返回解析后的`Statement`，并通过`visitor`参数提供基于AST(抽象语法树)的遍历所有节点的能力。
`static ParserSupport.SqlParserInfo`	`parse0(java.lang.String sql, net.sf.jsqlparser.parser.CCJSqlParserVisitor visitor, SqlSyntaxNormalizer sqlSyntaxAnalyzer)` 参照`CCJSqlParserUtil.parseAST(String)`和`CCJSqlParserUtil.parse(String)`实现SQL语句解析, 解析成功则返回解析后的`ParserSupport.SqlParserInfo`对象，并通过`visitor`参数提供基于AST(抽象语法树)的遍历所有节点的能力。
`static <T> T`	`parseComponent(java.lang.String input, java.lang.Class<T> targetType)` 调用`CCJSqlParser`解析SQL语句部件返回解析生成的对象, 使用`targetType`的类名作为解析方法名
`static <T> T`	`parseComponent(java.lang.String input, java.lang.String method)` 调用`CCJSqlParser`解析SQL语句部件返回解析生成的对象,如`'ORDER BY id DESC'`
`static <T> T`	`parseComponent(java.lang.String input, java.lang.String method, java.lang.Class<T> targetType)` 调用`CCJSqlParser`解析SQL语句部件返回解析生成的对象,如`'ORDER BY id DESC'`
`static net.sf.jsqlparser.statement.select.Select`	`parseSelect(java.lang.String sql)` 解析SELECT SQL语句,解析失败或非SELECT语句则抛出异常
`static net.sf.jsqlparser.statement.select.Select`	`parseSelectUnchecked(java.lang.String sql)` 解析SELECT SQL语句,解析失败或非SELECT语句则
`static net.sf.jsqlparser.statement.Statement`	`parseStatement(java.lang.String sql)` 解析 SQL 语句字符串并返回对应的 Statement 对象该方法使用 ParserSupport 工具类对输入的 SQL 字符串进行解析，若解析成功则返回解析得到的 Statement 对象，若解析失败则抛出 JSQLParserException 异常。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - ParserSupport
```
public ParserSupport()
```
- 方法详细资料
  - parseSelect
```
public static net.sf.jsqlparser.statement.select.Select parseSelect(java.lang.String sql)
```
    解析SELECT SQL语句,解析失败或非SELECT语句则抛出异常
    
    参数:
    
    sql -
  - parseSelectUnchecked
```
public static net.sf.jsqlparser.statement.select.Select parseSelectUnchecked(java.lang.String sql)
```
    解析SELECT SQL语句,解析失败或非SELECT语句则
    
    参数:
    
    sql -
  - countSql
```
public static java.lang.String countSql(net.sf.jsqlparser.statement.select.Select select,
                                        java.lang.String countColumn)
```
    生成 count 查询 SQL,如果select为空则返回null
    
    参数:
    
    select -
    
    countColumn - 列名，默认 0
  - countSql
```
public static java.lang.String countSql(java.lang.String sql,
                                        java.lang.String countColumn)
```
    生成 count 查询 SQL,如果sql为空或不是SELECT语句不能生成count语句则返回null
    
    参数:
    
    sql -
    
    countColumn - 列名，默认 0
  - parse
```
public static net.sf.jsqlparser.statement.Statement parse(java.lang.String sql,
                                                          net.sf.jsqlparser.parser.CCJSqlParserVisitor visitor,
                                                          SqlSyntaxNormalizer sqlSyntaxNormalizer)
                                                   throws net.sf.jsqlparser.JSQLParserException
```
    实现SQL语句解析,解析成功则返回解析后的Statement，并通过visitor参数提供基于AST(抽象语法树)的遍历所有节点的能力。
    
    参数:
    
    sql - SQL语句
    
    visitor - 遍历所有节点的SimpleNode接口实例，为null忽略
    
    sqlSyntaxNormalizer - SQL语句分析转换器，为null忽略
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 输入的SQL语句有语法错误
    
    另请参阅:
    
    parse0(String, CCJSqlParserVisitor, SqlSyntaxNormalizer)
  - parse0
```
public static ParserSupport.SqlParserInfo parse0(java.lang.String sql,
                                                 net.sf.jsqlparser.parser.CCJSqlParserVisitor visitor,
                                                 SqlSyntaxNormalizer sqlSyntaxAnalyzer)
                                          throws net.sf.jsqlparser.JSQLParserException
```
    参照CCJSqlParserUtil.parseAST(String)和CCJSqlParserUtil.parse(String)实现SQL语句解析, 解析成功则返回解析后的ParserSupport.SqlParserInfo对象，并通过visitor参数提供基于AST(抽象语法树)的遍历所有节点的能力。
    
    参数:
    
    sql - SQL语句
    
    visitor - 遍历所有节点的SimpleNode接口实例，为null忽略
    
    sqlSyntaxAnalyzer - SQL语句分析转换器，为null忽略
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 输入的SQL语句有语法错误
    
    另请参阅:
    
    Node.jjtAccept(CCJSqlParserVisitor, Object)
  - parseComponent
```
public static <T> T parseComponent(java.lang.String input,
                                   java.lang.String method,
                                   java.lang.Class<T> targetType)
```
    调用CCJSqlParser解析SQL语句部件返回解析生成的对象,如'ORDER BY id DESC'
    
    类型参数:
    
    T -
    
    参数:
    
    input -
    
    method - 指定调用的CCJSqlParser解析方法
    
    targetType - 返回的解析对象类型
    
    从以下版本开始:
    
    3.18.3
  - parseComponent
```
public static <T> T parseComponent(java.lang.String input,
                                   java.lang.String method)
```
    调用CCJSqlParser解析SQL语句部件返回解析生成的对象,如'ORDER BY id DESC'
    
    类型参数:
    
    T -
    
    参数:
    
    input -
    
    method - 指定调用的CCJSqlParser解析方法
    
    从以下版本开始:
    
    3.35.0
  - parseComponent
```
public static <T> T parseComponent(java.lang.String input,
                                   java.lang.Class<T> targetType)
```
    调用CCJSqlParser解析SQL语句部件返回解析生成的对象, 使用targetType的类名作为解析方法名
    
    从以下版本开始:
    
    3.18.3
    
    另请参阅:
    
    parseComponent(String, String, Class)
  - parseStatement
```
public static net.sf.jsqlparser.statement.Statement parseStatement(java.lang.String sql)
                                                            throws net.sf.jsqlparser.JSQLParserException
```
    解析 SQL 语句字符串并返回对应的 Statement 对象
    该方法使用 ParserSupport 工具类对输入的 SQL 字符串进行解析，
    若解析成功则返回解析得到的 Statement 对象，若解析失败则抛出 JSQLParserException 异常。
    
    参数:
    
    sql - 待解析的 SQL 语句字符串
    
    返回:
    
    解析后的 Statement 对象
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 当 SQL 语句解析失败时抛出该异常
    
    从以下版本开始:
    
    3.35.0
  - isBoolean
```
public static boolean isBoolean(net.sf.jsqlparser.schema.Column column)
```
    如果Column没有定义table,且字段名为true/false(不区分大小写)则视为布尔常量
    
    参数:
    
    column -
  - asAliasFunction
```
public static com.google.common.base.Function<java.lang.String,java.lang.String> asAliasFunction(java.util.Map<java.lang.String,java.lang.String> tableAlias)
```
    创建一个用于根据表名获取对应别名的函数。该函数常用于 SQL 查询构建过程，能够将输入的表名转换为其在查询中的实际引用名称（别名或原表名）。实现说明：使用内部类 AliasFunction 而非简单 lambda 表达式实现，主要目的如下： 1. 提供自定义的 hashCode 和 equals 方法，支持基于内容的等价性比较 2. 使返回的函数实例可用于 aocache 注解定义的缓存方法中作为键参数 3. 重写 toString 方法，增强日志打印的可读性
    
    参数:
    
    tableAlias - 表名与别名的映射，键为表名，值为对应的表别名
    
    返回:
    
    一个函数对象，输入表名，返回对应的引用名称（别名或原表名），若未找到则返回 null
    
    从以下版本开始:
    
    3.35.0
  - aliasOf
```
public static java.util.Map<java.lang.String,java.lang.String> aliasOf(net.sf.jsqlparser.statement.Statement statement)
```
    从 SQL 语句对象中提取表名及其对应的别名映射。该方法会遍历不同类型的 SQL 语句（如 SELECT、UPDATE、UPSERT、DELETE），收集其中 FROM 子句和 JOIN 子句里的表名及其别名，将其存储在映射中返回。若传入的 SQL 语句对象为 null，则返回空映射。
    
    参数:
    
    statement - SQL 语句对象，包含要解析的 SQL 语句信息，可为 null
    
    返回:
    
    表名与别名的映射，键为表名，值为对应的别名。若 statement 为 null，返回空映射
    
    从以下版本开始:
    
    3.35.0
  - aliasFunctionOf
```
public static com.google.common.base.Function<java.lang.String,java.lang.String> aliasFunctionOf(net.sf.jsqlparser.statement.Statement statement)
```
    从 SQL 语句对象中创建一个用于根据表名获取对应别名的函数。
    该方法会先调用 aliasOf(Statement) 方法从 SQL 语句对象中提取表名及其对应的别名映射，
    然后将该映射转换为不可变对象，最后调用 asAliasFunction(Map) 方法创建一个函数对象。
    将输入参数转为不可变对象，便于返回的对象用于 aocache 的 KEY。
    
    参数:
    
    statement - SQL 语句对象，包含要解析的 SQL 语句信息
    
    返回:
    
    一个函数对象，输入表名，返回对应的引用名称（别名或原表名），若未找到则返回 null
    
    从以下版本开始:
    
    3.35.0
  - extractJoinedTables
```
public static java.util.Map<java.lang.String,java.lang.String> extractJoinedTables(java.lang.String joinClause)
                                                                            throws net.sf.jsqlparser.JSQLParserException
```
    解析JOIN子句，获取已连接的表信息
    对传入的JOIN子句进行解析，处理流程如下： 1. 若JOIN子句为空或null，则返回空映射 2. 使用parseComponent(String, String, Class)解析JOIN子句，获取JOIN列表 3. 从每个JOIN对象中提取右连接项(Join.getRightItem()) 4. 将右连接项转换为表名(或别名)与表对象的映射
    
    参数:
    
    joinClause - 待解析的JOIN子句
    
    返回:
    
    已连接的表名(或别名)与表对象的映射(不可变)，JOIN子句为空时返回空映射
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 当解析JOIN子句发生异常时抛出
    
    从以下版本开始:
    
    3.35.0
  - normalizeModel
```
public static <M extends net.sf.jsqlparser.Model> M normalizeModel(java.lang.String tablename,
                                                                   M model,
                                                                   java.util.Map<java.lang.String,java.lang.String> tableAlias)
                                                            throws net.sf.jsqlparser.JSQLParserException
```
    规范化模型对象，使用CanonicalColumnVisitor对不同类型的模型对象进行访问，
    为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的模型对象。
    支持处理的模型对象类型包括：
    - Statement SQL语句对象
    - Expression 表达式对象
    - FromItem FROM子句项对象
    - SelectBody SELECT语句主体对象
    
    类型参数:
    
    M - 模型对象的泛型类型，需继承自Model
    
    参数:
    
    tablename - 表名，用于为缺少表名前缀的列添加表名或别名
    
    model - 待规范化的模型对象
    
    tableAlias - 表别名映射，用于替换SQL语句中的表名，为null忽略
    
    返回:
    
    规范化处理后的模型对象
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 当处理过程中发生异常时抛出
    
    从以下版本开始:
    
    3.35.0
  - normalizeStatement
```
public static net.sf.jsqlparser.statement.Statement normalizeStatement(java.lang.String tablename,
                                                                       net.sf.jsqlparser.statement.Statement statement,
                                                                       java.util.Map<java.lang.String,java.lang.String> tableAlias)
                                                                throws net.sf.jsqlparser.JSQLParserException
```
    规范化SQL语句对应的Statement对象
    使用CanonicalColumnVisitor对传入的Statement对象进行访问，为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的Statement对象。
    
    参数:
    
    tablename - 表名，用于为缺少表名前缀的列添加表名或别名
    
    statement - 待规范化的SQL语句对应的Statement对象
    
    tableAlias - 表别名映射，用于替换SQL语句中的表名，为null忽略
    
    返回:
    
    规范化处理后的Statement对象
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 当处理过程中发生异常时抛出
    
    从以下版本开始:
    
    3.35.0
  - normalizeStatement
```
public static net.sf.jsqlparser.statement.Statement normalizeStatement(java.lang.String tablename,
                                                                       java.lang.String sql,
                                                                       java.util.Map<java.lang.String,java.lang.String> tableAlias)
                                                                throws net.sf.jsqlparser.JSQLParserException
```
    规范化SQL语句对应的Statement对象
    解析传入的SQL语句，获取对应的Statement对象，并使用CanonicalColumnVisitor对其进行访问，为没有指定表名的字段名自动加上 tablename 指定的表名前缀，最后返回处理后的Statement对象。
    
    参数:
    
    tablename - 目标表名，用于为没有指定表名的字段添加前缀
    
    sql - 待解析的SQL语句
    
    tableAlias - 表别名映射，用于替换SQL语句中的表名，为null忽略
    
    返回:
    
    规范化处理后的Statement对象
    
    抛出:
    
    net.sf.jsqlparser.JSQLParserException - 当解析SQL语句发生异常时抛出
    
    从以下版本开始:
    
    3.35.0
  - normalizeSql
```
public static java.lang.String normalizeSql(java.lang.String tablename,
                                            java.lang.String sql,
                                            java.util.Map<java.lang.String,java.lang.String> tableAlias)
```
    规范化SQL语句字符串
    若传入的SQL语句为空或null，则直接返回原值；
    若不为空，则调用normalizeStatement(String, String, Map)方法对其进行规范化处理，
    若解析过程中发生异常，则不做任何处理返回原值。
    
    参数:
    
    tablename - 表名，用于为缺少表名前缀的列添加表名或别名
    
    sql - 待规范化的SQL语句字符串
    
    tableAlias - 表别名映射，用于替换SQL语句中的表名，为null忽略
    
    返回:
    
    规范化处理后的SQL语句字符串，若解析失败则返回原SQL语句
  - addExpressions
```
public static net.sf.jsqlparser.expression.Expression addExpressions(net.sf.jsqlparser.expression.Expression whereCause,
                                                                     java.lang.String expression,
                                                                     boolean useAnd)
```
    为已有的WHERE条件表达式添加新的表达式
    若原WHERE条件表达式是OrExpression类型，会将其用括号包裹
    若新表达式为空，则直接返回原WHERE条件表达式
    若新表达式以"WHERE"开头，会将其作为WHERE子句解析
    否则将其作为普通表达式解析
    最后根据useAnd参数决定使用AND还是OR连接新旧表达式
    
    参数:
    
    whereCause - 已有的WHERE条件表达式，可以为null
    
    expression - 待添加的新表达式
    
    useAnd - 是否使用AND连接新旧表达式，true表示使用AND，false表示使用OR
    
    返回:
    
    添加新表达式后的WHERE条件表达式
    
    从以下版本开始:
    
    3.35.0
  - addJoins
```
public static java.util.List<net.sf.jsqlparser.statement.select.Join> addJoins(java.util.List<net.sf.jsqlparser.statement.select.Join> joins,
                                                                               java.lang.String joinClause)
```
    为已有的JOIN列表添加新的JOIN子句
    若传入的JOIN子句为空，则直接返回原JOIN列表；
    解析传入的JOIN子句为JOIN列表，若原JOIN列表不为空，则将解析后的JOIN列表追加到原列表后返回；
    若原JOIN列表为空，则直接返回解析后的JOIN列表。
    
    参数:
    
    joins - 已有的JOIN列表，可为null
    
    joinClause - 待添加的JOIN子句
    
    返回:
    
    添加新JOIN子句后的JOIN列表
    
    从以下版本开始:
    
    3.35.0
  - addExpressions
```
public static net.sf.jsqlparser.statement.Statement addExpressions(net.sf.jsqlparser.statement.Statement statement,
                                                                   java.lang.String joinClause,
                                                                   java.lang.String expression,
                                                                   boolean useAnd)
```
    为SQL语句对象添加新的WHERE条件表达式和JOIN子句
    该方法会解析不同类型的SQL语句（如SELECT、DELETE、UPDATE），
    为这些语句添加新的WHERE条件表达式和JOIN子句，
    并根据useAnd参数决定使用AND还是OR连接新旧表达式。
    
    参数:
    
    statement - SQL语句对象，包含要处理的SQL语句信息
    
    joinClause - 待添加的JOIN子句
    
    expression - 待添加的新表达式
    
    useAnd - 是否使用AND连接新旧表达式，true表示使用AND，false表示使用OR
    
    返回:
    
    添加新表达式和JOIN子句后的Statement对象
    
    从以下版本开始:
    
    3.35.0

类 ParserSupport

嵌套类概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

ParserSupport

方法详细资料

parseSelect

parseSelectUnchecked

countSql

countSql

parse

parse0

parseComponent

parseComponent

parseComponent

parseStatement

isBoolean

asAliasFunction

aliasOf

aliasFunctionOf

extractJoinedTables

normalizeModel

normalizeStatement

normalizeStatement

normalizeSql

addExpressions

addJoins

addExpressions