🎽 인프런 워밍업 클럽 0기 백엔드 다섯 번째 과제

출처
https://inf.run/XKQg

클린코드의 개념과 첫 리팩토링 강의를 수강하고 과제에서 제시된 코드를 리팩토링했다.

⛳️ 과제 코드

⛳️ 리팩토링

💡 클린 코드 작성하는 방법

• 의도를 표현하라
  코드 작성자가 아닌 다른 개발자가 코드를 봐도 명확하게 이해할 수 있어야 하며, 코드의 목적과 기능이 명확히 드러나도록 메소드명이나 변수명을 지어야 된다.

• 작게 만들어라
  클래스나 함수는 하나의 책임만을 가져야 한다. 작은 단위의 코드는 가독성이 향상되며, 재사용성도 증가한다.

• 중복 피하기
  코드 중복은 버그 발생의 주요 원인 중 하나이다. 중복 코드를 피하고 중복된 로직을 함수나 클래스로 추상화하여 재사용성을 높인다.

클린 코드의 원칙을 적용하여 코드를 입력 - 실행 - 출력으로 나누고, 각 부분을 담당하는 클래스들을 만들었다.

1️⃣ Main 클래스

public class Main {
    public static void main(String[] args) {
    	// 입력
        View view = new View();
        int count = view.inputNumber();
        
        // 실행
        ResultDto resultDto = playGame(count);
        
        // 출력
        view.printResult(resultDto);
    }

    private static ResultDto playGame(int count) {
        Dice dice = new Dice(6);
        dice.increaseBy(count);
        return dice.toResultDto();
    }
}

2️⃣ View 클래스

import com.group.libraryapp.study.day5.dto.DiceDto;
import com.group.libraryapp.study.day5.dto.ResultDto;
import java.util.List;
import java.util.Scanner;

public class View {

    private static final String GAME_INPUT_MESSAGE = "숫자를 입력하세요 : ";
    private static final String GAME_RESULT_MESSAGE = "%d은(는) %d번 나왔습니다.\n";

	// 사용자로부터 숫자를 입력 받는 메소드
    public int inputNumber() {
        System.out.print(GAME_INPUT_MESSAGE);
        Scanner sc = new java.util.Scanner(System.in);
        return sc.nextInt();
    }
    
	// 주사위 결과를 출력하는 메소드
    public void printResult(ResultDto resultDto) {
        List<DiceDto> result = resultDto.result();
        for (int i = 0; i < result.size(); i++) {
            System.out.printf(GAME_RESULT_MESSAGE, i + 1, result.get(i).result());
        }
    }
}

- inputNumber()

이 메소드는 사용자에게 숫자를 입력하라는 메시지를 보내고, 사용자로부터 입력값을 받아서 정수로 반환한다.
숫자를 입력하세요 : 라는 메시지를 상수로 만들어서 코드의 일관성을 유지하고, 오타를 방지했다.

- printResult(ResultDto resultDto)

이 메소드는 주사위를 던져서 나온 결과를 담은 Dto를 받아와서 게임 결과를 출력한다.
반복문을 사용하여 중복되는 출력 부분을 간결하게 정리했고, 출력 메시지도 상수를 활용하여 코드의 가독성을 향상했다.

3️⃣ Dice 클래스

import com.group.libraryapp.study.day5.dto.DiceDto;
import com.group.libraryapp.study.day5.dto.ResultDto;
import java.util.ArrayList;
import java.util.List;

public class Dice {
    private final int limit;
    private List<Integer> numbers;

	// 생성자: 주사위의 개수를 받아 초기화
    public Dice(int limit) {
        this.limit = limit;
        this.numbers = initialize(limit);
    }

	// 주사위를 던지면, 각 숫자가 나온 횟수를 1씩 증가
    public void increaseBy(int count) {
        for (int i = 0; i < count; i++) {
            int num = (int) (Math.random() * 6);
            int currentValue = numbers.get(num);
            numbers.set(num, currentValue + 1);
        }
    }

	// 결과를 ResultDto로 변환하는 메소드
    public ResultDto toResultDto() {
        return ResultDto.of(numbers);
    }
    
    private List<Integer> initialize(int limit) {
        List<Integer> numbers = new ArrayList<>();
        for (int i = 0; i < limit; i++) {
            numbers.add(0);
        }
        return numbers;
    }
}

- Dice(int limit)

Dice 클래스의 생성자를 보면, 주사위의 범위를 설정하는 작업을 한다.
현재 코드는 주사위가 1 ~ 6까지만 있지만, 나중에 주사위가 1 ~ 12 또는 1 ~ 20 이라도 limit 값만 변경해주면 되므로 변경 지점을 하나로 줄일 수 있게 되었다.

- increaseBy(int count)

이 메소드는 입력된 횟수(count)만큼 주사위를 던져서 나온 값을 기록한다.
주사위 던지기는 난수를 사용하고, 해당 난수가 인덱스인 리스트의 값을 가져와서 1씩 증가시키도록 했다.

- toResultDto()

이 메소드는 numbers를 Dto로 변환하며, View에서 결과를 출력할 때는 데이터만 필요하므로 Dice 인스턴스가 아닌 Dto 인스턴스를 출력할 때 파라미터로 넘기기 위해 만들었다.
ResultDto는 주사위의 각 숫자가 몇 번 나타났는지에 대한 횟수를 담은 Dto이며, Dto로 변환하는 로직은 ResultDto 클래스에 작성했다.

⭐️ 중요
View는 도메인 객체의 코드에 직접 의존하면 안 된다.
사용자 인터페이스를 담당하는 View에서는 도메인 객체의 내부 코드를 직접 사용하는 것을 지양하기 때문에 데이터 전달은 Dto(Data Transfer Object)를 사용하도록 하자.

예를 들어, 프론트단에서 백엔드 서버로부터 데이터를 받아와 화면을 렌더링하는데,
이때 백엔드 서버는 필요한 데이터만을 제공하고 그 데이터를 전달하기 위해 Dto를 사용한다.
(이렇게 하면 데이터 전송을 단순화하고, 도메인 객체의 내부를 숨기며 결합도를 낮추는 데에 도움이 된다.)

- initialize(int limit)

이 메소드는 리스트를 주어진 크기로 초기화하고, 각 요소를 0으로 설정한다.
주사위 범위만큼 변수를 만들 필요가 없기 때문에 코드의 재사용성을 높일 수 있다.

4️⃣ Dto 클래스

// 각 주사위 숫자에 대한 결과를 담은 Dto
public record DiceDto(int result) {}

// 여러 DiceDto를 포함하는 Dto
import java.util.List;

public record ResultDto(List<DiceDto> result) {

	// 정적 팩토리 메소드: List<Integer>를 받아 ResultDto 생성
    public static ResultDto of(List<Integer> numbers) {
        List<DiceDto> result = numbers.stream()
                .map(DiceDto::new)
                .toList();
        return new ResultDto(result);
    }
}

- ResultDto of(List<Integer> numbers)

이 메소드는 주어진 정수 리스트(numbers)를 받아와 각 숫자를 DiceDto로 변환한 후, 이를 리스트로 묶어 ResultDto를 생성한다.
여러 DiceDto를 생성하고 리스트로 묶는 반복적인 작업을 한 곳에서 처리함으로써 주사위 범위가 확장되어도 코드의 반복을 최소화할 수 있다.

⛳️ 개인 회고

클린 코드에 대한 개념을 찾아보고 코드 리팩토링을 진행하면서, 코드를 작성하는 것뿐만 아니라 코드를 읽고 이해하는 데도 노력을 기울여야 한다는 것을 깨달았다.
코드 작성가 아닌 다른 개발자가 봐도 한눈에 어떤 대상인지 그 대상으로 무엇을 하는지를 바로 알 수 있도록 메소드명이나 변수명을 잘 지어야 되고, 클래스나 함수는 1개의 책임만을 갖고 작게 만들어야 가독성과 재사용성이 향상된다는 것도 알게 되었다.
결국엔 가독성이 높고 유지보수가 쉬운 코드는 효율적인 개발을 위한 핵심인 것 같다.

📚 참고자료
https://medium.com/@lifthus531/%ED%81%B4%EB%A6%B0-%EC%BD%94%EB%93%9C%EC%97%90%EC%84%9C-%EB%A7%90%ED%95%98%EB%8A%94-%EA%B2%83%EB%93%A4-4717f8ea2229
https://www.nextree.io/basic-of-clean-code/