Refactoring - cleancodeclass/cleancode_theory GitHub Wiki

Refactoring 이란 무엇인가?

• 기능은 그대로 동작하도록 두고, 소프트웨어 내부를 수정하는 작업
  • 제대로 실행되나 구조가 완전하지 못한 코드를 대상으로 작업
  • 코드를 이해하고 수정하기 더 쉽도록 소프트웨어 내부를 변경
  • 겉으로 드러나는 기능에는 영향을 주지 않음
  • 기능이 변하지 않는다는 것을 증명해주는 테스트 코드가 반드시 필요!

왜 Refactoring을 하는가?

• 소프트웨어 설계가 개선되니까 : 중복된 코드가 없어지면서 설계가 개선된다.
• 소프트웨어 이해가 더 쉬워지니까 : 코드가 깔끔해져 빠르게 파악하고 수정할 수 있다.
• 버그를 찾기가 더 쉬워지니까 : 프로그램 구조의 단순∙명료화로 버그 원인을 쉽게 찾는다.
• 프로그래밍 속도가 빨라지니까 : 깔끔한 설계로 소프트웨어 개발속도가 높아진다.

언제 리팩토링을 하는가?

• 작정하고 따로 시간을 내서 하는 것이 아닌 일상적으로 하는 것이 좋다.
  • 기능을 추가할 때
  • 버그를 수정할 때
  • 코드리뷰를 할 때
• 개발 중에 능률을 높이기 위해서 틈틈히 하는 것이다.
  • 코드를 알아보기 힘들 때
  • 중복된 로직이 들어있을 때
  • 추가 기능을 넣어야 해서 레거시 코드를 변경해야 할 때
  • 조건문 구조가 복잡할 때

리팩토링 방법

• Find some code that “smells”
• Determine how to simplify this code
• Make the simplifications
• Run tests to ensure things still work correctly
• Repeat the simplify/test cycle until the smell is gone

코드 스멜(Code Smell)

• 코드에서 더 심오한 문제를 일으킬 가능성이 있는 프로그램 소스 코드의 증상
  • 코드 스멜인지 아닌지의 여부를 결정하는 일은 주관적인 것
  • 언어와 개발자, 개발 방법에 따라 다양함
  • 코드 스멜을 확인하기 위한 다양한 도구들이 있음 (PMD, FindBugs 등)

• 메서드 추출
  • 코드를 메서드로 빼낸다.
  • 메서드가 너무 길거나 코드에 주석을 달아야만 의도를 이해할 수 있을 때
  • 메서드의 이름은 코드의 목적을 나타내는 직관적인 이름의 메서드여야 한다.

• 조건문 쪼개기
  • if, then, else 부분을 각각 메서드로 빼낸다.

• 매개변수 세트를 메서드로 전환
  • 매개변수를 없애고 직접 메서드를 호출하도록 수정한다.
  • 매개변수를 전달하는 메서드를 전달받는 쪽에서도 호출할 수 있을 때
  • 호출한 메서드의 매개변수가 계산에 사용될 땐 삭제할 수 없다.
• 객체를 통째로 전달
  • 매개변수를 객체로 전달해 매개변수를 줄인다.
  • 객체에서 가져온 여러 값을 매개변수로 전달할 때 객체를 통째로 전달하도록 수정한다.
  • 매개변수가 많아지면 코드가 복잡해지므로 가능한 줄여야 한다. 단, 전달되는 객체와 의존성이 강화되므로 주의해야 한다.
• 매개변수 세트를 객체로 전환
  • 늘 함께 전달되는 매개변수 뭉치를 객체로 전달하도록 수정한다.
  • 매개변수 세트가 짧게 줄어서 코드가 간결해진다.
  • 반복되는 관련 기능을 새로운 클래스로 옮겨 코드 중복을 없앨 수 있다.

• 클래스 추출
  • 클래스의 일부를 떼내어 새로운 클래스로 만든다.
  • 개발하면서 클래스는 기능 추가로 점차 방대해진다.
  • 여러 클래스가 처리해야 할 기능이 하나의 클래스에 들어있을 때

• 메서드 이동(Move Method)
  • 메서드를 다른 클래스로 이동하는 기법
  • 메서드가 자신의 클래스보다 다른 클래스의 기능을 더 많이 이용할 때
  • 클래스에 기능이 너무 많거나 클래스가 의존성이 지나칠 때
• 필드 이동(Move Field)
  • 클래스 내의 필드를 다른 클래스로 옮긴다.
  • 자신이 속한 클래스보다 다른 클래스에서 더 많이 사용될 때
• 클래스 내용 직접 삽입(Inline Class)
  • 클래스의 모든 기능을 다른 클래스로 합쳐 넣는다.
  • 클래스 추출 (Extract Class)과 반대되는 개념
  • 클래스의 기능 대부분을 이동시켜 남은 기능이 거의 없을 때
  • 해당 클래스를 가장 많이 사용하는 다른 클래스를 하나 골라서 합친다.

• Replace Type Code with State / Strategy
  • 분류 부호를 상태/ 전략 패턴으로 전환
  • 상태 / 전략 패턴을 이용해서 분류 기호를 없애는 기법
  • 분류 부호를 하위클래스로 전환 (with Subclasses)과 비슷한 기법
  • 분류 부호가 객체 수명주기 동안 변할 때나 하위 클래스를 만들 수 없는 경우 사용

간단한 Cleancode Refactoring 사례?