SQL 잘 쓰는 방법 | 가독성과 유지보수를 고려한 실용 가이드

 

SQL을 작성할 때 가독성과 유지보수를 고려하는 것이 매우 중요합니다. 현업에서 가독성을 고려하지 않은 쿼리문을 마주한다면... 유지보수 과정에서 크게 스트레스를 받곤 합니다. (물론 누가 이렇게 제멋대로 쿼리를 짰어 투정부리며 Git Blame을 눌렀을 때 과거의 나일 경우도 있습니다.)

 

잘 정리된 SQL은 팀원들과 협업할 때도 도움이 되고, 추후 수정할 때도 수월합니다. 이번 글에서는 SQL 쿼리를 잘 쓰는 방법에 대해 정리해보겠습니다.

1. 주석을 잘 남기자 📝

SQL을 작성할 때 주석을 적극적으로 활용하면, 나중에 다시 볼 때 코드의 목적을 쉽게 이해할 수 있습니다.

주석을 다는 방법:

• 한 줄 주석: -- 를 사용합니다.
• 여러 줄 주석: /* */ 를 사용합니다.

-- 활성 사용자 목록 조회
SELECT user_id, user_name FROM users WHERE status = 'active';

/*
최근 30일 이내 주문한 사용자 목록 조회
주문이 존재하는 사용자만 출력
*/
SELECT u.user_id, u.user_name
FROM users u
JOIN orders o ON u.user_id = o.user_id
WHERE o.created_at >= NOW() - INTERVAL 30 DAY;

2. SQL 키워드는 대문자로 쓰자 🔠

SQL 키워드는 대문자로 작성하는 것이 일반적인 스타일 가이드입니다. 이렇게 하면 SQL 문법과 테이블/컬럼명을 쉽게 구분할 수 있습니다.

-- ❌ 잘못된 예시
select user_id, user_name from users where status = 'active';

-- ✅ 올바른 예시
SELECT user_id, user_name FROM users WHERE status = 'active';

3. SQL 키워드 위주로 행을 나누자 📏

SQL을 작성할 때 주요 키워드(SELECT, FROM, WHERE 등) 기준으로 줄바꿈을 하면 가독성이 좋아집니다.

-- ❌ 가독성이 낮은 코드
SELECT user_id, user_name FROM users WHERE status = 'active' AND created_at >= '2024-01-01';

-- ✅ 가독성이 좋은 코드
SELECT
    user_id,
    user_name
FROM
    users
WHERE
    status = 'active'
    AND created_at >= '2024-01-01';

이렇게 정리하면 가독성이 훨씬 향상되고, 유지보수하기 쉬워집니다.

4. AS(Alias)를 잘 쓰자 🔄

테이블과 컬럼에 별칭(Alias, AS) 을 잘 사용하면 가독성이 좋아집니다.

--올바른 별칭 사용 예시
SELECT
    u.user_id AS id,
    u.user_name AS name,
    o.order_id AS order_id,
    o.total_price AS price
FROM users AS u
JOIN orders AS o ON u.user_id = o.user_id
WHERE o.status = 'completed';

• users AS u → 테이블 users에 u라는 짧고 직관적인 별칭 사용
• user_id AS id → 컬럼명을 명확하게 정리

주의할 점:

• 테이블 별칭은 짧고 명확하게! (users AS u, orders AS o)
• 컬럼 별칭은 의미를 유지하면서 간결하게! (total_price AS price)

5. SELECT * 사용을 지양하자 🚫

SELECT *는 모든 컬럼을 조회하는 SQL 문법이지만, 불필요한 트래픽 사용방지 및 명확한 명시를 위해 사용을 피하는 것이 좋습니다.

SELECT *를 사용하면 안 되는 이유

1. 불필요한 데이터 조회 → 네트워크 트래픽 증가
2. 명확성이 부족함 → 어떤 컬럼이 조회되는지 알기 어려움
3. 스키마 변경 시 문제 발생 → 새로운 컬럼이 추가되면 예상치 못한 에러 가능

-- ❌ SELECT * 사용 (좋지 않은 예시)
SELECT * FROM users;

-- ✅ 필요한 컬럼만 명확하게 지정 (좋은 예시)
SELECT user_id, user_name, email FROM users;

이렇게 하면 성능도 향상되고 유지보수도 편해집니다.

정리: SQL을 잘 쓰는 5가지 원칙

1. 주석을 잘 남기자
2. SQL 키워드는 대문자로 쓰자
3. SQL 키워드 위주로 행을 나누자
4. AS(Alias)를 잘 쓰자
5. SELECT * 사용을 지양하자

이 원칙들을 따르면 SQL 코드가 훨씬 읽기 쉽고 유지보수하기 쉬워집니다! 🚀

이제부터 SQL을 작성할 때 위의 가이드를 참고 삼아 실천해보세요~