아티클 스터디 [SQL 가독성을 높이는 다섯 가지 사소한 습관]

https://yozm.wishket.com/magazine/detail/1519/

SQL 가독성을 높이는 다섯 가지 사소한 습관 | 요즘IT

 

아티클 요약 및 주요 내용

• 요약
  • 가독성 있는 SQL 코드 작성을 위한 다섯 가지 습관
• 주요 포인트: 예약어는 대문자, 행갈이, 주석, Alias
  • 예약어는 대문자로 작성: SQL 언어를 지원하는 에디터 사용하면 예약어를 컬럼이나 테이블 이름과는 다른 색으로 강조해주기는 하지만 데이터마다 규칙도 다르고, DB 종류마다 함수들 이름도 다르기 때문에 제대로 강조되지 않은 경우가 많다. 그래서 예약어, 함수 이름 등은 대문자로 써주는 습관을 들여 자신이 쓴 코드를 구분
  • 행갈이를 자주 하자: SELECT, FROM, GROUP BY와 같이 한 라인에 다른 절이 있는 코드는 작성할 때는 편하겠지만, 나중에 그 의미를 파악하기 위해 모든 코드를 다 읽어야 해서 번거롭다. 하지만 한 라인에 하나의 절만 작성하면 각 라인의 예약어만 확인해도 작성자의 의도와 코드 구조를 쉽게 파악 가능
  • 행갈이를 더 자주 하자: AND, OR이 붙을 때마다 행갈이를 해주면 가끔 쿼리를 쓸 때 어떤 로직을 제외했다가 다시 포함해야 하는 경우에  효과적
  • 주석을 쓰자: 코드를 쓴 의도를 짧게 적어 놓는 습관을 들여야 서브쿼리가 많아지고 코드가 길어질 경우 각 코드 단락이 어떤 의도로 작성되었는지 그 코드를 읽었을 때 이해가 쉽다.
    • 작성 방법
      • 서브 쿼리의 단위로 의미를 작성
      • 조건에 적는 주석의 경우, 단순히 "이 조건은 이거다"라고 서술하는 것은 의미가 없다. 그러나 컬럼 이름만 보고 해석에 오해가 생길 수 있거나, 추가 설명이 필요한 경우에는 작성
      • 조건이 왜 필요한지, 어떻게 동작하는지 같은 내용을 자세하게 작성해 놓으면 다음에 코드를 이해하는데 도움이 된다Alias를 잘 쓰자: 서브쿼리, 컬럼 Alias를 대충 작성하면 안 된다. 구글에 '변수명 짓기 팁'을 검색해 이용
  • 가장 중요한 건 합의된 규칙: 가장 중요한 것은 같이 일하는 사람들과의 합의된 규칙이다. 아무리 좋은 방법이라도 팀에서 사용하고 있는 컨벤션에 위배된다면, 기존 구성원들을 설득하고 레거시 코드들을 죄다 바꾸는 수고를 하지 않는 한 일단 기존 제도를 따라야 한다.

 

핵심 개념 및 용어 정리

• 핵심 개념
  • 예약어, 행갈이, 주석, Alias, 규칙
• 용어 정리
  • 레거시 코드: 더 이상 쓰기 힘들고 정상적이지 않는 난해한 코드