/java-pairmatching-development

페어 매칭을 끝까지 구현하고 완성하기 위한 저장소

Primary LanguageJava

페어 매칭 프로그램

Code: Java

소개

  • 페어 매칭을 구현하고 완성하기 위한 저장소 프리코스 회고 바로가기
  • 지난 프리코스 최종 테스트 문제였던 "페어매칭"을 완전히 구현하는 것을 목표로한다.

구현할 기능 목록

  • 시작시, 기능의 종류 목록을 출력하는 기능
  • 코스별 크루 명단을 초기화하는 기능
  • 기능의 종류를 선택하는 기능
    [예외]
    - 기능의 종류가 존재하지 않는 기능인 경우 ( 현존하는 기능 : 1, 2, 3, Q )
    

페어 매칭 - 기능 목록에서 "1"입력시

  • 과정과 미션을 출력하는 기능

  • 과정, 레벨, 미션을 입력 받아 페어를 매칭하는 기능

    [예외]
    - 쉼표(,)로 구분하여 과정, 레벨, 미션 단위로 나누어지지 않으면 예외처리
    - 과정, 레벨, 미션의 각 항목이 존재하지 않으면 예외처리
    - 매칭 이력이 없으면 예외처리
    
  • 페어가 매치된 결과를 출력하는 기능

    매칭 정보가 있을 경우

    • 매칭 재시도를 묻는 문구를 출력하는 기능
    • 매칭 재시도 여부를 입력 받는 기능
      [예외]
      - 존재하는 명령이 아니면 예외처리 ( 현존하는 명령 : 네, 아니오 )
      

페어 조회 - 기능 목록에서 "2"입력시

  • 과정과 미션을 출력하는 기능
  • 과정, 레벨, 미션을 입력 받아 페어를 조회하는 기능
    [예외]
    - 쉼표(,)로 구분하여 과정, 레벨, 미션 단위로 나누어지지 않으면 예외처리
    - 과정, 레벨, 미션의 각 항목이 존재하지 않으면 예외처리
    

페어 초기화 - 기능 목록에서 "3"입력시

  • 페어를 초기화하는 기능

종료 - 기능 목록에서 "Q"입력시

  • 프로그램을 종료하는 기능

최종 디렉토리 구조

└─java-pairmatching-development
    └─src
        ├─main
        │  ├─java
        │  │  └─pairmatching
        │  │      │  Application.java
        │  │      │  PairMatching.java
        │  │      │
        │  │      ├─common
        │  │      │      AnswerType.java
        │  │      │      Course.java
        │  │      │      Level.java
        │  │      │      MainCategory.java
        │  │      │      Mission.java
        │  │      │
        │  │      ├─controller
        │  │      │      MatchingController.java
        │  │      │
        │  │      ├─domain
        │  │      │      Matching.java
        │  │      │      MatchingRecords.java
        │  │      │      Pair.java
        │  │      │      Pairs.java
        │  │      │
        │  │      ├─util
        │  │      │      CrewNameReader.java
        │  │      │
        │  │      └─view
        │  │              InputView.java
        │  │              OutputView.java
        │  │
        │  └─resources
        │          backend-crew.md
        │          frontend-crew.md
        │
        └─test
            └─java
                └─pairmatching
                        ApplicationTest.java

✔️ Requirement

✔️ Initialize

$ git clone https://github.com/xfrnk2/java-pairmatching-development.git

✔️ Test

Mac or Linux

$ ./gradlew clean test

Windows

$ gradlew.bat clean test

미션 - 페어매칭관리 애플리케이션

🔍 진행방식

  • 미션은 기능 요구사항, 프로그래밍 요구사항, 과제 진행 요구사항 세 가지로 구성되어 있다.
  • 세 개의 요구사항을 만족하기 위해 노력한다. 특히 기능을 구현하기 전에 기능 목록을 만들고, 기능 단위로 커밋 하는 방식으로 진행한다.
  • 기능 요구사항에 기재되지 않은 내용은 스스로 판단하여 구현한다.

✉️ 미션 제출 방법

  • 미션 구현을 완료한 후 GitHub을 통해 제출해야 한다.
  • GitHub에 미션을 제출한 후 우아한테크코스 지원 플랫폼 에 접속하여 프리코스 과제를 제출한다.
    • 자세한 방법은 링크 를 참고한다.
    • Pull Request만 보내고, 지원 플랫폼에서 과제를 제출하지 않으면 최종 제출하지 않은 것으로 처리되니 주의한다.

✔️ 과제 제출 전 체크리스트 - 0점 방지

  • 터미널에서 java -version을 실행해 자바 8인지 확인한다. 또는 Eclipse, IntelliJ IDEA와 같은 IDE의 자바 8로 실행하는지 확인한다.
  • 터미널에서 맥 또는 리눅스 사용자의 경우 ./gradlew clean test, 윈도우 사용자의 경우 gradlew.bat clean test 명령을 실행했을 때 모든 테스트가 아래와 같이 통과하는지 확인한다.
BUILD SUCCESSFUL in 0s

🚀 기능 요구사항

  • 우테코의 미션은 페어 프로그래밍으로 진행된다.
  • 미션을 함께할 페어를 관리해주는 애플리케이션을 완성하시오.

도메인 설명

  • 우테코에서 운영하는 과정은 현재 백엔드 과정과 프론트엔드 과정이 있다.
  • 각 과정은 5단계로 나누어 진행이 되는데 이를 레벨이라고 한다.
  • 미션을 수행하며 각 레벨에서 전달하고자 하는 내용을 학습하는데 이 과정을 페어 프로그래밍으로 진행한다.
  • 미션을 시작하기 전 페어를 매칭하는데 다양한 페어를 만나기 위해서 같은 레벨 동안은 같은 페어를 만나지 않는다.

페어 매칭 기능

  • 페어 매칭 조건
- 미션을 함께 수행할 페어를 두명씩 매칭한다.
- 페어 매칭 대상이 홀수인 경우 한 페어는 3인으로 구성한다.
- 같은 레벨에서 이미 페어를 맺은 크루와는 다시 페어로 매칭될 수 없다.
  • 페어 매칭 구현 방법
- 크루들의 이름 목록을 List<String> 형태로 준비한다.
- 크루 목록의 순서를 랜덤으로 섞는다. 이 때 `camp.nextstep.edu.missionutils.Randoms`의 shuffle 메서드를 활용해야 한다.
- 랜덤으로 섞인 페어 목록에서 페어 매칭을 할 때 앞에서부터 순서대로 두명씩 페어를 맺는다.
- 홀수인 경우 마지막 남은 크루는 마지막 페어에 포함시킨다.
- 같은 레벨에서 이미 페어로 만난적이 있는 크루끼리 다시 페어로 매칭 된다면 크루 목록의 순서를 다시 랜덤으로 섞어서 매칭을 시도한다.
- 3회 시도까지 매칭이 되지 않거나 매칭을 할 수 있는 경우의 수가 없으면 에러 메시지를 출력한다.
> 코드 예시

List<String> crewNames; // 파일에서 로드한 크루 이름 목록
List<String> shuffledCrew = Randoms.shuffle(crewNames); // 섞인 크루 이름 목록

// 페어 매칭 & 검증

...
  • 페어 재매칭 시도
- 안내 문구를 출력 후 매칭을 진행한다.
- 아니오를 선택할 경우 코스, 레벨, 미션을 다시 선택한다.

페어 조회 기능

  • 과정, 레벨, 미션을 선택하면 해당 미션의 페어 정보를 출력한다.
  • 매칭 이력이 없으면 매칭 이력이 없다고 안내한다.
[ERROR] 매칭 이력이 없습니다.

💾 사전 제공 정보

  • 크루 정보는 src/resources 하위에 md 파일로 제공되며 변경이 가능하다.
  • 과정, 레벨, 미션 정보는 아래에 제공하는 그대로 사용해야 한다.
## 과정
- 백엔드
- 프론트엔드

## 레벨
- 레벨1
- 레벨2
- 레벨3
- 레벨4
- 레벨5

## 미션
### 레벨1
- 자동차경주
- 로또
- 숫자야구게임

### 레벨2
- 장바구니
- 결제
- 지하철노선도

### 레벨3(없음)

### 레벨4
- 성능개선
- 배포

### 레벨5 (없음)

✍🏻 입출력 요구사항

파일 입출력

  • 페어 매칭에 필요한 크루들의 이름을 파일 입출력을 통해 불러온다.
  • src/main/resources/backend-crew.mdsrc/main/resources/frontend-crew.md 파일을 이용한다.
  • 두 파일의 내용은 수정이 가능하다. 수정 시 크루들의 이름은 중복될 수 없다.
  • 파일 입출력 방법은 자바 파일 읽기자바 파일 입출력과 같은 키워드로 구글링해서 찾을 수 있다.

에러 처리

  • 사용자가 잘못된 값을 입력할 경우 IllegalArgumentException를 발생시키고, [ERROR]로 시작하는 에러 메시지를 출력 후 해당 부분부터 다시 입력을 받는다.
  • 아래의 프로그래밍 실행 결과 예시와 동일하게 입력과 출력이 이루어져야 한다.

기능 선택

  • 프로그램을 시작하면 기능의 종류를 출력하고 그 중 하나의 입력을 받는다.
기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료

페어 매칭

  • 과정와 미션을 출력하고 매칭하고자 하는 과정, 레벨, 미션을 입력 받는다.
#############################################
과정: 백엔드 | 프론트엔드
미션:
  - 레벨1: 자동차경주 | 로또 | 숫자야구게임
  - 레벨2: 장바구니 | 결제 | 지하철노선도
  - 레벨3:
  - 레벨4: 성능개선 | 배포
  - 레벨5:
############################################
과정, 레벨, 미션을 선택하세요.
ex) 백엔드, 레벨1, 자동차경주
  • 매칭이 정상적으로 수행되면 결과가 출력된다.
  • 출력되는 페어의 순서는 camp.nextstep.edu.missionutils.Randoms의 shuffle 메서드의 결과 순서로 정렬한다.
페어 매칭 결과입니다.
용팔 : 대만
대협 : 덕규
치수 : 준호
태웅 : 백호
달재 : 태산
한나 : 수겸
태섭 : 대남
준섭 : 소연
현준 : 호열
구식 : 경태

프로그래밍 실행 결과 예시

기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료
1

#############################################
과정: 백엔드 | 프론트엔드
미션:
  - 레벨1: 자동차경주 | 로또 | 숫자야구게임
  - 레벨2: 장바구니 | 결제 | 지하철노선도
  - 레벨3:
  - 레벨4: 성능개선 | 배포
  - 레벨5:
############################################
과정, 레벨, 미션을 선택하세요.
ex) 백엔드, 레벨1, 자동차경주
프론트엔드, 레벨1, 자동차경주

페어 매칭 결과입니다.
다비 : 신디
쉐리 : 덴버
제키 : 로드
라라 : 윌터
니콜 : 이브
린다 : 시저
보노 : 제시 : 제키

기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료
1

#############################################
과정: 백엔드 | 프론트엔드
미션:
  - 레벨1: 자동차경주 | 로또 | 숫자야구게임
  - 레벨2: 장바구니 | 결제 | 지하철노선도
  - 레벨3:
  - 레벨4: 성능개선 | 배포
  - 레벨5:
############################################
과정, 레벨, 미션을 선택하세요.
ex) 백엔드, 레벨1, 자동차경주
프론트엔드, 레벨1, 자동차경주

매칭 정보가 있습니다. 다시 매칭하시겠습니까?
네 | 아니오
아니오

과정, 레벨, 미션을 선택하세요.
ex) 백엔드, 레벨1, 자동차경주
프론트엔드, 레벨1, 자동차경주
매칭 정보가 있습니다. 다시 매칭하시겠습니까?
네 | 아니오
네

페어 매칭 결과입니다.
이브 : 윌터
보노 : 제키
신디 : 로드
제시 : 린다
시저 : 라라
니콜 : 다비
리사 : 덴버 : 제키

기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료
2

#############################################
과정: 백엔드 | 프론트엔드
미션:
  - 레벨1: 자동차경주 | 로또 | 숫자야구게임
  - 레벨2: 장바구니 | 결제 | 지하철노선도
  - 레벨3:
  - 레벨4: 성능개선 | 배포
  - 레벨5:
############################################
과정, 레벨, 미션을 선택하세요.
ex) 백엔드, 레벨1, 자동차경주
프론트엔드, 레벨1, 자동차경주

페어 매칭 결과입니다.
이브 : 윌터
보노 : 제키
신디 : 로드
제시 : 린다
시저 : 라라
니콜 : 다비
리사 : 덴버 : 제키

기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료
3

초기화 되었습니다.

기능을 선택하세요.
1. 페어 매칭
2. 페어 조회
3. 페어 초기화
Q. 종료
Q

🎱 프로그래밍 요구사항

  • 프로그램을 실행하는 시작점은 Applicationmain()이다.
  • JDK 8 버전에서 실행 가능해야 한다. JDK 8에서 정상 동작하지 않을 경우 0점 처리한다.
  • 자바 코드 컨벤션을 지키면서 프로그래밍한다.
  • indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
    • 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
    • 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다.
  • 3항 연산자를 쓰지 않는다.
  • 함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.
    • 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.
  • else 예약어를 쓰지 않는다.
    • 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
    • else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다.
  • build.gradle 파일을 변경할 수 없고, 외부 라이브러리를 사용하지 않는다.
  • 프로그램 종료 시 System.exit()를 호출하지 않는다.
  • 프로그래밍 요구사항에서 별도로 변경 불가 안내가 없는 경우 파일 수정과 패키지 이동을 자유롭게 할 수 있다.

프로그래밍 요구사항 - Randoms, Console

  • JDK에서 기본 제공하는 Random, Scanner API 대신 camp.nextstep.edu.missionutils에서 제공하는 Randoms, Console API를 활용해 구현해야 한다.
    • Random 값 추출은 camp.nextstep.edu.missionutils.Randomsshuffle()를 활용한다.
    • 사용자가 입력하는 값은 camp.nextstep.edu.missionutils.ConsolereadLine()을 활용한다.
  • 프로그램 구현을 완료했을 때 src/test/java 디렉터리의 ApplicationTest에 있는 모든 테스트 케이스가 성공해야 한다. 테스트가 실패할 경우 0점 처리한다.

❗️ 힌트

  • 아래의 힌트를 참고하여 진행해도 좋다.
  • 반드시 아래의 힌트를 따라해야하는 것은 아니며 사용하지 않아도 되고 수정도 가능하다.

과정

public enum Course {
  BACKEND("백엔드"),
  FRONTEND("프론트엔드");

  private String name;

  Course(String name) {
    this.name = name;
  }

  // 추가 기능 구현
}

레벨

public enum Level {
  LEVEL1("레벨1"),
  LEVEL2("레벨2"),
  LEVEL3("레벨3"),
  LEVEL4("레벨4"),
  LEVEL5("레벨5");

  private String name;

  Level(String name) {
    this.name = name;
  }

  // 추가 기능 구현
}

크루

public class Crew {
    private Course course;
    private String name;
}

📈 과제 진행 요구사항

  • 미션은 java-pairmatching-precourse 저장소를 Fork/Clone해 시작한다.
  • 기능을 구현하기 전에 java-pairmatching-precourse/docs/README.md 파일에 구현할 기능 목록을 정리해 추가한다.
  • Git의 커밋 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가한다.
  • 과제 진행 및 제출 방법은 프리코스 과제 제출 문서 를 참고한다.