클린 코드와 리팩토링 (Clean Code and Refactoring)

클린 코드(Clean Code)는 다른 사람이 읽고 이해하고 수정하기 쉬운 코드를 말하며, 리팩토링(Refactoring)은 겉으로 드러나는 동작을 바꾸지 않으면서 코드의 내부 구조를 개선하는 활동이다. 클린 코드가 지향점이라면 리팩토링은 이미 있는 코드를 그 지향점으로 옮겨 가는 구체적인 수단이다. 코드는 쓰는 시간보다 읽히는 시간이 훨씬 길기 때문에, 두 가지 모두 장기적인 개발 생산성을 좌우한다.

클린 코드의 핵심 원칙

클린 코드의 기준은 결국 읽는 사람의 인지 부담을 줄이는 데 있다. 실무에서 통용되는 원칙을 추리면 다음과 같다.

• 의도가 드러나는 이름을 쓴다. 변수 d보다 elapsedDays가 낫고, 함수 이름만 보고 무엇을 하는지 짐작할 수 있어야 한다.
• 함수는 작게 만들고 한 가지 일만 하게 한다. 추상화 수준이 섞인 긴 함수는 읽는 사람이 머릿속에서 다시 분해해야 한다.
• 주석보다 코드로 설명한다. 코드가 무엇을 하는지 설명하는 주석은 코드를 고치라는 신호이고, 주석은 왜 그렇게 했는지 같은 코드로 표현할 수 없는 맥락에 쓴다.
• 중복을 제거한다. 같은 지식이 두 곳에 있으면 한 곳만 고쳐지는 버그가 생긴다. 이를 DRY(Don't Repeat Yourself) 원칙이라 부른다.
• 보이스카우트 규칙(Boy Scout Rule)을 따른다. 코드를 처음 봤을 때보다 조금이라도 깨끗하게 만들고 떠나면, 큰 결단 없이도 코드베이스가 점진적으로 좋아진다.

코드 스멜: 리팩토링이 필요하다는 신호

코드 스멜(Code Smell)은 당장 버그는 아니지만 설계에 문제가 있음을 암시하는 징후다. 대표적인 예는 다음과 같다.

• 긴 함수와 거대한 클래스: 하나의 단위가 너무 많은 책임을 진다.
• 긴 매개변수 목록: 함께 다니는 값들이 객체로 묶이지 못했다는 신호다.
• 산탄총 수술(Shotgun Surgery): 하나의 변경을 위해 여러 파일을 조금씩 고쳐야 한다.
• 기능 욕심(Feature Envy): 어떤 메서드가 자기 클래스보다 다른 클래스의 데이터에 더 관심이 많다.
• 기본 타입 집착과 매직 넘버: 의미 있는 개념이 이름 없는 숫자와 문자열로 흩어져 있다.

대표적인 리팩토링 기법

리팩토링은 감이 아니라 이름 붙은 기법의 목록이다. 가장 자주 쓰는 것은 함수 추출(Extract Function), 변수 추출(Extract Variable), 이름 바꾸기(Rename), 조건문을 다형성으로 바꾸기, 매개변수 객체 도입 등이다. 다음은 함수 추출과 조기 반환(Early Return)을 적용한 예다.

// 리팩토링 전
function price(order) {
  let t = 0;
  for (const i of order.items) {
    t += i.qty * i.unitPrice;
  }
  if (order.coupon != null && order.coupon.rate > 0) {
    t = t - t * order.coupon.rate;
  }
  return t;
}

// 리팩토링 후
function price(order) {
  const subtotal = calculateSubtotal(order.items);
  return applyCoupon(subtotal, order.coupon);
}

function calculateSubtotal(items) {
  return items.reduce((sum, item) => sum + item.qty * item.unitPrice, 0);
}

function applyCoupon(amount, coupon) {
  if (coupon == null || coupon.rate <= 0) return amount;
  return amount * (1 - coupon.rate);
}

동작은 같지만 각 함수가 하나의 개념을 담고, 이름이 계산의 의도를 설명한다. 할인 정책이 바뀌어도 수정 범위가 applyCoupon 하나로 좁혀진다.