💡 SQL 가독성을 극대화하는 코드 스타일 가이드🖋️

💡 SQL 가독성을 극대화하는 코드 스타일 가이드 🖋️

SQL 가독성

 

✨ 가독성을 높이는 SQL 작성법: 작은 습관으로 큰 차이를 만들자! 💻

SQL을 작성할 때, 코드의 가독성은 협업과 유지보수의 핵심입니다. 간단한 습관만으로도 코드가 더 읽기 쉽고 관리하기 쉬워집니다. 아래는 SQL 가독성을 높이는 4가지 실전 팁과 예제입니다! 🌟

---

1️⃣ 예약어는 대문자로 작성하자

SQL의 SELECT, FROM, WHERE 같은 예약어는 대문자로 작성하는 것이 기본입니다. 대문자로 작성하면 구조가 더 명확해지고, 코드를 빠르게 읽을 수 있습니다.

-- ✅ 가독성 좋은 코드 예
SELECT customer_name,  
       customer_address,  
       order_date  
  FROM orders  
 WHERE order_status = 'Completed'  
 ORDER 
    BY order_date DESC;  

-- 🚫 가독성 나쁜 예
select name, address from station limit 10;

대문자로 작성된 코드는 예약어가 눈에 잘 띄어, 전체 구조를 쉽게 파악할 수 있습니다.

---

2️⃣ 행갈이로 코드 구조를 명확히 드러내자

SQL은 행갈이를 통해 절별로 구분할 수 있습니다. 특히 SELECT, FROM, GROUP BY 등 주요 절마다 새 줄을 추가하면 가독성이 극대화됩니다.

-- ✅ 가독성 좋은 코드 예
SELECT product_id,  
       product_name,  
       SUM(sales_amount) AS total_sales  
  FROM sales  
 WHERE sales_date BETWEEN '2024-01-01' AND '2024-12-31'  
 GROUP 
    BY product_id, product_name  
HAVING SUM(sales_amount) > 1000  
 ORDER 
    BY total_sales DESC;  

-- 🚫 가독성 나쁜 예
SELECT name, address FROM station LIMIT 10;

Tip: 코드가 길어질수록 절마다 행갈이를 적극적으로 활용하세요. 한눈에 코드의 흐름을 파악할 수 있습니다. 👀

---

3️⃣ 주석은 친절하고 상세하게 작성하자 📝

주석은 코드의 의도와 작동 방식을 설명하는 중요한 도구입니다. 특히, What, Why, How의 관점에서 주석을 작성하면 코드 이해도가 높아집니다.

-- 🛍️ 이 쿼리는 2024년 서울에 위치한 상점들의 총 매출을 집계합니다.
SELECT store_name,  
       store_location,  
       SUM(sales_amount) AS total_sales  
  FROM store_sales  
 WHERE city = 'Seoul'                -- 서울에 위치한 상점만 선택  
   AND sales_date BETWEEN '2024-01-01' AND '2024-12-31'  -- 2024년 데이터만 포함  
 GROUP 
    BY store_name, store_location  -- 상점 이름과 위치별로 그룹화  
 ORDER 
    BY total_sales DESC;          -- 매출 순으로 정렬

---

4️⃣ Alias를 의미 있게 짓자

Alias(별칭)는 간결하고 의미 있게 작성해야 코드의 맥락을 쉽게 파악할 수 있습니다.

-- 🚫 나쁜 예
SELECT t1.name, t2.sales  
  FROM customers t1  
  JOIN orders t2 ON t1.id = t2.customer_id;

-- ✅ 좋은 예
SELECT customer.name, order.sales  
  FROM customers AS customer1  
  JOIN orders AS order1 
    ON customer.id = order.customer_id;

의미 있는 Alias는 코드의 가독성과 유지보수성을 크게 향상시킵니다.

---

🎯 SQL 작성 팁 요약

1️⃣ 예약어는 대문자로: 코드 구조를 한눈에 파악 가능.
2️⃣ 행갈이 활용: 절마다 새 줄로 가독성 강화.
3️⃣ 주석 작성: What, Why, How 관점으로 설명 추가.
4️⃣ Alias는 의미 있게: 코드의 맥락을 쉽게 전달.

작은 습관의 변화가 큰 결과를 만듭니다. 오늘부터 여러분의 SQL 코드를 더 깔끔하고 멋지게 작성해 보세요! 🚀