Good SQL code formatting is not just about aesthetics — it's about code quality, team collaboration, and long-term maintainability. This article summarizes 10 SQL formatting best practices, covering naming conventions, indentation rules, comment standards, and more to help you write more professional, maintainable SQL code.

Whether you're a database developer, data analyst, or DBA, mastering these best practices will significantly boost efficiency, reduce bugs, and make team collaboration smoother.

1关键字统一大写

SQL 关键字（SELECT、FROM、WHERE 等）统一使用大写，可以让代码结构一目了然，与表名、列名等标识符形成明显对比。

select name, email
from users
where status='active'

SELECT name, email
FROM users
WHERE status = 'active'

2每个 SELECT 列独立一行

将 SELECT 子句中的每个列名放在单独一行，便于阅读、修改和代码审查。长查询中尤其重要。

SELECT id, name, email, phone, address, city FROM users

SELECT
    id,
    name,
    email,
    phone,
    address,
    city
FROM users

好处：容易添加/删除列，Git diff 更清晰，注释单个列也更方便。

3使用一致的缩进（2 或 4 空格）

选择 2 空格或 4 空格作为缩进标准，团队统一即可。避免混用 Tab 和空格。

SELECT
    u.name,
    COUNT(o.id) AS order_count
FROM users u
LEFT JOIN orders o
    ON u.id = o.user_id
WHERE u.status = 'active'
GROUP BY u.name
HAVING COUNT(o.id) > 5
ORDER BY order_count DESC

4操作符两侧加空格

在 =、>、+ 等操作符两侧添加空格，提高可读性。

WHERE age>18 AND score>=80

WHERE age > 18 AND score >= 80

5使用有意义的别名

表别名和列别名应当简洁且有意义，避免使用 t1、col1 等无意义名称。

SELECT
    t1.col1,
    t2.col2
FROM table1 t1
JOIN table2 t2
    ON t1.id = t2.fk

SELECT
    u.name AS user_name,
    o.total AS order_total
FROM users u
JOIN orders o
    ON u.id = o.user_id

常见约定：users → u, orders → o, products → p。团队内保持一致即可。

6子查询合理缩进

子查询应当增加一层缩进，清晰反映层级关系。复杂嵌套时更为重要。

SELECT
    u.name,
    u.email,
    (
        SELECT COUNT(*)
        FROM orders o
        WHERE o.user_id = u.id
            AND o.status = 'completed'
    ) AS completed_orders
FROM users u
WHERE u.created_at > (
    SELECT MIN(created_at)
    FROM users
    WHERE region = 'CN'
)

7添加必要的注释

复杂逻辑、业务规则、临时解决方案等都应当添加注释说明。但避免过度注释显而易见的代码。

-- 获取活跃用户的订单统计
-- 活跃定义：30天内有登录记录
SELECT
    u.name,
    COUNT(o.id) AS order_count,
    SUM(o.total) AS total_amount
FROM users u
LEFT JOIN orders o
    ON u.id = o.user_id
    AND o.created_at > NOW() - INTERVAL 30 DAY  -- 仅统计近30天订单
WHERE u.last_login_at > NOW() - INTERVAL 30 DAY
GROUP BY u.name
HAVING order_count > 0  -- 排除没有订单的用户

注释规范：单行用 --，多行用 /* */。

8避免 SELECT *

明确列出需要的列，而不是使用 SELECT *。这能提高性能、可读性和维护性。

SELECT * FROM users

SELECT id, name, email, created_at FROM users

9使用 CTE 代替复杂嵌套

对于复杂查询，使用 CTE（Common Table Expression，WITH 子句）可以让代码更清晰、更易维护。

SELECT *
FROM (
  SELECT *
  FROM (
    SELECT ...
    FROM users
  ) t1
  WHERE ...
) t2
WHERE ...

WITH active_users AS (
    SELECT ...
    FROM users
    WHERE status = 'active'
),
user_orders AS (
    SELECT ...
    FROM orders
)
SELECT *
FROM active_users au
JOIN user_orders uo
    ON au.id = uo.user_id

10制定并遵守团队规范

以上 9 条是通用最佳实践，但最重要的是团队内部保持一致。建议：

• 制定团队 SQL 编码规范文档，涵盖格式、命名、注释等
• 使用自动化工具（如 SQLNice、SQL Formatter）强制执行格式
• 在 Code Review 中检查 SQL 代码质量
• 集成到 CI/CD 流程，提交前自动格式化
• 定期回顾和更新规范，保持与时俱进

⚠️常见错误与解决方案

📚总结

SQL 格式化最佳实践的核心是可读性、一致性和可维护性。本文介绍的 10 个技巧涵盖了格式化的各个方面：

Remember: tools are just aids, standards are key. Using automated tools like SQLNice saves time, but maintaining consistent coding habits within your team matters more.