diff --git a/README.md b/README.md index a2b6ed1440..2312706de6 100644 --- a/README.md +++ b/README.md @@ -1,164 +1,81 @@ -# java-racingcar-precourse -# 미션 - 자동차 경주 - -## 🔍 진행 방식 - -- 미션은 **기능 요구 사항, 프로그래밍 요구 사항, 과제 진행 요구 사항** 세 가지로 구성되어 있다. -- 세 개의 요구 사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다. -- 기능 요구 사항에 기재되지 않은 내용은 스스로 판단하여 구현한다. - -## 📮 미션 제출 방법 - -- 미션 구현을 완료한 후 GitHub을 통해 제출해야 한다. - - GitHub을 활용한 제출 방법은 [프리코스 과제 제출](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 문서를 참고해 제출한다. -- GitHub에 미션을 제출한 후 [우아한테크코스 지원](https://apply.techcourse.co.kr) 사이트에 접속하여 프리코스 과제를 제출한다. - - 자세한 방법은 [제출 가이드](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse#제출-가이드) 참고 - - **Pull Request만 보내고 지원 플랫폼에서 과제를 제출하지 않으면 최종 제출하지 않은 것으로 처리되니 주의한다.** - -## 🚨 과제 제출 전 체크 리스트 - 0점 방지 - -- 기능 구현을 모두 정상적으로 했더라도 **요구 사항에 명시된 출력값 형식을 지키지 않을 경우 0점으로 처리**한다. -- 기능 구현을 완료한 뒤 아래 가이드에 따라 테스트를 실행했을 때 모든 테스트가 성공하는지 확인한다. -- **테스트가 실패할 경우 0점으로 처리**되므로, 반드시 확인 후 제출한다. - -### 테스트 실행 가이드 - -- 터미널에서 `java -version`을 실행하여 Java 버전이 17인지 확인한다. - Eclipse 또는 IntelliJ IDEA와 같은 IDE에서 Java 17로 실행되는지 확인한다. -- 터미널에서 Mac 또는 Linux 사용자의 경우 `./gradlew clean test` 명령을 실행하고, - Windows 사용자의 경우 `gradlew.bat clean test` 또는 `./gradlew.bat clean test` 명령을 실행할 때 모든 테스트가 아래와 같이 통과하는지 확인한다. - -``` -BUILD SUCCESSFUL in 0s -``` - ---- - -## 🚀 기능 요구 사항 - -초간단 자동차 경주 게임을 구현한다. - -- 주어진 횟수 동안 n대의 자동차는 전진 또는 멈출 수 있다. -- 각 자동차에 이름을 부여할 수 있다. 전진하는 자동차를 출력할 때 자동차 이름을 같이 출력한다. -- 자동차 이름은 쉼표(,)를 기준으로 구분하며 이름은 5자 이하만 가능하다. -- 사용자는 몇 번의 이동을 할 것인지를 입력할 수 있어야 한다. -- 전진하는 조건은 0에서 9 사이에서 무작위 값을 구한 후 무작위 값이 4 이상일 경우이다. -- 자동차 경주 게임을 완료한 후 누가 우승했는지를 알려준다. 우승자는 한 명 이상일 수 있다. -- 우승자가 여러 명일 경우 쉼표(,)를 이용하여 구분한다. -- 사용자가 잘못된 값을 입력할 경우 `IllegalArgumentException`을 발생시킨 후 애플리케이션은 종료되어야 한다. - -### 입출력 요구 사항 - -#### 입력 - -- 경주 할 자동차 이름(이름은 쉼표(,) 기준으로 구분) - -``` -pobi,woni,jun -``` - -- 시도할 회수 - -``` -5 -``` - -#### 출력 - -- 각 차수별 실행 결과 - -``` -pobi : -- -woni : ---- -jun : --- -``` - -- 단독 우승자 안내 문구 - -``` -최종 우승자 : pobi -``` - -- 공동 우승자 안내 문구 - -``` -최종 우승자 : pobi, jun -``` - -#### 실행 결과 예시 - -``` -경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분) -pobi,woni,jun -시도할 회수는 몇회인가요? -5 - -실행 결과 -pobi : - -woni : -jun : - - -pobi : -- -woni : - -jun : -- - -pobi : --- -woni : -- -jun : --- - -pobi : ---- -woni : --- -jun : ---- - -pobi : ----- -woni : ---- -jun : ----- - -최종 우승자 : pobi, jun -``` - ---- - -## 🎯 프로그래밍 요구 사항 - -- JDK 17 버전에서 실행 가능해야 한다. **JDK 17에서 정상적으로 동작하지 않을 경우 0점 처리한다.** -- 프로그램 실행의 시작점은 `Application`의 `main()`이다. -- `build.gradle` 파일을 변경할 수 없고, 외부 라이브러리를 사용하지 않는다. -- [Java 코드 컨벤션](https://github.com/woowacourse/woowacourse-docs/tree/master/styleguide/java) 가이드를 준수하며 프로그래밍한다. -- 프로그램 종료 시 `System.exit()`를 호출하지 않는다. -- 프로그램 구현이 완료되면 `ApplicationTest`의 모든 테스트가 성공해야 한다. **테스트가 실패할 경우 0점 처리한다.** -- 프로그래밍 요구 사항에서 달리 명시하지 않는 한 파일, 패키지 이름을 수정하거나 이동하지 않는다. - -### 추가된 요구 사항 - -- indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다. - - 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다. - - 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다. -- 3항 연산자를 쓰지 않는다. -- 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라. -- JUnit 5와 AssertJ를 이용하여 본인이 정리한 기능 목록이 정상 동작함을 테스트 코드로 확인한다. - - 테스트 도구 사용법이 익숙하지 않다면 `test/java/study`를 참고하여 학습한 후 테스트를 구현한다. - -### 라이브러리 - -- JDK에서 제공하는 Random 및 Scanner API 대신 `camp.nextstep.edu.missionutils`에서 제공하는 `Randoms` 및 `Console` API를 사용하여 구현해야 한다. - - Random 값 추출은 `camp.nextstep.edu.missionutils.Randoms`의 `pickNumberInRange()`를 활용한다. - - 사용자가 입력하는 값은 `camp.nextstep.edu.missionutils.Console`의 `readLine()`을 활용한다. - -#### 사용 예시 - -- 0에서 9까지의 정수 중 한 개의 정수 반환 - -```java -Randoms.pickNumberInRange(0,9); -``` - ---- - -## ✏️ 과제 진행 요구 사항 - -- 미션은 [java-racingcar-7](https://github.com/woowacourse-precourse/java-racingcar-7) 저장소를 Fork & Clone해 시작한다. -- **기능을 구현하기 전 `docs/README.md`에 구현할 기능 목록을 정리**해 추가한다. -- **Git의 커밋 단위는 앞 단계에서 `docs/README.md`에 정리한 기능 목록 단위**로 추가한다. - - [커밋 메시지 컨벤션](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) 가이드를 참고해 커밋 메시지를 작성한다. -- 과제 진행 및 제출 방법은 [프리코스 과제 제출](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 문서를 참고한다. +## 1. 구현 기능 목록 + +### 1. 입력 기능 + +- [x] 자동차 이름 입력받기 + - 사용자로부터 쉼표(,)로 구분된 자동차 이름 문자열 입력받기 + - 입력 메시지: "경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)" +- [x] 시도 횟수 입력받기 + - 사용자로부터 경주 진행 횟수 입력받기 + - 입력 메시지: "시도할 회수는 몇회인가요?" + +### 2. 입력 검증 기능 + +- [x] 자동차 이름 검증하기 + - 이름이 5자 이하인지 검증 + - 공백 또는 빈 문자열 검증 + - 검증 실패 시 `IllegalArgumentException` 발생 +- [x] 시도 횟수 검증하기 + - 숫자 형식인지 검증 (NumberFormatException 처리) + - 음수가 아닌지 검증 + - 검증 실패 시 `IllegalArgumentException` 발생 + +### 3. 자동차 도메인 기능 + +- [x] 자동차 객체 생성하기 + - 자동차 이름과 초기 위치(0) 설정 + - 자동차 이름은 불변값으로 관리 +- [x] 자동차 이동 기능 구현하기 + - 0~9 사이 랜덤 값 생성 + - 랜덤 값이 4 이상일 때 전진 (위치 +1) + - 4 미만일 때는 정지 (위치 변화 없음) + +### 4. 게임 진행 기능 + +- [x] 경주 게임 실행하기 + - 입력받은 횟수만큼 라운드 반복 + - 각 라운드에서 모든 자동차에 대해 이동 판정 + - 라운드별 자동차 상태를 히스토리로 저장 +- [x] 우승자 계산하기 + - 최종 라운드에서 가장 멀리 이동한 자동차 찾기 + - 동일한 최대 거리의 자동차들을 모두 우승자로 선정 + +### 5. 출력 기능 + +- [x] 경주 진행 과정 출력하기 + - "실행 결과" 메시지 출력 + - 각 라운드별로 모든 자동차의 상태 출력 + - 자동차 이름과 이동 거리를 문자로 표현 + - 라운드 간 빈 줄로 구분 +- [x] 최종 우승자 출력하기 + - "최종 우승자 : " 메시지와 함께 우승자 이름 출력 + - 우승자가 여러 명인 경우 쉼표(,)로 구분하여 출력 + +### 6. 전체 애플리케이션 제어 기능 + +- [x] 게임 전체 흐름 제어하기 + - 입력 → 검증 → 게임 실행 → 결과 출력 순서로 진행 + - 예외 발생 시 애플리케이션 종료 + +## 2. 기술적 구현 + +### 객체지향 설계 + +- [x] MVC 패턴 적용 + - Controller: 전체 흐름 제어 + - View: 입력/출력 담당 + - Service: 비즈니스 로직 처리 + - Domain: 핵심 도메인 모델 +- [x] 전략 패턴 적용 + - Mover 인터페이스로 이동 로직 추상화 + - RandomMover로 랜덤 기반 이동 구현 + +### 데이터 관리 + +- [x] 불변 객체 활용 + - 자동차 이름은 생성 후 변경 불가 + - 각 라운드 상태를 스냅샷으로 보존 +- [x] 컬렉션 활용 + - List를 활용한 자동차 목록 관리 + - 2차원 List로 라운드별 히스토리 관리 + diff --git a/src/main/java/racingcar/Application.java b/src/main/java/racingcar/Application.java index a17a52e724..92d8a6dd82 100644 --- a/src/main/java/racingcar/Application.java +++ b/src/main/java/racingcar/Application.java @@ -1,7 +1,11 @@ package racingcar; +import racingcar.controller.RacingCarController; + public class Application { public static void main(String[] args) { // TODO: 프로그램 구현 + RacingCarController racingCarController = new RacingCarController(); + racingCarController.run(); } } diff --git a/src/main/java/racingcar/controller/RacingCarController.java b/src/main/java/racingcar/controller/RacingCarController.java new file mode 100644 index 0000000000..b90feca5b4 --- /dev/null +++ b/src/main/java/racingcar/controller/RacingCarController.java @@ -0,0 +1,25 @@ +package racingcar.controller; + +import racingcar.domain.Car; +import racingcar.service.RacingCarService; +import racingcar.view.InputView; +import racingcar.view.ResultView; + +import java.util.List; + +public class RacingCarController { + private final InputView inputView = new InputView(); + private final RacingCarService racingCarService = new RacingCarService(); + private final ResultView resultView = new ResultView(); + + public void run(){ + String rawCarNames = inputView.readCarNames(); + int rawRound = inputView.readRound(); // 변수명 일관성 + + List> raceHistory = racingCarService.startRace(rawCarNames, rawRound); + resultView.printRaceHistory(raceHistory); + + List winners = racingCarService.getWinners(raceHistory); // raceHistory 객체라니 진짜 짱이다 + resultView.printWinners(winners); + } +} diff --git a/src/main/java/racingcar/domain/Car.java b/src/main/java/racingcar/domain/Car.java new file mode 100644 index 0000000000..319104be8b --- /dev/null +++ b/src/main/java/racingcar/domain/Car.java @@ -0,0 +1,29 @@ +package racingcar.domain; + +public class Car { + private final String carName; // carName은 불변이니까 + private int position; + + public Car(String carName) { + this(carName, 0); + } + + public Car(String carName, int position) { + this.carName = carName; + this.position = position; + } + + public String getCarName() { + return carName; + } + + public int getPosition() { + return position; + } + + public void moveIfPossible(Mover mover) { + if (mover.canMove()) { + position++; + } + } +} diff --git a/src/main/java/racingcar/domain/CarNameValidator.java b/src/main/java/racingcar/domain/CarNameValidator.java new file mode 100644 index 0000000000..7acd27533b --- /dev/null +++ b/src/main/java/racingcar/domain/CarNameValidator.java @@ -0,0 +1,31 @@ +package racingcar.domain; + +import java.util.ArrayList; +import java.util.List; + +public class CarNameValidator { + + public List createCarList(String rawStringOfCarNames) { + + List carList = new ArrayList<>(); + + if(rawStringOfCarNames == null || rawStringOfCarNames.isBlank()) { + throw new IllegalArgumentException("[ERROR] 공백은 안 받아요"); + } + + String[] carNamesArray = rawStringOfCarNames.split(","); + for(String carName : carNamesArray) { + String trimmed = carName.strip(); + if (trimmed.isBlank()) { + throw new IllegalArgumentException("[ERROR] 공백은 안 받아요"); + } + if (trimmed.length() > 5) { + throw new IllegalArgumentException("[ERROR] 이름이 5자를 초과해요"); + } + carList.add(new Car(trimmed)); + } + + return carList; + } + +} diff --git a/src/main/java/racingcar/domain/Mover.java b/src/main/java/racingcar/domain/Mover.java new file mode 100644 index 0000000000..30859cae49 --- /dev/null +++ b/src/main/java/racingcar/domain/Mover.java @@ -0,0 +1,5 @@ +package racingcar.domain; + +public interface Mover { + boolean canMove(); +} diff --git a/src/main/java/racingcar/domain/RandomMover.java b/src/main/java/racingcar/domain/RandomMover.java new file mode 100644 index 0000000000..b40145dcf7 --- /dev/null +++ b/src/main/java/racingcar/domain/RandomMover.java @@ -0,0 +1,12 @@ +package racingcar.domain; + +import camp.nextstep.edu.missionutils.Randoms; + +public class RandomMover implements Mover { + private static final int MOVE_THRESHOLD = 4; + + @Override + public boolean canMove() { + return Randoms.pickNumberInRange(0, 9) >= MOVE_THRESHOLD; + } +} diff --git a/src/main/java/racingcar/domain/RoundValidator.java b/src/main/java/racingcar/domain/RoundValidator.java new file mode 100644 index 0000000000..5798040c05 --- /dev/null +++ b/src/main/java/racingcar/domain/RoundValidator.java @@ -0,0 +1,11 @@ +package racingcar.domain; + +public class RoundValidator { + + public int validateRound(int rawRound){ + if (rawRound < 0) { + throw new IllegalArgumentException("[ERROR] 음수는 입력할 수 없습니다."); + } + return rawRound; + } +} diff --git a/src/main/java/racingcar/domain/WinnerCalculator.java b/src/main/java/racingcar/domain/WinnerCalculator.java new file mode 100644 index 0000000000..5d0591ef42 --- /dev/null +++ b/src/main/java/racingcar/domain/WinnerCalculator.java @@ -0,0 +1,28 @@ +package racingcar.domain; + +/* +* position이 가장 먼 사람 찾기 +* */ + +import java.util.ArrayList; +import java.util.List; + +public class WinnerCalculator { + public List calculate(List cars) { + int maxPosition = 0; + List winners = new ArrayList<>(); + + for (Car car : cars) { + if(maxPosition < car.getPosition()){ + maxPosition = car.getPosition(); + winners.clear(); + winners.add(car); + } + else if(maxPosition == car.getPosition()){ + winners.add(car); + } + } + + return winners; + } +} diff --git a/src/main/java/racingcar/service/RacingCarService.java b/src/main/java/racingcar/service/RacingCarService.java new file mode 100644 index 0000000000..22adb2ee1b --- /dev/null +++ b/src/main/java/racingcar/service/RacingCarService.java @@ -0,0 +1,44 @@ +package racingcar.service; + +import racingcar.domain.*; +import java.util.ArrayList; +import java.util.List; + +public class RacingCarService { + + public static final CarNameValidator carNameValidator = new CarNameValidator(); + public static final RoundValidator roundValidator = new RoundValidator(); + public static final WinnerCalculator winnerCalculator = new WinnerCalculator(); + + private final Mover mover = new RandomMover(); + + public List> startRace(String rawCarNames, int rawRound) { + List carList = carNameValidator.createCarList(rawCarNames); + int round = roundValidator.validateRound(rawRound); + + List> raceHistory = new ArrayList<>(); + + for (int i = 0; i < round; i++) { + for (Car car : carList) { + car.moveIfPossible(mover); + } + // 현재 라운드 snapshot 저장 + raceHistory.add(cloneCars(carList)); + } + + return raceHistory; + } + + public List getWinners(List> raceHistory) { + List lastRound = raceHistory.get(raceHistory.size() - 1); + return winnerCalculator.calculate(lastRound); + } + + private List cloneCars(List cars) { + List snapshot = new ArrayList<>(); + for (Car car : cars) { + snapshot.add(new Car(car.getCarName(), car.getPosition())); + } + return snapshot; + } +} diff --git a/src/main/java/racingcar/view/InputView.java b/src/main/java/racingcar/view/InputView.java new file mode 100644 index 0000000000..f6afad5fbb --- /dev/null +++ b/src/main/java/racingcar/view/InputView.java @@ -0,0 +1,25 @@ +package racingcar.view; + +import camp.nextstep.edu.missionutils.Console; + +public class InputView { + private static final String CARNAMES_INPUT_MSG = "경주할 자동차 이름을 입력하세요.(이름은 쉼표(,) 기준으로 구분)"; + private static final String ROUND_INPUT_MSG = "시도할 회수는 몇회인가요?"; + + public String readCarNames() { + System.out.println(CARNAMES_INPUT_MSG); // REQUEST MSG라는 말이 더 맘에 들어 + return Console.readLine().strip(); + } + + public int readRound(){ + System.out.println(ROUND_INPUT_MSG); + String roundString = Console.readLine().strip(); + + try { + return Integer.parseInt(roundString); + } catch (NumberFormatException e) { + throw new IllegalArgumentException("[ERROR] 숫자만 입력할 수 있습니다."); + } + + } +} diff --git a/src/main/java/racingcar/view/ResultView.java b/src/main/java/racingcar/view/ResultView.java new file mode 100644 index 0000000000..50b5589300 --- /dev/null +++ b/src/main/java/racingcar/view/ResultView.java @@ -0,0 +1,26 @@ +package racingcar.view; + +import racingcar.domain.Car; + +import java.util.List; + +public class ResultView { + private static final String RESULT_MSG = "최종 우승자 : "; + + // stringbuilder 쓰면 시간 개선할 수 있을텐데 + public void printRaceHistory(List> raceHistory) { + System.out.println("실행 결과"); + for (List round : raceHistory) { + for (Car car : round) { + System.out.println(car.getCarName() + " : " + "-".repeat(car.getPosition())); + } + System.out.println(); + } + } + + public void printWinners(List winners) { + String names = String.join(", ", + winners.stream().map(Car::getCarName).toList()); + System.out.println(RESULT_MSG + names); + } +}