[우아한테크세미나] 리팩토링 정리 (By 자바지기 박재성님)

• 안녕하세요~ 이전에 운영하던 블로그 및 GitHub, 공부 내용을 정리하는 Study-GitHub 가 있습니다!

• 네이버 블로그

• GitHub

• Study-GitHub

• 🐔

---

✔ 우아한테크세미나 190425 TDD 리팩토링 by 자바지기 박재성님

https://youtu.be/bIeqAlmNRrA

 

안녕하세요! 이번에 정말 좋은 강의를 보게 되어서 정리하고자 글을 쓰려고 합니다!

​

본 강의는 TDD, 리팩토링 연습방법에 대한 강의이지만 저는 리팩토링에 대해 정리를 해보았습니다.

​

영상에서 앞 내용인 1~2단계는 TDD에 대한 내용이고, 3단계부터 리팩토링과 관련된 내용입니다.

​

​

리팩토링과 관련한 제약사항, 방법은 다음과 같습니다.

• Java Code Convention을 지키면서 프로그래밍을 한다. • Indent(들여쓰기) depth를 3이 넘지 않도록 구현한다.(2까지만 허용)     • 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.     • 힌트: Indent(들여쓰기) depth를 줄이는 가장 좋은 방법은 함수(또는 메서드)를 분리하면 된다. • 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라. • 함수(또는 메서드)의 길이가 15라인을 넘어가지 않도록 구현한다. => 한 가지 일만 잘하도록 구현. • else 예약어를 쓰지 않는다. • if 조건절에서 값을 return 하도록 구현하면 else를 사용하지 않아도 된다. https://google.github.io/styleguide/javaguide.html https://myeonguni.tistory.com/1596

위와 같은 과정을 지키면서, 더 나아가 함수(메서드)의 라인 수를 줄이거나, Indent의 depth를 1까지만 허용하도록 더 개선해 나가면서 리팩토링을 진행합니다.

​

​

 

리팩토링에 사용될 코드는 다음과 같습니다.

	public static int splitAndSum(String text) {
		int result = 0;
		if(text == null || text.isEmpty()) {
			result = 0;
		} else {
			String[] values = text.split(",|:");
			for(String value: values) {
				result += Integer.parseInt(value);
			}
		}
		return result;
	}

 

위 메서드에는 다음과 같은 여러 문제점이 존재합니다.

    • 한 메서드가 여러가지의 일을 합니다.

    • else 예약어가 존재합니다.

    • depth가 2 이상입니다.

​

따라서 위와 같은 문제점을 개선해나가며 리팩토링을 진행해보도록 하겠습니다.

 

 

 

✔ 메서드 분리 리팩토링

• 한 메서드에 오직 한 단계의 Indent(들여쓰기) 만 한다.

위 코드에서 들여쓰기를 1로 맞추기 위해 메서드를 분리해야 하는데, for문의 코드를 메서드로 따로 분리합니다.

 

 

위에서의 for문을 sum이라는 메서드로 분리해서 만들었습니다.

이제 splitAndSum 메서드는 for문을 따로 분리해서 빼냈기때문에, depth 는 1이 됩니다.

 

하지만 아직 개선사항이 많은데요, 다음으로 else 예약어를 제거해보도록 하겠습니다.​

 

​

 

 

• else 예약어를 쓰지 않는다.

기존의 코드 splinAndSum() 에 비해 removeElseSplitAndSum() 메소드에는 else 예약어를 제거했는데요, 

 

위와 같이 예외 상황이 생겼을 때(if문) 바로 return을 하게 되면 로컬 변수(result)를 생성할 필요가 없고,

또한 else 예약어를 사용할 필요가 없습니다.

(아래 작업에선 removeElseSplitAndSum 메서드의 이름을 splitAndSum 으로 변경하고 사용합니다.)

 

 

 

• 메서드가 한 가지 일만 하도록 구현하기.

위의 sum 메서드는 두 가지의 일을 하는데, 눈치채셨나요 ?

    • 1) 문자열을 정수로 변환한다(parseInt)

    • 2) 정수를 모두 더한다(+=)

 

 

위와 같이 두 가지의 일을 하는데요, 따라서 "모든 메서드는 한 가지의 일을 해야한다"는 원칙대로 리팩토링을 합니다.

위와 같이 문자열을 정수로 변환하는 메서드 - toInts() , 정수를 더하는 메서드 - sum() 을 통해

이제는 각 메서드들은 한 가지의 일만 수행합니다.

(toInts2(), tosum2() 메서드처럼 stream과 람다를 통해 동일한 결과를 간단하게 표현할 수 있어요! 😯)

 

 

또한 기존의 splitAndSum() 메서드에는 기존의 values[] 로컬 변수를 제거하고, 위와 같이 바로 return을 할 수 있습니다.

 

 

 

현재 까지의 코드를 보면 다음과 같습니다.(기존 코드를 stream으로 대체했습니다.)

    public static int splitAndSum(String text) {
        if (text == null || text.isEmpty()) {
            return 0;
        }
        return sum(toInts(text.split(",|:"))); // Decorator
    }

    private static int[] toInts(final String[] values) {
        return Arrays.stream(values).mapToInt(Integer::parseInt).toArray();
    }

    private static int sum(final int[] value) {
        return Arrays.stream(value).sum();
    }

    public static void main(String[] args) {
        int[] arr = {1, 2, 3, 4};

        int result = Arrays.stream(arr).sum();
        System.out.println(result);
    }

 

 

 

✔ compose method 패턴 적용

• 메서드(함수)의 의도가 잘 드러나도록 동등한 수준의 작업을 하는 여러 단계로 나눈다.

마지막으로 위에서의 문장을 리팩토링 하겠습니다.

 

 

 

 

✔ 리팩토링 마무리

리팩토링이 마무리가 되었는데요, 리팩토링 하기 전의 코드와 후의 코드를 비교해보겠습니다.

 

 

 

리팩토링 전 코드

	public static int splitAndSum(String text) {
		int result = 0;
		if(text == null || text.isEmpty()) {
			result = 0;
		} else {
			String[] values = text.split(",|:");
			for(String value: values) {
				result += Integer.parseInt(value);
			}
		}
		return result;
	}

 

 

 

 

리팩토링 후 코드

    public static int splitAndSum(String text) {
        if (isBlank(text)) {
            return 0;
        }
        return sum(toInts(split(text))); // Decorator
    }

    private static boolean isBlank(final String text) {
        return (text == null || text.isEmpty());
    }

    private static String[] split(final String text) {
        return text.split(",|:");
    }

    private static int[] toInts(final String[] values) {
        return Arrays.stream(values).mapToInt(Integer::parseInt).toArray();
    }

    private static int sum(final int[] value) {
        return Arrays.stream(value).sum();
    }

 

 

 

🎉 리팩토링을 한 후의 코드의 특징은 다음과 같습니다.

• 각 메서드(함수)는 한 가지의 일만 합니다.

• 각 메서드의 Indent(들여쓰기) depth 은 모두 "1" 입니다.

• else 예약어가 존재하지 않습니다.

​

​

​

✔ 강의 내용을 정리하자면 다음과 같습니다.

• 한번에 모든 원칙을 지키면서 리팩토링을 하려고 연습하지 마라.

• 한번에 한 가지 명확하고 구체적인 목표를 가지고 연습하라.

• 연습은 극단적인 방법으로 연습하는 것도 좋다.

    • 한 메서드의 라인 수 제한을 15라인 -> 10라인으로 줄이도록 연습할 것

​