🪐 우아한테크코스 6기 프리코스 - 1주차 회고

⭐️ 프리코스

지원서 작성을 마치고, 프리코스가 시작되었습니다!
1주차를 시작하기 1시간 전, OT가 있어 먼저 듣고 시작을 했네요😊
정리는 못했지만 내용 공유드릴게요.
🔗 ✨ 우아한테크코스 6기 프리코스 오리엔테이션내용 정리

⚾️ 1주차 온보딩 미션 - 숫자야구

1주차 미션은 숫자야구게임을 개발하는 것이었습니다.
요구사항은 크게
🟡 기능요구사항
🟡 프로그래밍 요구 사항
🟡 과제 진행 요구사항
이렇게 3가지로 나누어져 있었어요.

자세한 사항은 hayannn/java-baseball-6: 우아한테크코스 1주차 온보딩 미션 - 숫자야구에서 확인해주세요!!

1️⃣ 구현할 기능 목록 정리

우테코 이전에는 스스로 어떤 프로젝트를 할지 결정하고 개발을 하는 방식을 택해왔기 때문에 요구사항을 받아서 조건을 맞추는 연습을 할 수 없었기에 기능 목록을 정리하기 보다는 떠오르는 기능들을 추가하고 간단히 정리하는 방식으로 개발을 진행해왔습니다.
그러다보니, 어떤 기능을 구현했고 이 기능은 어떤 사용 목적을 가지는지 분명치못해 필요가 없는 기능을 개발하기도 했고, 누군가에게 설명하기에도 힘들었어요💦

그러다 우아한테크코스 프리코스를 시작하게 되며 과제 진행 요구사항 속
기능을 구현하기 전 docs/README.md에 구현할 기능 목록을 정리해 추가한다.
라는 조건을 받으며 문서화를 시작하게 되었습니다.

제 경우에는, 크게
🔹 숫자야구 게임의 정의
🔹 시나리오
🔹 기능 목록
🔹 궁금했어요
🔹 배웠어요
로 나누어 작성했습니다.

숫자 야구 게임의 기본적인 정의를 까먹지 않기 위해 정의를 가장 먼저 적었어요.
그 다음 기능 목록을 작성했습니다.
기능 목록은 패키지 별로 나누어 작성했어요!
그동안 spring을 사용한 개발 방식에 익숙하다보니 자연스레 패키지를 나누고 MVC 패턴을 적용할 생각부터 했습티다.

그런데 사실 이렇게 작성한 뒤 패키지 구조 외에 게임의 흐름을 쉽게 파악하기 힘들어 시나리오를 추가했다는 건 안비밀입니다🤫

• 작성한 시나리오는 다음과 같아요!

  1️⃣ 숫자 야구 게임의 시작을 위한 문구 출력
  
  숫자 야구 게임을 시작합니다.
  숫자를 입력해주세요 :
  
  2️⃣ 컴퓨터(상대방) -> 1에서 9까지 서로 다른 임의의 수 3개 선택
  
  3️⃣ 플레이어 -> 컴퓨터의 수를 예측하여 서로 다른 3자리의 수 입력
  
  [E1] 입력한 수가 중복되는 경우
  [E2] 수가 3자리 미만 또는 초과되는 경우
  [E3] 숫자의 범위가 1~9를 벗어나는 경우(수가 아닌 값 입력하는 경우도 포함)
  
  4️⃣ 컴퓨터와 플레이어의 수를 비교해 그 결과를 출력
  
  [Output] 스트라이크 : 같은 수가 같은 자리에 있는 경우
  [Output] 볼 : 같은 수가 다른 자리에 있는 경우
  [Output] 낫싱 : 같은 수가 전혀 없는 경우
  
  5️⃣ 현재 숫자 야구 게임 종료 및 게임 재시작 여부를 묻는 문구 출력
  
  3스트라이크 충족 시 출력
  3스트라이크
  3개의 숫자를 모두 맞히셨습니다! 게임 종료
  게임을 새로 시작하려면 1, 종료하려면 2를 입력하세요.
  3스트라이크 미충족 시 3️⃣~ 4️⃣ 번으로 돌아가 시나리오 반복
  [Caution] 3스트라이크를 충족할 때까지 반복해야 한다.
  
  6️⃣ 숫자 야구 게임의 재시작 or 종료(Complete Shutdown)
  
  플레이어의 입력 값에 의해 결정된다.
  1을 입력한 경우 -> 게임 재시작(New)
  2를 입력한 경우 -> 게임 종료 및 프로그램의 종료

• 기능 목록은 간단히 초기 구현 계획 당싱 적었던 패키지 구조를 먼저 보여드릴게요!
  (후에 리팩토링을 거쳐 View의 2가지 파일을 하나로 합치기 때문입니다😩)

  hayannn/java-baseball-6
  ├──  docs
  |    └── README.md
  |
  └──  src
       └── main/java/baseball
           ├── Controller
           |	 └── BaseballGameController.java        
           |
           ├── Domain
           |	 ├── Computer.java
           |   └── Player.java
           |
           ├── Exception
           |   ├── PlayerInputException.java
           |   └── ReplayOrQuitGameException.java
           |
           ├── Service
           |   ├── GameFlowManagementService.java
           |   └── GameNumberCheckService.java
           |
           ├── Util
           |   ├── ComputerNumberGenerator.java
           |   └── StringToArrayList.java
           |
           ├── View
           |   ├── FirstGamePlayerInputView.java
           |   ├── NextGamePlayerInputView.java
           |   └── GameScoreView.java
           |
           └── Application.java
  

• 궁금했어요 는 개발을 하며 궁금했던 부분을 정리한 것이며, 배웠어요 는 트러블슈팅에 관련된 간단한 정리입니다!

2️⃣ 개발

개발을 진행하며 있었던 많은 일은 주로 "일기"를 통해 정리했었어요.
그리고 commit의 순서대로 개발을 진행했고, 오류에 대한 트러블 슈팅 과정도 commit에 반영했습니다.

개발 순서
1. Domaian - Computer 개발
2. Util - ComputerNumberGenerator 개발
3. Exception 패키지 개발
4. Util - StringToArrayList 개발
5. Service 패키지 개발
6. View 패키지 개발
7. Controller 개발
8. Application.java 코드 추가
9. refactoring

그렇다보니 무려 50개에 달하는 commit 기록을 세워버렸네요🏅
하하
다음부터는 더 기능 위주의 commit을 하기 위해 계획을 세워야겠습니다.

3️⃣ 리팩토링

리팩토링은 정말 이번 우아한테크코스를 통해 처음 경험했습니다.
그렇다보니 가장 아쉬운 부분이 많은 것이 사실인데요🫠
간단한 변수명 수정, 필드와 생성자의 분리, 그리고 불필요한 View의 합치기 정도만 진행했습니다.

먼저 변수명은 ReplayOrQuitGameException.java 의 예외 처리에 있어 숫자의 종류가 1,2가 아닌 경우를 문자 입력을 포함한다는 점을 분명히 알리기 위해 변경했어요.

• 이전

...
//숫자의 종류가 1,2가 아닌 경우
    public void notRangeOfNumberCase(String numberCasesOfString) {
        if (!numberCasesOfString.matches(RE_NUMBER_REGEX)) {
            throw new IllegalArgumentException("1,2의 수 중 하나만을 입력해야 합니다.");
        }
    }
}

• 이후 : notRangeOfNumberOrCharacterCase로 변경

...
    //숫자의 종류가 1,2가 아닌 경우와 문자를 입력한 경우
    public void notRangeOfNumberOrCharacterCase(String numberCasesOfString) {
        if (!numberCasesOfString.matches(RE_NUMBER_REGEX)) {
            throw new IllegalArgumentException("1,2의 숫자 중 하나만을 입력해야 합니다.");
        }
    }
}

그리고 필드와 생성자를 분리하는 것은 다음의 코드처럼 진행했답니다😉
그 중 BaseballGameController.java 를 예로 들어 첨부하겠습니다!

• 이전

public class BaseballGameController {
    private Computer computer = new Computer();
    private Player player = new Player();

    /* 숫자의 비교를 통한 게임 진행을 위해 변수 생성 */
    private static final int STRIKE_COUNT_INDEX = 0; //현재 스트라이크 개수 -> 인덱스로 저장
    private static final int STRIKE_COUNT_THREE = 3; //현재의 스트라이크 개수와 비교하기 위한 3스트라이크의 값 생성
    private static final int STRIKE_COUNT_INDEX = 0; //현재 스트라이크 개수
    private static final int STRIKE_COUNT_THREE = 3; //비교를 위한 3스트라이크

    private final GameFlowManagementService gameFlowManagementService = new GameFlowManagementService(); //숫자 야구 게임의 흐름 및 다음 게임의 'Replay or Quit' question 담당 서비스를 연결
    private final GameNumberCheckService gameNumberCheckService = new GameNumberCheckService(); //컴퓨터와 플레이어의 숫자 비교-'스트라이크, 볼'을 카운트하는 서비스를 연결
    private final FirstGamePlayerInputView firstGamePlayerInputView = new FirstGamePlayerInputView(); //플레이어의 숫자 입력 실제 처리 및 저장하는 뷰를 연결
    private final GameScoreView gameScoreView = new GameScoreView(); //숫자 야구 게임의 플레이 상황에 따른 적절한 결과를 출력하는 뷰를 연결
    private List<Integer> countStrikeBall = new ArrayList<>(); //스트라이크와 볼의 개수 카운트하는 리스트 생성
...

• 이후 : 이렇게 초기화 위치를 BaseballGameController() 클래스로 분리하여 보기 편안하게 바꿨습니다.

public class BaseballGameController {
    private Computer computer;
    private Player player;
    private GameFlowManagementService gameFlowManagementService;
    private GameNumberCheckService gameNumberCheckService;
    private FirstGamePlayerInputView firstGamePlayerInputView;
    private GameScoreView gameScoreView;
    private List<Integer> countStrikeBall;

    private static final int STRIKE_COUNT_INDEX = 0; //현재 스트라이크 개수
    private static final int STRIKE_COUNT_THREE = 3; //비교를 위한 3스트라이크

    public BaseballGameController() { // 필드 선언 위치와 초기화 위치 분리
        computer = new Computer();
        player = new Player();
        gameFlowManagementService = new GameFlowManagementService();
        gameNumberCheckService = new GameNumberCheckService();
        firstGamePlayerInputView = new FirstGamePlayerInputView();
        gameScoreView = new GameScoreView();
        countStrikeBall = new ArrayList<>();
    }
...

마지막으로 나누었던 View를 합쳤습니다.
기존에는 First와 Next로 view를 나누었지만, 굳이 나누어서 view를 보여줄 필요성을 생각해보니 설득되는 근거가 없다는 판단을 해 합쳤습니다!

• 이전 패키지 구조

  ...
             |
             ├── View
             |   ├── FirstGamePlayerInputView.java
             |   ├── NextGamePlayerInputView.java
             |   └── GameScoreView.java
             |
             └── Application.java

• 변경된 패키지 구조

  ...
             |
             ├── View
             |   ├── GamePlayerInputView.java
             |   └── GameScoreView.java
             |
             └── Application.java

4️⃣ 결과는?

⭐️ 마치며

😮 반성할 점

당장의 MVC 패턴이나 규칙에 너무 얽매여 일반적인 구조를 짜는 것이 아닌, ‘나의 결정’으로 이루어진 구조를 만들어 나가자!

• 개발을 하는 과정에서 레퍼런스들을 찾아보고, 참고를 하는 것은 좋지만 이것이 너무 우선시되면 제 아이디어와 타인의 아이디어가 점점 구분되지 않는다는 점을 느꼈어요.
  뭔가..점점 제 의견이 아닌 것에 매몰이 된다고나 할까...? 그랬답니다.

• 그래서 앞으로는 만들어 가는 과정에서 충분히 패턴과 규칙을 적용하며 수정해나갈 수 있다는 점을 유념하며, 예시를 찾는 것보단 내가 스스로 먼.저. 생각해본다음 개발을 하고 나중에 아주 나중에 풀리지 않는 문제가 생겼을 때 찾아보자고 마음 먹었습니다.

🏃🏻‍♀️ 나아갈 점

변수명과 같이 네이밍을 사용할 때 조금 더 쉽고 직관적인 단어로 결정하자.

• 이 글을 여기까지 읽어오신 분은 이미 눈치채셨겠지만🙃 저는 TMI가 많은 편입니다..
  그렇다보니 자연스레 글도 길어지고, 이런 네이밍도 모든 설명을 넣으려 아등바등하는 편이라는 걸 이번에 느끼게 되었습니다.
• 앞으로는 ReplayOrQuitGameException 이런 방식보다는 ReplayGameException 이런식으로 불필요한 말을 제거하여 간단히 작성하겠습니다🙇‍♀️

궁금한 부분은 그때그때 적어두고, 찾아본 방식도 기록하자.

• 이렇게 1주차 회고를 남기면서도 사실 어떤 순서로 개발을 했고 어떻게 생각을 해왔는지 기억해내기가 생각보다 쉽지 않더라구요??
• 그래서 앞으로는 트러블슈팅을 하고, 어려운 부분과 궁금한 부분을 찾고 고민하는 과정에서 상황과 결과만 정리하기보다는 내가 참고했던 링크나 책 등을 왜 찾았는지, 그래서 어떤 부분을 참고했는지 등을 조금 더 자세하게 기록하고자 마음먹게 되었네요!!

긴 글 읽어주셔서 정말 감사합니다:)

개발 과정의 더 세세하고 재미있는 일들이 궁금하시다면 아래의 링크를 참고해주세요!
슬쩍 놓고 갑니다☺️
⚾️ Week1: 숫자 야구 게임

그럼 저는 이만 다음 주차로 가보겠습니다!!