hungryjayy/kotlin-subway-path

Subway game with Kotlin

지하철 노선도 & 경로 조회 미션

• 지하철 역과 노선을 관리하는 지하철 노선도 기능을 구현한다.
• 등록된 지하철 노선도에서 경로를 조회하는 기능을 구현한다.

🚀 초기 설정 - 공통

• 프로그램 시작 시 역, 노선, 구간 정보를 초기 설정 해야 한다.
• 거리와 소요 시간은 양의 정수이며 단위는 km와 분을 의미한다.
• 아래의 사전 등록 정보로 반드시 초기 설정을 한다.

 1. 지하철역으로 교대역, 강남역, 역삼역, 남부터미널역, 양재역, 양재시민의숲역, 매봉역이 등록되어 있다.
 2. 지하철 노선으로 2호선, 3호선, 신분당선이 등록되어 있다.
 3. 노선에 역이 아래와 같이 등록되어 있다.(왼쪽 끝이 상행 종점)
   - 2호선: 교대역 - ( 2km / 3분 ) - 강남역 - ( 2km / 3분 ) - 역삼역
   - 3호선: 교대역 - ( 3km / 2분 ) - 남부터미널역 - ( 6km / 5분 ) - 양재역 - ( 1km / 1분 ) - 매봉역
   - 신분당선: 강남역 - ( 2km / 8분 ) - 양재역 - ( 10km / 3분 ) - 양재시민의숲역

🚀 기능 요구사항 - 노선도

지하철 역 관련 기능

• 지하철 역을 등록하고 삭제할 수 있다. (단, 노선에 등록된 역은 삭제할 수 없다)
• 중복된 지하철 역 이름이 등록될 수 없다.
• 지하철 역 이름은 2글자 이상이어야 한다.
• 지하철 역의 목록을 조회할 수 있다.

지하철 노선 관련 기능

• 지하철 노선을 등록하고 삭제할 수 있다.
• 중복된 지하철 노선 이름이 등록될 수 없다.
• 지하철 노선 이름은 2글자 이상이어야 한다.
• 노선 등록 시 상행 종점역과 하행 종점역, 구간 거리, 소요 시간을 입력받는다.
• 지하철 노선의 목록을 조회할 수 있다.

지하철 구간 추가 기능

• 하나의 역은 여러개의 노선에 추가될 수 있다.
• 역과 역 사이에 새로운 역이 추가 될 수 있다.
• 이미 존재하는 구간은 등록할 수 없다.
  • 교대 - 강남 - 역삼 구간이 등록되어 있다면 교대 - 역삼 구간은 등록할 수 없다.
• 기존의 구간 사이에 새로운 구간을 등록할 경우 구간을 이어줘야 한다.
  • 교대 - 역삼 구간이 등록되어 있는데 교대 - 강남 구간을 등록하면 교대 - 강남 - 역삼 구간으로 수정되어야 한다. 즉 강남 - 역삼 구간이 자동적으로 등록된다.
  • 위와 같은 상황에서 자동으로 추가되는 구간(강남 - 역삼)은 거리 2km, 시간 3분으로 고정되어 추가된다.
• 노선에서 갈래길은 생길 수 없다.

지하철 구간 삭제 기능

• 노선에 등록된 역을 제거할 수 있다.
• 종점을 제거할 경우 다음(또는 이전) 역이 종점이 된다.
• 노선에 포함된 역이 두개 이하일 때는 역을 제거할 수 없다.
• 구간을 제거할 경우 기존에 걸렸던 소요 시간을 변경된 구간에 적용한다.
  • 교대 - ( 2km / 3분 ) - 강남 - ( 2km / 3분 ) - 역삼 구간에서 교대 - 강남 구간을 삭제하면 교대 - (4km / 6분) - 역삼 구간으로 변경된다.
• 직접 연결된 구간이 아닐 경우(구간 사이에 다른 역이 존재할 경우) 삭제가 불가능하다.

지하철 노선에 등록된 역 조회 기능

• 노선의 상행 종점부터 하행 종점까지 연결된 순서대로 역 목록을 조회할 수 있다.

🚀 기능 요구사항 - 경로 조회

경로 조회 기능

• 출발역과 도착역을 입력받아 경로를 조회한다.
• 경로 조회 시 총 거리, 총 소요 시간도 함께 출력한다.
• 경로 조회 기준은 최단 거리 최소 시간이 있다.

예외 처리

• 경로 조회 시 출발역과 도착역이 같으면 에러를 출력한다.
• 경로 조회 시 출발역과 도착역이 연결되어 있지 않으면 에러를 출력한다.
• 그 외 정상적으로 프로그램이 수행되지 않은 경우 에러를 출력한다.

✍🏻 입출력 요구사항

• 프로그래밍 실행 결과 예시를 참고하여 입출력을 구현한다.
• 기대하는 출력 결과는 [INFO]를 붙여서 출력한다. 출력값의 형식은 예시와 동일하게 한다.
• 에러 발생 시 [ERROR]를 붙여서 출력한다. (에러의 문구는 자유롭게 작성한다.)

💻 프로그래밍 실행 결과

역 관리

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
1

## 역 관리 화면
1. 역 등록
2. 역 삭제
3. 역 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 등록할 역 이름을 입력하세요.
잠실역

[INFO] 지하철 역이 등록되었습니다.

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
1

## 역 관리 화면
1. 역 등록
2. 역 삭제
3. 역 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
3

## 역 목록
[INFO] 교대역 
[INFO] 강남역
[INFO] 역삼역
[INFO] 남부터미널역
[INFO] 양재역
[INFO] 양재시민의숲역
[INFO] 매봉역
[INFO] 잠실역

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
1

## 역 관리 화면
1. 역 등록
2. 역 삭제
3. 역 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
2

## 삭제할 역 이름을 입력하세요.
잠실역

[INFO] 지하철 역이 삭제되었습니다.

...

노선 관리

...

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
2

## 노선 관리 화면
1. 노선 등록
2. 노선 삭제
3. 노선 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 등록할 노선 이름을 입력하세요.
1호선

## 등록할 노선의 상행 종점역 이름을 입력하세요.
강남역

## 등록할 노선의 하행 종점역 이름을 입력하세요.
잠실역

## 구간 거리(km)를 입력하세요.
2

## 소요 시간(분)을 입력하세요.
3

[INFO] 지하철 노선이 등록되었습니다.

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
2

## 노선 관리 화면
1. 노선 등록
2. 노선 삭제
3. 노선 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
3

## 노선 목록
[INFO] 2호선
[INFO] 3호선
[INFO] 신분당선
[INFO] 1호선

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
2

## 노선 관리 화면
1. 노선 등록
2. 노선 삭제
3. 노선 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
2

## 삭제할 노선 이름을 입력하세요.
1호선

[INFO] 지하철 노선이 삭제되었습니다.

...

구간 관리

...

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
3

## 구간 관리 화면
1. 구간 등록
2. 구간 삭제
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 노선을 입력하세요.
2호선

## 상행역을 입력하세요.
역삼역

## 하행역을 입력하세요.
잠실역

## 구간 거리(km)를 입력하세요.
2

## 소요 시간(분)을 입력하세요.
3

[INFO] 구간이 등록되었습니다.

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
3

## 구간 관리 화면
1. 구간 등록
2. 구간 삭제
B. 돌아가기

## 원하는 기능을 선택하세요.
2

## 삭제할 구간의 노선을 입력하세요.
2호선

## 삭제할 구간의 상행역을 입력하세요.
역삼역

## 삭제할 구간의 하행역을 입력하세요.
잠실역

[INFO] 구간이 삭제되었습니다.

...

지하철 노선도 출력

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
4

## 지하철 노선도
[INFO] 2호선
[INFO] ---
[INFO] 교대역
[INFO] 2km / 3분
[INFO] 강남역
[INFO] 2km / 3분
[INFO] 역삼역

[INFO] 3호선
[INFO] ---
[INFO] 교대역
[INFO] 3km / 2분
[INFO] 남부터미널역
[INFO] 6km / 5분
[INFO] 양재역
[INFO] 1km / 1분
[INFO] 매봉역

[INFO] 신분당선
[INFO] ---
[INFO] 강남역
[INFO] 2km / 8분
[INFO] 양재역
[INFO] 10km / 3분
[INFO] 양재시민의숲역

경로 조회

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
5

## 경로 기준
1. 최단 거리
2. 최소 시간
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 출발역을 입력하세요.
교대역

## 도착역을 입력하세요.
양재역

## 조회 결과
[INFO] ---
[INFO] 총 거리: 4km
[INFO] 총 소요 시간: 11분
[INFO] ---
[INFO] 교대역
[INFO] 강남역
[INFO] 양재역

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

...

에러 출력 예시

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
7

[ERROR] 선택할 수 없는 기능입니다.

## 원하는 기능을 선택하세요.
1

## 역 관리 화면
1. 역 등록
2. 역 삭제
3. 역 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 등록할 역 이름을 입력하세요.
강남역

[ERROR] 이미 등록된 역 이름입니다. 

## 역 관리 화면
1. 역 등록
2. 역 삭제
3. 역 조회
B. 돌아가기

## 원하는 기능을 선택하세요.
B

## 메인 화면
1. 역 관리
2. 노선 관리
3. 구간 관리
4. 지하철 노선도 출력
5. 경로 조회
Q. 종료

## 원하는 기능을 선택하세요.
5

## 경로 기준
1. 최단 거리
2. 최소 시간 
B. 돌아가기

## 원하는 기능을 선택하세요.
1

## 출발역을 입력하세요.
강남역

## 도착역을 입력하세요.
강남역

[ERROR] 출발역과 도착역이 동일합니다.

## 경로 기준
1. 최단 거리
2. 최소 시간 
B. 돌아가기

## 원하는 기능을 선택하세요.

...

🎱 프로그래밍 요구사항

• 코틀린 코드 컨벤션을 지키면서 프로그래밍한다.
  • Kotlin Coding Conventions
  • 단, 들여쓰기는 '2 spaces'가 아닌 '4 spaces'로 한다.
• indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
  • 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
  • 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다.
• 3항 연산자를 쓰지 않는다.
• 함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.
  • 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.
• else 예약어를 쓰지 않는다.
  • 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
• 프로그래밍 요구사항에서 별도로 변경 불가 안내가 없는 경우 파일 수정과 패키지 이동을 자유롭게 할 수 있다.
• 예외 상황 시 에러 문구를 출력해야 한다. 단, 에러 문구는 [ERROR] 로 시작해야 한다.

프로그래밍 요구사항 - Station, Line

• Station, Line 클래스를 활용하여 지하철역과 노선을 구현해야 한다.
• 제공하는 각 클래스의 기본 생성자를 추가할 수 없다.
• 가능하면 setter를 추가하지 않고 구현한다.

class Station(val name: String)

프로그래밍 요구사항 - StationRepository, LineRepository

• Station과 Line의 상태를 저장할 수 있는 StationRepository, LineRepository를 제공한다.
• 필요 시 StationRepository, LineRepository 이 외 추가로 Repository를 만들 수 있다.
• 추가로 생성되는 객체에 대해서 XXXRepository 네이밍으로 저장 클래스를 추가할 수 있다.
• 객체들의 상태를 관리하기 위해서 XXXRepository 클래스를 활용해 저장 로직을 구현해야 한다.
• 필요에 따라 자유롭게 수정이 가능하다.

object StationRepository {
    private val stations = mutableListOf<Station>()

    fun stations() = stations.toList()

    fun addStation(station: Station) {
        stations.add(station)
    }

    fun deleteStation(name: String) = stations.removeIf { it.name == name }
}

❗️힌트

최단 경로 라이브러리

• jgrapht 라이브러리를 활용하면 간편하게 최단거리를 조회할 수 있음
• Dijkstra 알고리즘을 반드시 이해할 필요는 없고 미션에 적용할 정도로만 이해하면 됨
• JGraphtTest 클래스의 테스트를 활용하여 미션에 필요한 라이브러리의 기능을 학습할 수 있음
• 정점(vertex)과 간선(edge), 그리고 가중치 개념을 이용
  • 정점: 지하철역
  • 간선: 지하철역 연결정보
  • 가중치: 거리 or 소요 시간
• 최단 거리 기준 조회 시 가중치를 거리로 설정

@Test
internal fun getDijkstraShortestPath() {
    val graph = WeightedMultigraph<String, DefaultWeightedEdge>(DefaultWeightedEdge::class.java)
    graph.addVertex("v1")
    graph.addVertex("v2")
    graph.addVertex("v3")
    graph.setEdgeWeight(graph.addEdge("v1", "v2"), 2.0)
    graph.setEdgeWeight(graph.addEdge("v2", "v3"), 2.0)
    graph.setEdgeWeight(graph.addEdge("v1", "v3"), 100.0)

    val dijkstraShortestPath = DijkstraShortestPath(graph)
    val shortestPath = dijkstraShortestPath.getPath("v3", "v1").vertexList

    assertThat(shortestPath.size).isEqualTo(3)
}

테스트 설명

• 역 사이의 거리를 고려하지 않는 경우 V1->V3 경로가 최단 경로
• 역 사이의 거리를 고려할 경우 V1->V3 경로의 거리는 100km, V1->V2->V3 경로의 거리는 4km이므로 최단 경로는 V1->V2->V3

📈 진행 요구사항

• 미션은 kotlin-subway-path 저장소 를 fork/clone해 시작한다.
• 기능을 구현하기 전에 kotlin-subway-map/docs/README.md 파일에 구현할 기능 목록을 정리해 추가한다.
• git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가한다.
  • AngularJS Commit Message Conventions를 참고해 commit log를 남긴다.