簡單sql欄位解析器實現參考

等你歸去來發表於2021-06-21

SQL

　　用例：有一段sql語句，我們需要從中擷取出所有欄位部分，以便進行後續的型別推斷，請給出此解析方法。

　　想來很簡單吧，因為 sql 中的欄位列表，使用方式有限，比如 a as b, a, a b...

1. 解題思路

　　如果不想做複雜處理，最容易想到的，就是直接用某個特徵做分割即可。比如，先擷取出欄位列表部分，然後再用逗號',' 分割，就可以得到一個個的欄位了。然後再要細分，其實只需要用 as 進行分割就可以了。

　　看起來好像可行，但是存在許多漏洞，首先，這裡面有太多的假設：各種擷取部分要求必須符合要求，必須沒有多餘的逗號，必須要有as 等等。這明顯不符合要求了。

　　其二，我們可以換一種轉換方式。比如先擷取到field部分，然後先以 as 分割，再以逗號分割，然後取最後一個詞作為field。

　　看起來好像更差了，擷取到哪裡已經完全不知道了。即原文已經被破壞殆盡，而且同樣要求要有 as 轉換標籤，而且對於函式覬覦有 as 的場景，就完全錯誤了。

　　其三，最好還是自行一個個單詞地解析，field 欄位無外乎幾種情況，1. 普通欄位如 select a; 2. 帶as的普通欄位如 select a as b; 3. 帶函式的欄位如 select coalesce(a, b); 4. 帶函式且帶as的欄位如 select coalesce(a, b) ab; 5. 函式內帶as的欄位如 select cast(a as string) b; ... 我們只需依次列舉對應的情況，就可以將欄位解析出來了。

　　看起來是個不錯的想法。但是具體實現如何？

2. 具體解析實現

　　主要分兩個部分，1. 需要定義一個解析後的結果資料結構，以便清晰描述欄位資訊； 2. 分詞解析sql並以結構體返回；

　　我們先來看看整個演算法核心：

/**
 * 功能描述: 簡單sql欄位解析器
 *
 *        樣例如1:
 *          select COALESCE(t1.xno, t2.xno, t3.xno) as xno,
 *             case when t1.no is not null then 1 else null end as xxk001,
 *             case when t2.no is not null then 1 else null end as xxk200,
 *             case when t3.xno is not null then 1 else null end as xx3200
 *             from xxk001 t1
 *               full join xxkj100 t2 on t1.xno = t2.xno
 *               full join xxkj200 t3 on t1.xno = t3.xno;
 *
 *        樣例如2:
 *          select cast(a as string) as b from ccc;
 *
 *        樣例如3:
 *          with a as(select cus,x1 from b1), b as (select cus,x2 from b2)
 *              select a.cus as a_cus from a join b on a.cus=b.cus where xxx;
 *
 *        樣例如4:
 *         select a.xno,b.xx from a_tb as a join b_tb as b on a.id = b.id
 *
 *        樣例如5:
 *          select cast  \t(a as string) a_str, cc (a as double) a_double from x
 *
 */
public class SimpleSqlFieldParser {

    /**
     * 解析一段次標籤sql 中的欄位列表
     *
     * @param sql 原始sql, 需如 select xx from xxx join ... 格式
     * @return 欄位列表
     */
    public static List<SelectFieldClauseDescriptor> parse(String sql) {
        String columnPart = adaptFieldPartSql(sql);
        int deep = 0;
        List<StringBuilder> fieldTokenSwap = new ArrayList<>();
        StringBuilder currentTokenBuilder = new StringBuilder();
        List<SelectFieldClauseDescriptor> fieldList = new ArrayList<>();
        fieldTokenSwap.add(currentTokenBuilder);
        int len = columnPart.length();
        char[] columnPartChars = columnPart.toCharArray();
        for(int i = 0; i < len; i++) {
            // 空格忽略，換行忽略，tab忽略
            // 字串相接
            // 左(號入棧，++deep；
            // 右)號出棧，--deep；
            // deep>0 忽略所有其他直接拼接
            // as 則取下一個值為fieldName
            // case 則直接取到end為止；
            //,號則重置token，構建結果集
            char currentChar = columnPartChars[i];
            switch (currentChar) {
                case '(':
                    ++deep;
                    currentTokenBuilder.append(currentChar);
                    break;
                case ')':
                    --deep;
                    currentTokenBuilder.append(currentChar);
                    break;
                case ',':
                    if(deep == 0) {
                        addNewField(fieldList, fieldTokenSwap, true);
                        fieldTokenSwap = new ArrayList<>();
                        currentTokenBuilder = new StringBuilder();
                        fieldTokenSwap.add(currentTokenBuilder);
                        break;
                    }
                    currentTokenBuilder.append(currentChar);
                    break;
                case ' ':
                case '\t':
                case '\r':
                case '\n':
                    if(deep > 0) {
                        currentTokenBuilder.append(currentChar);
                        continue;
                    }
                    if(currentTokenBuilder.length() == 0) {
                        continue;
                    }
                    // original_name as   --> alias
                    if(i + 1 < len) {
                        int j = i + 1;
                        // 收集連續的空格
                        StringBuilder spaceHolder = new StringBuilder();
                        boolean isNextLeftBracket = false;
                        do {
                            char nextChar = columnPart.charAt(j++);
                            if(nextChar == ' ' || nextChar == '\t'
                                    || nextChar == '\r' || nextChar == '\n') {
                                spaceHolder.append(nextChar);
                                continue;
                            }
                            if(nextChar == '(') {
                                isNextLeftBracket = true;
                            }
                            break;
                        } while (j < len);
                        if(isNextLeftBracket) {
                            currentTokenBuilder.append(currentChar);
                        }
                        if(spaceHolder.length() > 0) {
                            currentTokenBuilder.append(spaceHolder);
                            i += spaceHolder.length();
                        }
                        if(isNextLeftBracket) {
                            // continue next for, function begin
                            continue;
                        }
                    }
                    if(fieldTokenSwap.size() == 1) {
                        if(fieldTokenSwap.get(0).toString().equalsIgnoreCase("case")) {
                            String caseWhenPart = CommonUtil.readSplitWord(
                                    columnPartChars, i, " ", "end");
                            currentTokenBuilder.append(caseWhenPart);
                            if(caseWhenPart.length() <= 0) {
                                throw new BizException("語法錯誤，未找到case..when的結束符");
                            }
                            i += caseWhenPart.length();
                        }
                    }
                    addNewField(fieldList, fieldTokenSwap, false);
                    currentTokenBuilder = new StringBuilder();
                    fieldTokenSwap.add(currentTokenBuilder);
                    break;
                    // 空格忽略
                default:
                    currentTokenBuilder.append(currentChar);
                    break;
            }

        }
        // 處理剩餘尚未儲存的欄位資訊
        addNewField(fieldList, fieldTokenSwap, true);
        return fieldList;
    }

    /**
     * 新增一個欄位描述
     *
     * @param fieldList 欄位容器
     * @param fieldTokenSwap 候選詞
     */
    private static void addNewField(List<SelectFieldClauseDescriptor> fieldList,
                                    List<StringBuilder> fieldTokenSwap,
                                    boolean forceAdd) {
        int ts = fieldTokenSwap.size();
        if(ts == 1 && forceAdd) {
            // db.original_name,
            String fieldName = fieldTokenSwap.get(0).toString();
            String alias = fieldName;
            if(fieldName.contains(".")) {
                alias = fieldName.substring(fieldName.lastIndexOf('.') + 1);
            }
            fieldList.add(new SelectFieldClauseDescriptor(fieldName, alias));
            return;
        }
        if(ts < 2) {
            return;
        }
        if(ts == 2) {
            // original_name alias,
            if(fieldTokenSwap.get(1).toString().equalsIgnoreCase("as")) {
                return;
            }
            fieldList.add(new SelectFieldClauseDescriptor(
                    fieldTokenSwap.get(0).toString(),
                    fieldTokenSwap.get(1).toString()));
        }
        else if(ts == 3) {
            // original_name as alias,
            fieldList.add(new SelectFieldClauseDescriptor(
                    fieldTokenSwap.get(0).toString(),
                    fieldTokenSwap.get(2).toString()));
        }
        else {
            throw new BizException("欄位語法解析錯誤，超過3個以欄位描述資訊:" + ts);
        }
    }

    // 擷取適配 field 欄位資訊部分
    private static String adaptFieldPartSql(String fullSql) {
        int start = fullSql.lastIndexOf("select ");
        int end = fullSql.lastIndexOf(" from");
        String columnPart = fullSql.substring(start + "select ".length(), end);
        return columnPart.trim();
    }

}

　　應該說是比較簡單的，一個for, 一個 switch ，就搞定了。其他的，更多的是邏輯判定。

　　下面我們來看看欄位描述類的寫法，其實就是兩個欄位，源欄位和別名。

/**
 * 功能描述: sql欄位描述 select 欄位描述類
 *
 */
public class SelectFieldClauseDescriptor {
    private String fieldName;
    private String alias;

    public SelectFieldClauseDescriptor(String fieldName, String alias) {
        this.fieldName = fieldName;
        this.alias = alias;
    }

    public String getFieldName() {
        return fieldName;
    }

    public String getAlias() {
        return alias;
    }


    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        SelectFieldClauseDescriptor that = (SelectFieldClauseDescriptor) o;
        return Objects.equals(fieldName, that.fieldName) &&
                Objects.equals(alias, that.alias);
    }

    @Override
    public int hashCode() {
        return Objects.hash(fieldName, alias);
    }

    @Override
    public String toString() {
        return "SelectFieldClauseDescriptor{" +
                "fieldName='" + fieldName + '\'' +
                ", alias='" + alias + '\'' +
                '}';
    }
}

　　它存在的意義，僅僅是為了使用方更方便取值，以為更進一步的解析提供了依據。

3. 單元測試

　　其實像寫這種工具類，最是方便簡單。因為最初的結果，我們早已預料，以測試驅動開發最合適不過了。而且，基本上一出現不符合預期的值時，很快速就定位問題了。

/**
 * 功能描述: sql欄位解析器測試
 **/
public class SimpleSqlFieldParserTest {

    @Test
    public void testParse() {
        String sql;
        List<SelectFieldClauseDescriptor> parsedFieldList;
        sql = "select COALESCE(t1.xno, t2.xno, t3.xno) as xno,\n" +
                "   case when t1.xno is not null then 1 else null end as xxk001,\n" +
                "   case when t2.xno is not null then 1 else null end as xxk200,\n" +
                "   case when t3.xno is not null then 1 else null end as xx3200\n" +
                "   from xxk001 t1\n" +
                "     full join xxkj100 t2 on t1.xno = t2.xno\n" +
                "     full join xxkj200 t3 on t1.xno = t3.xno;";
        parsedFieldList = SimpleSqlFieldParser.parse(sql);
        System.out.println("result:");
        parsedFieldList.forEach(System.out::println);
        Assert.assertEquals("欄位個數解析不正確",
                4, parsedFieldList.size());
        Assert.assertEquals("欄位別名解析不正確",
                "xno", parsedFieldList.get(0).getAlias());
        Assert.assertEquals("欄位別名解析不正確",
                "xx3200", parsedFieldList.get(3).getAlias());

        sql = "select cast(a as string) as b from ccc;";
        parsedFieldList = SimpleSqlFieldParser.parse(sql);
        System.out.println("result:");
        parsedFieldList.forEach(System.out::println);
        Assert.assertEquals("欄位個數解析不正確",
                1, parsedFieldList.size());
        Assert.assertEquals("欄位別名解析不正確",
                "b", parsedFieldList.get(0).getAlias());

        sql = "with a as(select cus,x1 from b1), b as (select cus,x2 from b2)\n" +
                "    select a.cus as a_cus, cast(a \nas string) as a_cus2, " +
                "b.x2 b2 from a join b on a.cus=b.cus where xxx;";
        parsedFieldList = SimpleSqlFieldParser.parse(sql);
        System.out.println("result:");
        parsedFieldList.forEach(System.out::println);
        Assert.assertEquals("欄位個數解析不正確",
                3, parsedFieldList.size());
        Assert.assertEquals("欄位別名解析不正確",
                "a_cus", parsedFieldList.get(0).getAlias());
        Assert.assertEquals("欄位別名解析不正確",
                "b2", parsedFieldList.get(2).getAlias());

        sql = "select a.xno,b.xx,qqq from a_tb as a join b_tb as b on a.id = b.id";
        parsedFieldList = SimpleSqlFieldParser.parse(sql);
        System.out.println("result:");
        parsedFieldList.forEach(System.out::println);
        Assert.assertEquals("欄位個數解析不正確",
                3, parsedFieldList.size());
        Assert.assertEquals("欄位別名解析不正確",
                "xno", parsedFieldList.get(0).getAlias());
        Assert.assertEquals("欄位別名解析不正確",
                "qqq", parsedFieldList.get(2).getAlias());

        sql = "select cast (a.a_int as string) a_str, b.xx, coalesce  \n( a, b, c) qqq from a_tb as a join b_tb as b on a.id = b.id";
        parsedFieldList = SimpleSqlFieldParser.parse(sql);
        System.out.println("result:");
        parsedFieldList.forEach(System.out::println);
        Assert.assertEquals("欄位個數解析不正確",
                3, parsedFieldList.size());
        Assert.assertEquals("欄位別名解析不正確",
                "a_str", parsedFieldList.get(0).getAlias());
        Assert.assertEquals("欄位原始名解析不正確",
                "cast (a.a_int as string)", parsedFieldList.get(0).getFieldName());
        Assert.assertEquals("欄位別名解析不正確",
                "qqq", parsedFieldList.get(2).getAlias());
        Assert.assertEquals("欄位原始名解析不正確",
                "coalesce  \n( a, b, c)", parsedFieldList.get(2).getFieldName());
    }
}

　　至此，一個簡單的欄位解析器完成。小工具，供參考！

簡單語法解析器實現參考
2020-10-06
[轉]MySQL 欄位型別參考
2014-11-16
MySql型別
PE結構各欄位偏移參考
2013-04-24
MySQL簡單實現多欄位模糊查詢
2019-03-15
MySql
參考Vue-router, 實現一個簡單的前端路由
2018-03-09
Vue前端路由
CSS 長度單位參考(轉)
2007-08-12
CSS
SQL字元型欄位按數字型欄位排序實現方法
2021-09-09
SQL字元排序
em單位的參考物件是什麼
2017-03-21
物件
JavaScript實現一個簡單的Markdown語法解析器
2023-03-26
JavaScript
SQL Server中根據某個欄位，ID欄位自動增長的實現
2012-05-23
SQLServer
SQL優化參考
2018-09-15
SQL優化
sql 優化參考
2013-02-03
SQL優化
sql server 參考資源
2008-05-23
SQLServer
SQL語法參考(轉)
2007-08-10
SQL
巧用欄位對映實現指定欄位的搜尋
2017-06-26
基於long pull實現簡易的訊息系統參考
2022-03-24
SQL新增表欄位
2015-12-31
SQL
SQL語法參考手冊
2007-01-28
SQL
Laravel 實現多欄位登陸（超簡單，叫你如何不動腦子完成任務）
2019-09-29
Laravel
崩潰日誌的欄位簡單說明
2017-11-01
如何實現簡單的位陣列(bit array)
2013-05-27
陣列
【SQL*Plus】常用列格式化命令實驗參考
2010-03-16
SQL
JAVA期末簡答題參考
2020-12-27
Java
sql語句修改欄位型別和增加欄位
2018-12-14
SQL型別
HANA SQL參考及Oracle對照
2018-11-27
SQLOracle
SQL語法參考手冊(轉)
2007-08-13
SQL
SQL Server資料庫的簡單實現方法
2010-02-24
SQLServer資料庫
參考微信模組化通訊具體實現
2018-02-05
七牛重新整理介面php實現參考
2016-09-08
PHP
Android BottomNavigationView，底部導航欄的簡單實現
2017-04-06
AndroidNavigationView
HTML 字元實體參考
2018-06-30
HTML字元
GoldenGate實施參考
2017-01-29
Go
【TUNE_ORACLE】ROWID切片SQL參考
2021-07-28
OracleSQL
ＳＱＬ語法參考手冊(SQL) (轉)
2007-12-09
SQL
DB2_更新SQL欄位
2021-09-03
DB2SQL
sqlite sql 修改欄位型別
2012-07-12
SQLite型別
SQL Server 自增欄位重置
2009-12-14
SQLServer
PHP表單-必需欄位
2017-07-03
PHP

簡單sql欄位解析器實現參考

1. 解題思路

2. 具體解析實現

3. 單元測試

相關文章