原文摘自本人CSDN博客：【从零单排Golang】第九话：用go语言解析并分析sql语句的方法
在Golang的实战中，总会遇到一些场景，比如抓包分析sql指纹，或者是输入sql时检查sql的风险，这类操作都需要解析sql的工具才能够生效。今天，就来介绍一些Golang当中解析sql的工具包和使用方法。
本文介绍的工具是vitess-sqlparser，主要结合了两个sql解析工具：
其中，xwb1989/sqlparser项目支持的功能有限，尤其对于DDL没有很好的支持，而tidbparser则功能比较全面。下面以tidbparser为例，讲述一下解析以及分析sql里DDL语句的一种方式。
代码相关写法可以查看这篇文章。首先，我们先自定义一个要验证的DDL语句：
ALTER TABLE Persons DROP COLUMN DateOfBirth, DROP COLUMN ID;
很明显是一个删除列的语句，这类语句在线上执行也是会有风险的。如果用xwb1989/sqlparser工具，是无法解析识别的，而用tidbparser，可以这样写：
package sqlcheck
import (
"fmt"
"github.com/blastrain/vitess-sqlparser/tidbparser/ast"
"github.com/blastrain/vitess-sqlparser/tidbparser/parser"
"testing"
)
// 定义一个可以访问SQL解析树节点的Visitor
type DropColumnVisitor struct {
TableName string
Columns []string
}
func (v *DropColumnVisitor) IsValid() bool {
return v.TableName != "" && len(v.Columns) > 0
}
func (v *DropColumnVisitor) Enter(in ast.Node) (out ast.Node, skipChildren bool) {
fmt.Printf("%T\n", in)
// 识别了ALTER就直接访问子节点，看是不是DropColumn
switch in.(type) {
case *ast.AlterTableStmt:
if v.TableName != "" {
break
}
node := in.(*ast.AlterTableStmt)
v.TableName = node.Table.Name.String()
for _, spec := range node.Specs {
// 看解析的Tp枚举是不是ast.AlterTableDropColumn对应的枚举
if spec.Tp == ast.AlterTableDropColumn {
v.Columns = append(v.Columns, spec.OldColumnName.OrigColName())
}
}
default:
break
}
// 不需要访问子节点
return in, true
}
func (v *DropColumnVisitor) Leave(in ast.Node) (out ast.Node, ok bool) {
return in, true
}
func TestParseDropColumn(t *testing.T) {
sql := "ALTER TABLE Persons DROP COLUMN DateOfBirth, DROP COLUMN ID;"
sqlParser := parser.New()
stmtNodes, err := sqlParser.Parse(sql, "", "")
if err != nil {
t.Fatalf("Parse error: %v", err)
}
t.Logf("stmt: %s", JsonDump(stmtNodes))
v := &DropColumnVisitor{
TableName: "",
Columns: []string{},
}
// 每个根节点开始起访问
for _, stmtNode := range stmtNodes {
stmtNode.Accept(v)
}
t.Logf("visitor: %s", JsonDump(v))
if !v.IsValid() {
t.Fatalf("invalid drop column ddl")
}
t.Logf("drop columns %v at table %s", v.Columns, v.TableName)
}
当解析了sql之后，我们需要定义一个实现了Enter和Leave方法的Visitor接口interface，才能够开始识别sql解析树具体的内容。这里灵活用到了接口interface的设计方式，在cache-interface一篇文章中也有介绍到。如果解析的节点是*ast.AlterTableStmt类型，那么首先它就是个ALTER语句，再往下需要查Specs属性里是不是有DROP COLUMN对应的类型枚举，如果有的话，那就是一个删除列的语句了。
我们打印整个解析树，就能够清晰的看到结果：
=== RUN TestParseDropColumn
vitess_sqlparser_test.go:50: stmt: [
{
"Table": {
"Schema": {
"O": "",
"L": ""
},
"Name": {
"O": "Persons",
"L": "persons"
},
"DBInfo": null,
"TableInfo": null,
"IndexHints": null
},
"Specs": [
{
"Tp": 4,
"Name": "",
"Constraint": null,
"Options": null,
"NewTable": null,
"NewColumns": null,
"OldColumnName": {
"Schema": {
"O": "",
"L": ""
},
"Table": {
"O": "",
"L": ""
},
"Name": {
"O": "DateOfBirth",
"L": "dateofbirth"
}
},
"Position": null,
"LockType": 0
},
{
"Tp": 4,
"Name": "",
"Constraint": null,
"Options": null,
"NewTable": null,
"NewColumns": null,
"OldColumnName": {
"Schema": {
"O": "",
"L": ""
},
"Table": {
"O": "",
"L": ""
},
"Name": {
"O": "ID",
"L": "id"
}
},
"Position": null,
"LockType": 0
}
]
}
]
vitess_sqlparser_test.go:59: visitor: {
"TableName": "Persons",
"Columns": [
"DateOfBirth",
"ID"
]
}
vitess_sqlparser_test.go:64: drop columns [DateOfBirth ID] at table Persons
--- PASS: TestParseDropColumn (0.00s)
PASS
通过解析之后，就能够提取出来ALTER的表Persons以及DROP的列DateOfBirth跟ID，也就确定了这是一个删除列的操作。
可以看到，sql解析器本身是非常强大灵活的。通过我们自定义一些逻辑规则，能很方便的检查sql的合法性跟风险性。
