0

0

SQL格式化:Go语言中实现SQL语句结构化排版的正确路径

碧海醫心

碧海醫心

发布时间:2026-01-13 10:13:12

|

849人浏览过

|

来源于php中文网

原创

SQL格式化:Go语言中实现SQL语句结构化排版的正确路径

go中对sql字符串进行可读性格式化(如关键字大写、换行缩进)不能依赖简单字符串分割,而应基于语法解析——推荐使用成熟sql解析器(如vitess/sqlparser)并自定义输出逻辑,兼顾准确性与可维护性。

对SQL语句进行格式化看似是简单的文本处理任务,但实际涉及词法分析、语法结构识别和嵌套层级管理。例如将:

select col1, col2, col3 from foo where col1 > 1000 and col2 < 2000

转换为:

SELECT col1, col2, col3 
FROM foo 
WHERE col1 > 1000 
    AND col2 < 2000

若仅靠strings.Split() + 关键字匹配(如"select"→"SELECT\n"),会面临诸多陷阱:

  • 关键字大小写混用(SELECT vs select vs SeLeCt);
  • 字符串字面量或注释中误匹配(如'select * from users');
  • 嵌套结构无法识别缩进层级(如BEGIN ... SELECT ... END中的多层IF-BEGIN嵌套);
  • 运算符(AND/OR)需根据上下文决定是否换行+缩进,而非机械前置。

✅ 正确做法:使用语法感知的SQL解析器
vitess/go/vt/sqlparser 是目前Go生态中最成熟、生产验证过的SQL解析库,支持MySQL语法(兼容大部分标准SQL),可准确提取AST(抽象语法树),从而安全地重构格式:

喵记多
喵记多

喵记多 - 自带助理的 AI 笔记

下载

立即学习go语言免费学习笔记(深入)”;

import (
    "fmt"
    "github.com/vitessio/vitess/go/vt/sqlparser"
)

func formatSQL(sql string) (string, error) {
    stmt, err := sqlparser.Parse(sql)
    if err != nil {
        return "", err
    }

    // 自定义格式化器:遍历AST,按节点类型插入换行/缩进/大写
    var buf strings.Builder
    indent := 0

    formatNode(stmt, &buf, &indent)
    return buf.String(), nil
}

func formatNode(node sqlparser.SQLNode, buf *strings.Builder, indent *int) {
    switch n := node.(type) {
    case *sqlparser.Select:
        buf.WriteString("SELECT ")
        // ... 处理SelectExprList、From、Where等子节点,递增indent
    case *sqlparser.Where:
        fmt.Fprintf(buf, "\n%*sWHERE ", *indent*4, "")
        *indent++
        sqlparser.String(n.Expr, buf)
        *indent--
    case *sqlparser.AndExpr:
        fmt.Fprintf(buf, "\n%*sAND ", *indent*4, "")
        // 递归格式化左右表达式
    }
}

⚠️ 注意事项:

  • 不要自行正则替换:(?i)\b(select|from|where)\b 类模式在真实SQL中极易误伤(如列名select_id、注释-- select all);
  • 缩进需语义驱动:AND是否换行取决于其是否位于WHERE子句顶层,而非单纯出现位置;
  • 嵌套块需式缩进:BEGIN/END、IF/ELSE 等需维护缩进深度栈,而非静态Tab计数;
  • 兼容性权衡:vitess默认适配MySQL,若需PostgreSQL/SQL Server语法,需评估pglogreplpq的解析能力,或切换至通用解析器如sqlparser-go

总结:SQL格式化本质是编译器前端问题,而非字符串处理。在Go项目中,应优先集成健壮的SQL解析器,并在其AST基础上构建可扩展的格式化逻辑——这虽比正则方案初期成本略高,却能彻底规避语法歧义、保障长期可维护性,并为后续SQL审计、重写、权限校验等功能奠定基础。

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

676

2023.10.12

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

320

2023.10.27

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

346

2024.02.23

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

1094

2024.03.06

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

357

2024.03.06

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

675

2024.04.07

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

571

2024.04.29

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

414

2024.04.29

PHP 表单处理与文件上传安全实战
PHP 表单处理与文件上传安全实战

本专题聚焦 PHP 在表单处理与文件上传场景中的实战与安全问题,系统讲解表单数据获取与校验、XSS 与 CSRF 防护、文件类型与大小限制、上传目录安全配置、恶意文件识别以及常见安全漏洞的防范策略。通过贴近真实业务的案例,帮助学习者掌握 安全、规范地处理用户输入与文件上传的完整开发流程。

3

2026.01.13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
MySQL 教程
MySQL 教程

共48课时 | 1.7万人学习

MySQL 初学入门(mosh老师)
MySQL 初学入门(mosh老师)

共3课时 | 0.3万人学习

简单聊聊mysql8与网络通信
简单聊聊mysql8与网络通信

共1课时 | 787人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号