SQL 代码最佳实践

提升 SQL 代码可读性和维护性的通用建议

SQL 代码格式化最佳实践

1. 关键字大写

将 SQL 关键字大写可以提高代码可读性,使关键字与标识符明显区分。

-- Recommended
SELECT id, name FROM users WHERE status = 'active';

-- Not recommended
select id, name from users where status = 'active';

2. 合理使用缩进

对于复杂查询,将每个子句放在新行并使用缩进,使结构更清晰。

SELECT
  u.id,
  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.id,
  u.name
ORDER BY order_count DESC;

3. 使用有意义的别名

表别名和列别名应该简洁但有意义,避免使用单字母别名(除非是常见约定)。

-- Recommended
SELECT
  user.id,
  user.name,
  order.total_amount
FROM users user
  JOIN orders order ON user.id = order.user_id;

-- Not recommended
SELECT a.id, a.name, b.total_amount
FROM users a JOIN orders b ON a.id = b.user_id;

4. 对齐列名

在 SELECT 语句中对齐列名可以提高可读性。

SELECT
  id          AS user_id,
  name        AS user_name,
  email       AS user_email,
  created_at  AS registration_date
FROM users;

5. 保持一致性

在整个项目或团队中保持一致的格式化风格,可以使用我们的工具来标准化 SQL 代码格式。

SQL代码最佳实践 - SQL格式化工具 | SQL格式化工具