-
Notifications
You must be signed in to change notification settings - Fork 4
[자동차 경주 게임] 조경현 미션 제출합니다. #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
fdc850b
02a2b3a
daeed7f
4ccc7e7
6523c59
4442149
5b5c681
eaaaded
0a15481
e20b5d3
81f4152
f041f59
d6e40b5
d145823
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. 자동차의 이름을 입력받고 검증한다. | ||
| > 검증 조건이 추가되거나 변경될 가능성이 있다. | ||
| - [x] 사용자에게 자동차 이름 입력 메시지 출력 | ||
| - [x] 사용자가 입력한 값 받음 | ||
| - [x] 입력값 받는 동시에 양쪽에 있는 공백 제거 `(판단)` | ||
| - [x] 빈 문자열("") 또는 1개 이상의 공백(예: " ") 입력 시 예외 발생 `(판단)` | ||
|
|
||
| ### 2. 입력 받은 자동차의 이름을 분리하고 검증한다. | ||
| > 검증 조건이 추가되거나 변경될 가능성이 있다. | ||
| - [x] 입력된 자동차 이름 문자열을 쉼표(,)를 기준으로 구분해 리스트로 저장 | ||
| - [x] 각 자동차 이름의 양쪽 공백 제거 | ||
| - [x] 자동차 글자 수가 5를 초과하는 경우가 있으면 예외 발생 | ||
| - [x] 모든 자동차의 이름이 공백만으로 이루어져 있으면 예외 발생 `(판단)` | ||
|
|
||
| ### 3. 자동차를 만들어 이름을 부여한다. | ||
| - [x] 자동차 객체를 저장하는 리스트 생성 | ||
| - [x] 자동차 객체를 생성하면서 각 이름을 저장 | ||
| - [x] 공백만으로 이루어진 자동차 이름은 제외 | ||
|
|
||
| ### 4. 시도할 횟수를 입력받고 검증한다. | ||
| > 검증 조건이 추가되거나 변경될 가능성이 있다. | ||
| - [x] 사용자에게 시도할 횟수 입력 메시지 출력 | ||
| - [x] 사용자가 입력한 값 받음 | ||
| - [x] 입력값 받는 동시에 양쪽에 있는 공백 제거 `(판단)` | ||
| - [x] 빈 문자열("") 또는 1개 이상의 공백(예: " ") 입력 시 예외 발생 `(판단)` | ||
| - [x] 입력 받은 양수값을 양수로 변경 | ||
| - [x] 양수가 아닌 값 입력 시 예외 발생 | ||
| - [x] 양수로 변경한 값이 정수 최댓값 초과하면 예외 발생 `(판단)` | ||
|
|
||
| ### 5. 자동차 경주를 진행하면서 과정을 문자열로 저장한다. | ||
| - [x] 사용자가 입력한 횟수 만큼 각 자동차의 경주 과정을 문자열로 저장 | ||
| - [x] 각 자동차마다 랜덤 함수를 호출해 값이 4이상인 경우 "-" 를 1개 추가 | ||
|
|
||
| ### 6. 우승자를 결정해 우승자 목록을 문자열로 저장한다. | ||
| - [x] 자동차 경주 결과에 따른 우승자의 "-" 개수 구하기(즉, "-" 개수의 최댓값 구하기) | ||
| - [x] 최댓값을 가진 자동차 객체로만 리스트 생성(즉, 우승자 리스트 생성) | ||
| - [x] 최종 우승자 목록을 문자열로 저장 | ||
| - [x] 우승자가 여러 명일 경우 쉼표(,)를 이용하여 구분하여 출력 | ||
|
|
||
| ### 7. 자동차 경주 진행 과정과 우승자 목록을 출력한다. | ||
| - [x] 자동차 경주 진행 과정과 우승자 목록을 출력한다. | ||
|
|
||
|
|
||
| ## 테스트 코드 | ||
| ### 정상 입력 케이스 | ||
| > 검증 조건이 추가되거나 변경될 가능성이 있다. | ||
| - [x] 기본 케이스 | ||
| - [x] 공동 우승 케이스 | ||
| - [x] 쉼표 2개 이상 연속으로 들어와도 정상 수행 `(판단)` | ||
| - [x] 입력값의 양쪽에 공백이 있는 경우 공백 제거하고 정상 수행 `(판단)` | ||
| - [x] 자동차이름에 숫자, 기호 허용 `(판단)` | ||
| - [x] 각 자동차이름 양쪽에 공백이 있는 경우 공백 제거하고 정상 수행 `(판단)` | ||
|
|
||
| ### 예외 발생 입력 케이스 | ||
| > 검증 조건이 추가되거나 변경될 가능성이 있다. | ||
| - [x] 빈 문자열("") 또는 1개 이상의 공백(예: " ") 입력 시 예외 발생 `(판단)` | ||
| - [x] 자동차이름 입력값이 공백만으로 이루어진 경우 `(판단)` | ||
| - [x] 시도할횟수 입력값이 공백만으로 이루어진 경우 `(판단)` | ||
| - [x] 자동차 이름이 5자 초과하는 경우 | ||
| - [x] 자동차이름 중간 공백도 글자로 인식 `(판단)` | ||
| - [x] 중간 공백 포함 5자 초과하는 경우 `(판단)` | ||
| - [x] 모든 자동차의 이름이 공백만 있는 경우(즉, 자동차의 개수가 0인 경우) `(판단)` | ||
| - [x] 이동 횟수 입력이 양수가 아닌 값이 들어오는 경우 `(판단)` | ||
| - [x] 시도할 횟수가 정수 최댓값 초과하면 예외 발생 `(판단)` | ||
|
|
||
| ## 리펙토링 | ||
| > 코드가 수정되는 경우 변경 사항을 작성한다. | ||
| - [x] 예외 메시지 추가 및 관리 | ||
| - [x] 변수명 재확인 | ||
| - [x] 자동차 이름 입력값에 문제가 있을 때 시도할 횟수 입력 받지 않고 바로 예외 발생 가능하도록 변경 | ||
| - [x] 로직에 중요한 역할을 하는 상수는 따로 관리(Constant) | ||
| - [x] Service 에서 split 메서드 반환값을 배열에서 리스트로 수정 | ||
| - [x] validateNoCars 메서드 추가 | ||
| - [x] 주석 추가 | ||
| - [x] 우승자 출력 문자열을 반환하는 메서드에서 StringBuilder 대신 String.join 메서드 사용 | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,5 +3,6 @@ | |
| public class Application { | ||
| public static void main(String[] args) { | ||
| // TODO: 프로그램 구현 | ||
| ApplicationRunner.run(); | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| package racingcar; | ||
|
|
||
| import racingcar.controller.RacingController; | ||
| import racingcar.service.RacingService; | ||
| import racingcar.view.InputView; | ||
| import racingcar.view.OutputView; | ||
|
|
||
| public class ApplicationRunner { | ||
|
|
||
| public static void run() { | ||
| // Controller에 생성자 주입 | ||
| RacingController controller = new RacingController( | ||
| new RacingService(), | ||
| new InputView(), | ||
| new OutputView() | ||
| ); | ||
| controller.run(); | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. controller의 run()메서드와 ApplicationRunner의 run() 메서드의 이름이 같아 혼동될 수 있을거 같아요.
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 추가로, Controller가 현재 Service, InputView, OutputView 총 3개의 객체를 생성자 주입받고 있습니다. 이렇게 되면 이 중 하나라도 변경될 경우 Controller 코드까지 영향을 받아 결합도가 높아집니다. 따라서 Controller는 가능한 한 적은 의존성을 가지는 것이 좋습니다. 일반적으로 Service는 생성자 주입을 통해 사용하고, View는 생성자 주입 대신 메서드 호출 방식으로 사용한다고 합니다.
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 적당한 메서드 이름이 생각이 안나서 그냥 똑같이 해버렸는데,, 딱 걸렸네요ㅋㅋ 생성자 주입은 자신있게 설계한 부분인데 결합도나 의존성 부분은 생각도 못했네요.. 역시 끝없는 리펙토링..🥲
|
||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package racingcar.constant; | ||
|
|
||
| public class Constant { | ||
| // 로직을 구성하는 핵심 상수 관리 | ||
| public static final int GO_THRESHOLD = 4; | ||
| public static final int NAME_MAX_LENGTH = 5; | ||
| public static final int RANDOM_FROM = 0; | ||
| public static final int RANDOM_TO = 9; | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| package racingcar.constant; | ||
|
|
||
| public enum ErrorMessage { | ||
| // 에러 메시지 통합 관리 | ||
| NO_CAR_ERROR("No cars exist."), | ||
| NOT_POSITIVE_NUMBER_ERROR("Enter a positive number."), | ||
| ONLY_WHITESPACE_ERROR("Input contains only whitespace."), | ||
| MAXIMUM_LENGTH_ERROR("Maximum length of the car name is 5 characters."), | ||
| INTEGER_OVERFLOW_ERROR("The input count causes an integer overflow."); | ||
|
|
||
| private final String errorMessage; | ||
|
|
||
| ErrorMessage(String errorMessage) { | ||
| this.errorMessage = "[Invalid input] " + errorMessage; | ||
| } | ||
|
|
||
| public String getErrorMessage() { | ||
| return errorMessage; | ||
| } | ||
| } |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package racingcar.controller; | ||
|
|
||
| import racingcar.domain.Cars; | ||
| import racingcar.service.RacingService; | ||
| import racingcar.view.InputView; | ||
| import racingcar.view.OutputView; | ||
|
|
||
| public class RacingController { | ||
| private final RacingService service; | ||
| private final InputView inputView; | ||
| private final OutputView outputView; | ||
|
|
||
| public RacingController(RacingService service, InputView inputView, OutputView outputView) { | ||
| this.service = service; | ||
| this.inputView = inputView; | ||
| this.outputView = outputView; | ||
| } | ||
|
|
||
| public void run() { | ||
| String inputCarNames = inputView.readCarNames(); // 자동차 이름 입력값 반환 | ||
| Cars cars = service.getCars(inputCarNames); // 입력값 검증 + 자동차 리스트 반환 | ||
|
|
||
| String inputRaceCount = inputView.readRaceCount(); // 시도할 횟수 입력값 반환 | ||
| int raceCount = service.getRaceCount(inputRaceCount); // 입력값 검증 + 양수로 변환한 값 반 | ||
|
|
||
| service.runRace(cars, raceCount); // 자동차 경주 진행, 경주 진행 과정은 자동차 리스트에 문자열 형태로 저장됨. | ||
| String winners = service.decideWinners(cars); // 결과에 따른 우승자 선정 후 반환 | ||
|
|
||
| outputView.printRace(cars, raceCount); // 자동차 경주 진행 과정 출력 | ||
| outputView.printWinners(winners); // 우승자 출력 | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
자동차 이름은 5자 이하 가능한거라, 6자 초과하는 경우로 에러처리해야해요!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
이름이 5자 이하까지 허용되기 때문에, 5자를 초과하는 경우(6 이상인 경우) 예외를 처리하도록 했습니다:)