미션 - 로또 (이충안)

• 과제 내용(우테코 Github Repository)
• 공부한 내용(Notion)
• 회고록(velog)

개요 및 기능

• 이 프로젝트는 우아한테크코스 4기 프리코스 3주차 과제를 구현하기 위해 만들어졌다.
  • 과제 내용은 하단의 각종 요구 사항 또는 과제 내용(우테코 Github Repository)를 참고하길 바란다.
• 기능
  • 로또 구매 금액을 입력하면 자동으로 로또를 만들어 준다.
  • 당첨 번호와 보너스 번호를 입력하면 당첨 결과를 출력한다.
• 예시

  구입금액을 입력해 주세요.
  8000
  
  8개를 구매했습니다.[2, 9, 24, 31, 37, 44]
  [4, 16, 19, 25, 36, 37]
  [4, 5, 15, 29, 33, 43]
  [1, 3, 7, 23, 29, 41]
  [10, 11, 27, 29, 35, 36]
  [2, 20, 26, 32, 34, 39]
  [15, 18, 20, 23, 38, 39]
  [14, 18, 25, 28, 37, 38]
  
  당첨 번호를 입력해 주세요.
  4,5,15,16,33,36
  
  보너스 번호를 입력해 주세요.
  39
  
  당첨 통계
  ---
  3개 일치 (5,000원) - 1개
  4개 일치 (50,000원) - 1개
  5개 일치 (1,500,000원) - 0개
  5개 일치, 보너스 볼 일치 (30,000,000원) - 0개
  6개 일치 (2,000,000,000원) - 0개
  총 수익률은 687.5%입니다.
  

🔍 설계 및 구현에서 신경쓴 점

확장성 고려

• 로또 한 장당 가격 변경 가능
• 총 공의 개수, 뽑는 공의 개수 변경 가능하게 설정
• 로또 당첨 조건 변경 가능, 해당 금액 변경 가능
  • ex) 5등 : 3개 일치 (5,000원) > 5등 : 3개 일치, 보너스 볼 일치 (10,000원)
• 등수 개수 변경 가능
  • ex) 6등 : 2개 일치 (1,000원) (추가)

도메인 분리 및 설계

• 출력(ConsoleOutput), 입력(ConsoleInput), 기능(그 외) 를 나누려고 노력함
• Lotto, WinningNumber 등으로 나누어 각각 자신의 담당하는 역할을 배정하고 구현함
• LottoSetting에서 여러 값들을 지정하고, 이 값을 이용하여 여러 객체들을 생성할 수 있게 함

유닛 테스트

• 각 Class마다 public method에 대해 Unit Test를 진행함
• 다른 객체의 결과 값에 영향을 받지 않기 위해 Mockito를 사용
  • 각 테스트마다 이용하는 다른 객체가 어떤 값을 제공할 지 설정해줌
• 매 티팩토링 후에는 해당 기능에 맞추어 유닛 테스트를 변경하고 통과를 확인함

Convention

• 아래에서 제공한 컨벤션을 지키려 노력하였음
• Convention 정리 자료
  • Coding Convention
  • Git Convention

아쉬웠던 점

• 책임 중심으로 생각했어야 했는데 변경할 수 있는 값들을 LottoApplicationSetting으로 다 모아 놓는 것을 우선시 생각함

  • 관련 객체들을 전부 LottoApplicationSetting으로 만들어야 했다.
  • 변경할 수 있는 값들을 한눈에 보았으면 좋았을 텐데 LottoApplicationSetting 안에 여러 field 인자들을 전부 enum으로 구성하여 한눈에 보기 힘들었다.
  • 해당 방법대로 진행해도 되나라는 생각이 많이 들었다.

• lotto.LottoApplication runApplication() 부분이 서로 연관된 데이터가 많아 메서드 분리하기가 어렵다.

  • 메서드를 분리하자니 서로 넘겨주는 인자가 많아 알아보기가 어려울 것 같았다.
  • 이것을 필드값으로 가지고 있자니 다시 덮어씌워질 수 있는 값을 가지고 있는 것이 부담스러웠다.
  • 결국에는 필드값으로 분리하였으나 내가 하는 방법이 더 보기 쉬운 방법인지 잘 모르겠고, 더 좋은 방법이 있는지 궁금하다.

기능 구현하며 작성한 문서

• 설계 및 구현 과정
• Class 별 구현 기능 목록

---

• 아래의 요구 사항을 최대한 지키기 위해 노력하였음

🚀 기능 요구 사항

로또 게임 기능을 구현해야 한다. 로또 게임은 아래와 같은 규칙으로 진행된다.

- 로또 번호의 숫자 범위는 1~45까지이다.
- 1개의 로또를 발행할 때 중복되지 않는 6개의 숫자를 뽑는다.
- 당첨 번호 추첨 시 중복되지 않는 숫자 6개와 보너스 번호 1개를 뽑는다.
- 당첨은 1등부터 5등까지 있다. 당첨 기준과 금액은 아래와 같다.
    - 1등: 6개 번호 일치 / 2,000,000,000원
    - 2등: 5개 번호 + 보너스 번호 일치 / 30,000,000원
    - 3등: 5개 번호 일치 / 1,500,000원
    - 4등: 4개 번호 일치 / 50,000원
    - 5등: 3개 번호 일치 / 5,000원

• 로또 구입 금액을 입력하면 구입 금액에 해당하는 만큼 로또를 발행해야 한다.
• 로또 1장의 가격은 1,000원이다.
• 당첨 번호와 보너스 번호를 입력받는다.
• 사용자가 구매한 로또 번호와 당첨 번호를 비교하여 당첨 내역 및 수익률을 출력하고 로또 게임을 종료한다.
• 사용자가 잘못된 값을 입력할 경우 IllegalArgumentException를 발생시키고, "[ERROR]"로 시작하는 에러 메시지를 출력 후 종료한다.

입출력 요구 사항

입력

• 로또 구입 금액을 입력 받는다. 구입 금액은 1,000원 단위로 입력 받으며 1,000원으로 나누어 떨어지지 않는 경우 예외 처리한다.

14000

• 당첨 번호를 입력 받는다. 번호는 쉼표(,)를 기준으로 구분한다.

1,2,3,4,5,6

• 보너스 번호를 입력 받는다.

7

출력

• 발행한 로또 수량 및 번호를 출력한다. 로또 번호는 오름차순으로 정렬하여 보여준다.

8개를 구매했습니다.
[8, 21, 23, 41, 42, 43] 
[3, 5, 11, 16, 32, 38] 
[7, 11, 16, 35, 36, 44] 
[1, 8, 11, 31, 41, 42] 
[13, 14, 16, 38, 42, 45] 
[7, 11, 30, 40, 42, 43] 
[2, 13, 22, 32, 38, 45] 
[1, 3, 5, 14, 22, 45]

• 당첨 내역을 출력한다.

3개 일치 (5,000원) - 1개
4개 일치 (50,000원) - 0개
5개 일치 (1,500,000원) - 0개
5개 일치, 보너스 볼 일치 (30,000,000원) - 0개
6개 일치 (2,000,000,000원) - 0개

• 수익률은 소수점 둘째 자리에서 반올림한다. (ex. 100.0%, 51.5%, 1,000,000.0%)

총 수익률은 62.5%입니다.

• 예외 상황 시 에러 문구를 출력해야 한다. 단, 에러 문구는 "[ERROR]"로 시작해야 한다.

[ERROR] 로또 번호는 1부터 45 사이의 숫자여야 합니다.

실행 결과 예시

구입금액을 입력해 주세요.
8000

8개를 구매했습니다.
[8, 21, 23, 41, 42, 43] 
[3, 5, 11, 16, 32, 38] 
[7, 11, 16, 35, 36, 44] 
[1, 8, 11, 31, 41, 42] 
[13, 14, 16, 38, 42, 45] 
[7, 11, 30, 40, 42, 43] 
[2, 13, 22, 32, 38, 45] 
[1, 3, 5, 14, 22, 45]

당첨 번호를 입력해 주세요.
1,2,3,4,5,6

보너스 번호를 입력해 주세요.
7

당첨 통계
---
3개 일치 (5,000원) - 1개
4개 일치 (50,000원) - 0개
5개 일치 (1,500,000원) - 0개
5개 일치, 보너스 볼 일치 (30,000,000원) - 0개
6개 일치 (2,000,000,000원) - 0개
총 수익률은 62.5%입니다.

---

🎯 프로그래밍 요구 사항

• JDK 11 버전에서 실행 가능해야 한다. JDK 11에서 정상적으로 동작하지 않을 경우 0점 처리한다.
• 프로그램 실행의 시작점은 Application의 main()이다.
• build.gradle 파일을 변경할 수 없고, 외부 라이브러리를 사용하지 않는다.
• Java 코드 컨벤션 가이드를 준수하며 프로그래밍한다.
• 프로그램 종료 시 System.exit()를 호출하지 않는다.
• 프로그램 구현이 완료되면 ApplicationTest의 모든 테스트가 성공해야 한다. 테스트가 실패할 경우 0점 처리한다.
• 프로그래밍 요구 사항에서 달리 명시하지 않는 한 파일, 패키지 이름을 수정하거나 이동하지 않는다.
• indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
  • 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
  • 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메서드)를 분리하면 된다.
• 3항 연산자를 쓰지 않는다.
• 함수(또는 메서드)가 한 가지 일만 하도록 최대한 작게 만들어라.
• JUnit 5와 AssertJ를 이용하여 본인이 정리한 기능 목록이 정상 동작함을 테스트 코드로 확인한다.

추가된 요구 사항

• 함수(또는 메서드)의 길이가 15라인을 넘어가지 않도록 구현한다.
  • 함수(또는 메서드)가 한 가지 일만 잘 하도록 구현한다.
• else 예약어를 쓰지 않는다.
  • 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
  • else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다.
• Java Enum을 적용한다.
• 도메인 로직에 단위 테스트를 구현해야 한다. 단, UI(System.out, System.in, Scanner) 로직은 제외한다.
  • 핵심 로직을 구현하는 코드와 UI를 담당하는 로직을 분리해 구현한다.
  • 단위 테스트 작성이 익숙하지 않다면 test/java/lotto/LottoTest를 참고하여 학습한 후 테스트를 구현한다.

라이브러리

• camp.nextstep.edu.missionutils에서 제공하는 Randoms 및 Console API를 사용하여 구현해야 한다.
  • Random 값 추출은 camp.nextstep.edu.missionutils.Randoms의 pickUniqueNumbersInRange()를 활용한다.
  • 사용자가 입력하는 값은 camp.nextstep.edu.missionutils.Console의 readLine()을 활용한다.

사용 예시

List<Integer> numbers = Randoms.pickUniqueNumbersInRange(1, 45, 6);

Lotto 클래스

• 제공된 Lotto 클래스를 활용해 구현해야 한다.
• Lotto에 매개 변수가 없는 생성자를 추가할 수 없다.
• numbers의 접근 제어자인 private을 변경할 수 없다.
• Lotto에 필드(인스턴스 변수)를 추가할 수 없다.
• Lotto의 패키지 변경은 가능하다.

public class Lotto {
    private final List<Integer> numbers;

    public Lotto(List<Integer> numbers) {
        validate(numbers);
        this.numbers = numbers;
    }

    private void validate(List<Integer> numbers) {
        if (numbers.size() != 6) {
            throw new IllegalArgumentException();
        }
    }

    // TODO: 추가 기능 구현
}

---

✏️ 과제 진행 요구 사항

• 미션은 java-lotto 저장소를 Fork & Clone해 시작한다.
• 기능을 구현하기 전 docs/README.md에 구현할 기능 목록을 정리해 추가한다.
• Git의 커밋 단위는 앞 단계에서 docs/README.md에 정리한 기능 목록 단위로 추가한다.
  • 커밋 메시지 컨벤션 가이드를 참고해 커밋 메시지를 작성한다.