SQL 代码格式化是每个数据库开发者、数据分析师和 DBA 必备的技能。格式化良好的 SQL 代码不仅提高可读性，还能减少错误、便于团队协作、加速问题排查。本文将详细介绍 5 种格式化 SQL 代码的实用方法，从在线工具到本地 IDE，从图形界面到命令行，总有一种适合你。

无论你使用 MySQL、PostgreSQL、Oracle 还是 SQL Server，这些方法都能帮助你快速美化 SQL 代码，让混乱的查询语句变得清晰易读。

📌为什么需要格式化 SQL 代码？

在深入了解具体方法之前，让我们先理解格式化 SQL 的重要性：

• 提高可读性：格式化后的代码结构清晰，关键字对齐，逻辑一目了然
• 减少错误：规范的格式能帮助发现语法错误、括号不匹配等问题
• 便于协作：团队成员遵循统一格式标准，代码审查更高效
• 加速调试：格式化的 SQL 让子查询、JOIN、嵌套逻辑更容易理解
• 符合规范：遵循 SQL 编码规范，提升代码专业度

🛠️方法2: MySQL Workbench 自动格式化

如果你使用 MySQL 数据库，那么官方提供的 MySQL Workbench 是一个强大的数据库管理工具，内置了 SQL 格式化功能。

使用方法

1. 打开 MySQL Workbench

   启动 Workbench 并连接到你的 MySQL 数据库

2. 打开 SQL 编辑器

   创建新查询标签页或打开现有 SQL 文件

3. 选择要格式化的代码

   选中需要格式化的 SQL 代码（或全选 Ctrl+A）

4. 执行格式化

   菜单栏选择 Edit → Format → Beautify Query

   或使用快捷键：Ctrl + B（Windows）或 Cmd + B（Mac）

优缺点

🧩方法3: VS Code 插件（SQL Formatter）

对于使用 Visual Studio Code 的开发者，安装 SQL 格式化插件是最便捷的选择。推荐两款优秀插件：

推荐插件

安装和使用

1. 安装插件

   在 VS Code 中按 Ctrl + Shift + X，搜索"SQL Formatter"并安装

2. 打开 SQL 文件

   创建或打开 .sql 文件

3. 格式化代码

   右键点击代码 → 选择"Format Document"

   或使用快捷键：Shift + Alt + F（Windows）或 Shift + Option + F（Mac）

4. 自定义配置（可选）

   在 settings.json 中配置格式化选项

配置示例

{
  "sql-formatter.dialect": "mysql",
  "sql-formatter.uppercase": true,
  "sql-formatter.linesBetweenQueries": 2,
  "sql-formatter.indent": "  "
}

优缺点

⌨️方法4: 命令行工具（sql-formatter-cli）

对于需要批量处理或集成到自动化流程的场景，命令行工具是最佳选择。推荐使用 sql-formatter-cli。

安装

使用 npm 全局安装：

npm install -g sql-formatter-cli

或使用 yarn：

yarn global add sql-formatter-cli

使用方法

sql-formatter -i query.sql -o formatted.sql

sql-formatter -i query.sql --write

find ./sql -name "*.sql" -exec sql-formatter -i  --write \;

sql-formatter -i query.sql --language mysql --uppercase --indent "  "

集成到 Git Hook

在 .git/hooks/pre-commit 中添加：

#!/bin/bash
for file in $(git diff --cached --name-only | grep -E '\.sql$'); do
  sql-formatter -i "$file" --write
  git add "$file"
done

这样每次 commit 前会自动格式化 SQL 文件。

优缺点

🔧方法5: 自定义 Python 脚本（sql-formatter 库）

如果你需要完全控制格式化逻辑或集成到 Python 项目中，可以使用 sqlparse 库编写自定义脚本。

安装

pip install sqlparse

示例代码

import sqlparse

# 读取 SQL 文件
with open('query.sql', 'r', encoding='utf-8') as f:
    sql = f.read()

# 格式化
formatted_sql = sqlparse.format(
    sql,
    reindent=True,           # 重新缩进
    keyword_case='upper',    # 关键字大写
    identifier_case='lower', # 标识符小写
    indent_width=4,          # 缩进宽度
    use_space_around_operators=True  # 操作符周围加空格
)

# 保存格式化后的结果
with open('formatted.sql', 'w', encoding='utf-8') as f:
    f.write(formatted_sql)

print("格式化完成！")

批量处理脚本

import sqlparse
import os
import glob

def format_sql_files(directory):
    """批量格式化目录下所有 SQL 文件"""
    for sql_file in glob.glob(os.path.join(directory, '**/*.sql'), recursive=True):
        print(f"格式化: {sql_file}")

        with open(sql_file, 'r', encoding='utf-8') as f:
            sql = f.read()

        formatted = sqlparse.format(
            sql,
            reindent=True,
            keyword_case='upper',
            indent_width=2
        )

        with open(sql_file, 'w', encoding='utf-8') as f:
            f.write(formatted)

    print("所有文件格式化完成！")

# 使用
format_sql_files('./sql_queries')

优缺点

📊5种方法对比总结

💡SQL 格式化最佳实践

❓常见问题 FAQ

🎯总结

本文详细介绍了 5 种格式化 SQL 代码的方法，从在线工具到本地 IDE，从图形界面到命令行，覆盖了各种使用场景：

• 快速格式化：使用 SQLNice 在线工具，免费且支持子查询识别
• MySQL 用户：使用 MySQL Workbench 的内置格式化功能
• VS Code 开发者：安装 SQL Formatter 插件，集成到开发流程
• 自动化场景：使用命令行工具，集成到 CI/CD 或 Git Hook
• 定制化需求：编写 Python 脚本，完全控制格式化逻辑

无论你选择哪种方法，重要的是养成格式化 SQL 代码的习惯。清晰的代码结构不仅提升个人效率，更能促进团队协作，减少 bug，让数据库开发工作更加顺畅。