Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
58b33ed
docs(README.md): 기능 요구사항 정의
cmg1411 Dec 19, 2020
080b222
feat: 메인 메뉴 출력
cmg1411 Dec 19, 2020
0856ded
feat: 사용자의 입력을 받음
cmg1411 Dec 19, 2020
1f98f42
feat: 경로 조회 기준 페이지 출력
cmg1411 Dec 19, 2020
46c25af
feat: 메인 메뉴에서 선택에 따라 기능 분기
cmg1411 Dec 19, 2020
255864a
feat: 경로 기준 페이지에서 선택에 따라 분기하는 골격 구현
cmg1411 Dec 19, 2020
b6925ca
docs(README.md): 리드미 업데이트
cmg1411 Dec 19, 2020
c6c9dea
style: 코드 컨벤션을 준수하도록 수정
cmg1411 Dec 19, 2020
0584e9b
feat: 노선에서 역의 리스트를 가지도록 구현
cmg1411 Dec 19, 2020
439cb46
feat: 역 사이의 거리와 소요시간을 section으로 정의 및 구현
cmg1411 Dec 19, 2020
3c6418b
style: repository, controller, menu별로 패키지 구성
cmg1411 Dec 19, 2020
077f79a
feat: 프로그램 시작 시 역, 노선, section 정보 초기화
cmg1411 Dec 19, 2020
13f41a2
feat: 출발역과 도착역을 입력받고 예외를 처리하는 기능 구현
cmg1411 Dec 19, 2020
815992a
fix: 객체 생성 누락 수정
cmg1411 Dec 19, 2020
d43980d
refactor: 서비스 공통부분 인터페이스로 이동
cmg1411 Dec 19, 2020
12a41b7
fix: 에러가 두번 출력되는 오류 수정
cmg1411 Dec 19, 2020
004704d
refactor: 출발역을 입력받는 부분과 도착역을 입력받는 부분을 분리
cmg1411 Dec 19, 2020
d90093c
feat: 두 역이 연결되어 있지 않으면 예외 출력
cmg1411 Dec 19, 2020
e570cc5
feat: 이름이 같으면 같은 객체임을 위해 equals, hashCode 메소드 오버라이딩
cmg1411 Dec 19, 2020
8ca210a
feat: application 클래스에서 초기 데이터를 셋팅하고 프로그램을 구동하는 코드 구현
cmg1411 Dec 19, 2020
dc96057
feat: 최단 거리 구하는 클래스 구현중
cmg1411 Dec 19, 2020
d6ef032
feat: section의 동일성 확인을 위한 equals, hashcode 메소드 오버라이딩
cmg1411 Dec 22, 2020
b902282
feat: 역이 연결되었는지 확인하는 로직 오류로 인한 삭제
cmg1411 Dec 22, 2020
2eee6d3
feat: 최단거리로 경로를 구하고 경로 출력하는 기능 구현
cmg1411 Dec 22, 2020
6b5e0b9
refactor: 경로에서 시간과 거리를 계산하는 로직은 공통부분이므로 인터페이스로 이동
cmg1411 Dec 22, 2020
81ee171
feat: 최단 시간으로 경로 계산하는 기능 구현
cmg1411 Dec 22, 2020
9af6db4
docs(README.md): 리드미 문서 갱신
cmg1411 Dec 22, 2020
7c1556d
refactor: 쓰지않는 import 제거, import에 와일드카드 제거
cmg1411 Dec 22, 2020
45ce773
refactor: 출력을 담당하는 유틸리티성 클래스를 private생성자를 통해 객체생성 방지
cmg1411 Dec 22, 2020
36426c1
refactor: 상수 네이밍 대문자로 수정
cmg1411 Dec 22, 2020
d1b1287
refactor: 앱을 시작할 때 모든 리포지토리를 초기화하는 작업을 하나의 메서드로 떼어냄
cmg1411 Dec 22, 2020
302ebf9
style: 에러출력 prefix 오타수정
cmg1411 Dec 22, 2020
a18fa07
refactor: Controller 인터페이스로 모든 인터페이스를 관리
cmg1411 Dec 22, 2020
944a6aa
refactor: Distance클래스의 getDistance()와 RequireResources클래스의 getDistanc…
cmg1411 Dec 22, 2020
6382bbd
refactor: 에러메세지 출력포멧 공백라인 추가
cmg1411 Dec 22, 2020
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
264 changes: 36 additions & 228 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,253 +1,61 @@
# 지하철 노선도 경로 조회 미션
- 등록된 지하철 노선도에서 경로를 조회하는 기능을 구현한다.

<br>
등록된 지하철 노선도에서 최단 거리/최소 시간으로 경로를 조회하는 프로그램

## 🚀 기능 요구사항
## 기능 목록

> 프리코스 3주차 미션에서 사용한 코드를 참고해도 무관하다.
- [x] 프로그램 시작 시 역, 노선, 구간 정보를 초기 설정한다.

### 초기 설정
- 프로그램 시작 시 역, 노선, 구간 정보를 초기 설정 해야 한다.
- 거리와 소요 시간은 양의 정수이며 단위는 km와 분을 의미한다.
- 아래의 사전 등록 정보로 반드시 초기 설정을 한다.
- [x] 메인 메뉴를 출력하고 사용자의 선택을 입력을 받는다.

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

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

### 예외 처리
- 경로 조회 시 출발역과 도착역이 같으면 에러를 출력한다.
- 경로 조회 시 출발역과 도착역이 연결되어 있지 않으면 에러를 출력한다.
- 그 외 정상적으로 프로그램이 수행되지 않은 경우 에러를 출력한다.
- [x] 메인 메뉴를 출력한다.
- [x] 사용자의 입력을 받는다.
- [x] 1 을 입력받으면 경로 조회 화면으로 전환한다.
- [x] Q 를 입력받으면 프로그램을 종료한다.
- [x] [예외 처리] 메뉴에 없는 값을 입력받으면 에러를 출력한다.

<br>
- [x] 경로를 조회할 기준을 출력하고 사용자의 선택을 입력받는다.

## ✍🏻 입출력 요구사항
- `프로그래밍 실행 결과 예시`와 동일하게 입출력을 구현한다.
- 기대하는 출력 결과는 `[INFO]`를 붙여서 출력한다. 출력값의 형식은 예시와 동일하게 한다.
- 에러 발생 시 `[ERROR]`를 붙여서 출력한다. 에러의 문구는 자유롭게 작성한다.
- [x] 경로를 조회할 기준 메뉴를 출력한다.
- [x] 1 을 입력받으면 최단 거리를 기준으로 경로를 조회한다.
- [x] 2 를 입력받으면 최소 시간을 기준으로 경로를 조회한다.
- [x] B 를 입력받으면 메인 메뉴로 돌아간다.
- [x] [예외 처리] 메뉴에 없는 값을 입력받으면 에러를 출력한다.

### 💻 프로그래밍 실행 결과 예시
#### 경로 조회
```
## 메인 화면
1. 경로 조회
Q. 종료
- [x] 경로를 조회하는 기능에서는 출발역과 도착역을 설정한다.
- [x] 출발역을 입력받는다.
- [x] 도착역을 입력받는다.
- [x] [예외 처리] 등록되지 않은 역을 입력받으면 에러를 출력한다.
- [x] [예외 처리] 입력받은 출발역과 도착역이 같으면 에러를 출력한다.

## 원하는 기능을 선택하세요.
1
- [x] 출발역에서 도착역까지 가는 최단 거리 경로를 구한다.

## 경로 기준
1. 최단 거리
2. 최소 시간
B. 돌아가기
- [x] [예외 처리] 출발 역과 도착역이 연결되어 있지 않으면 에러를 출력한다.

## 원하는 기능을 선택하세요.
1
- [x] 출발역에서 도착역까지 가는 최단 시간 경로를 구한다.

## 출발역을 입력하세요.
교대역
- [x] [예외 처리] 출발 역과 도착역이 연결되어 있지 않으면 에러를 출력한다.

## 도착역을 입력하세요.
양재역
- [x] 출발역에서 도착역 까지 가는 경로를 포함하여 총 거리와 총 소요 시간을 아래와 같이 출력한다.

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

## 메인 화면
1. 경로 조회
Q. 종료

...
```

#### 에러 출력 예시

```
## 메인 화면
1. 경로 조회
Q. 종료

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

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

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

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

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

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

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

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

...

```

<br>

## 🎱 프로그래밍 요구사항
- 자바 코드 컨벤션을 지키면서 프로그래밍한다.
- 기본적으로 [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)을 원칙으로 한다.
- 단, 들여쓰기는 '2 spaces'가 아닌 '4 spaces'로 한다.
- indent(인덴트, 들여쓰기) depth를 3이 넘지 않도록 구현한다. 2까지만 허용한다.
- 예를 들어 while문 안에 if문이 있으면 들여쓰기는 2이다.
- 힌트: indent(인덴트, 들여쓰기) depth를 줄이는 좋은 방법은 함수(또는 메소드)를 분리하면 된다.
- 3항 연산자를 쓰지 않는다.
- 함수(또는 메소드)의 길이가 15라인을 넘어가지 않도록 구현한다.
- 함수(또는 메소드)가 한 가지 일만 잘 하도록 구현한다.
- else 예약어를 쓰지 않는다.
- 힌트: if 조건절에서 값을 return하는 방식으로 구현하면 else를 사용하지 않아도 된다.
- else를 쓰지 말라고 하니 switch/case로 구현하는 경우가 있는데 switch/case도 허용하지 않는다.
- 프로그래밍 요구사항에서 별도로 변경 불가 안내가 없는 경우 파일 수정과 패키지 이동을 자유롭게 할 수 있다.
- 예외 상황 시 에러 문구를 출력해야 한다. 단, 에러 문구는 `[ERROR]` 로 시작해야 한다.

### 프로그래밍 요구사항 - Application
- Application 클래스를 활용해 구현해야 한다.
- Application의 패키지 구조는 변경하지 않는다.
- Application 클래스에 있는 Scanner를 사용하고 별도의 Scanner 객체를 만들지 않는다.
```java
public class Application {
public static void main(String[] args) {
final Scanner scanner = new Scanner(System.in);
...
}
}
```

### 프로그래밍 요구사항 - Station, Line
- Station, Line 클래스를 활용하여 지하철역과 노선을 구현해야 한다.
- 제공하는 각 클래스의 기본 생성자를 추가할 수 없다.
- 필드(인스턴스 변수)인 name의 접근 제어자 private을 변경할 수 없다.
- 가능하면 setter 메소드(ex. setXXX)를 추가하지 않고 구현한다.

```java
public class Station {
private String name;

public Station(String name) {
this.name = name;
}

public String getName() {
return name;
}

// 추가 기능 구현
}
## 요구사항

```

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

```java
public class StationRepository {
private static final List<Station> stations = new ArrayList<>();

public static List<Station> stations() {
return Collections.unmodifiableList(stations);
}

public static void addStation(Station station) {
stations.add(station);
}

public static boolean deleteStation(String name) {
return stations.removeIf(station -> Objects.equals(station.getName(), name));
}

public static void deleteAll() {
stations.clear();
}
}
```

<br>

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

```java
@Test
public void getDijkstraShortestPath() {
WeightedMultigraph<String, DefaultWeightedEdge> graph
= new WeightedMultigraph(DefaultWeightedEdge.class);
graph.addVertex("v1");
graph.addVertex("v2");
graph.addVertex("v3");
graph.setEdgeWeight(graph.addEdge("v1", "v2"), 2);
graph.setEdgeWeight(graph.addEdge("v2", "v3"), 2);
graph.setEdgeWeight(graph.addEdge("v1", "v3"), 100);

DijkstraShortestPath dijkstraShortestPath = new DijkstraShortestPath(graph);
List<String> shortestPath = dijkstraShortestPath.getPath("v3", "v1").getVertexList();

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

#### 테스트 설명

<img src="image/dijkstra-sample.png" width=400>

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

<br>

## 📈 진행 요구사항
- 미션은 [java-subway-path-precourse 저장소](https://github.com/woowacourse/java-subway-path-precourse) 를 fork/clone해 시작한다.
- 기능을 구현하기 전에 java-subway-path-precourse/docs/README.md 파일에 구현할 기능 목록을 정리해 추가한다.
- git의 commit 단위는 앞 단계에서 README.md 파일에 정리한 기능 목록 단위로 추가한다.
- [AngularJS Commit Message Conventions](https://gist.github.com/stephenparish/9941e89d80e2bc58a153) 참고해 commit log를 남긴다.
- [프리코스 과제 제출 문서](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse) 절차를 따라 미션을 제출한다.
- [프리코스 과제 FAQ](https://github.com/woowacourse/woowacourse-docs/tree/master/precourse/faq) 문서를 참고하여 진행할 수 있다.
<br>

## 📝 License

This project is [MIT](https://github.com/woowacourse/java-subway-path-precourse/blob/master/LICENSE.md) licensed.
- 거리는 km, 시간은 분 단위로 계산한다.

- 기대하는 출력 결과는 [INFO]를 붙인다.

- 에러 출력은 [ERROR]를 붙인다.

- jgrapht 라이브러리를 활용한다.
8 changes: 7 additions & 1 deletion src/main/java/subway/Application.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
package subway;

import subway.controller.MainController;

import java.util.Scanner;

public class Application {
public static void main(String[] args) {
final Scanner scanner = new Scanner(System.in);
// TODO: 프로그램 구현

InitialSetting.settingInitialSubways();

MainController mainController = MainController.getInstance();
mainController.run(scanner);
}
}
89 changes: 89 additions & 0 deletions src/main/java/subway/InitialSetting.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
package subway;

import subway.domain.Line;
import subway.domain.RequiredResources;
import subway.domain.Section;
import subway.domain.Station;
import subway.repository.LineRepository;
import subway.repository.SectionRepository;
import subway.repository.StationRepository;

public class InitialSetting {
private static final String GYODAE = "교대역";
private static final String GANGNAM = "강남역";
private static final String YUCKSAM = "역삼역";
private static final String NAMBUTERMINAL = "남부터미널역";
private static final String YANGGAE = "양재역";
private static final String YANGGAEFORREST = "양재시민의숲역";
private static final String MAEBONG = "매봉역";
private static final String LINE_TWO = "2호선";
private static final String LINE_THREE = "3호선";
private static final String LINE_SINBUNDANG = "신분당선";
private static final String[] LINE_TWO_STATIONS = {"교대역", "강남역", "역삼역"};
private static final String[] LINE_THREE_STATIONS = {"교대역", "남부터미널역", "양재역", "매봉역"};
private static final String[] LINE_SINBUNDANG_STATIONS = {"강남역", "양재역", "양재시민의숲역"};

public static void settingInitialSubways() {
deleteAllRepository();

settingInitialStations();

settingInitialLines(LINE_TWO, LINE_TWO_STATIONS);
settingInitialLines(LINE_THREE, LINE_THREE_STATIONS);
settingInitialLines(LINE_SINBUNDANG, LINE_SINBUNDANG_STATIONS);

settingInitialSection();
}

private static void deleteAllRepository() {
StationRepository.deleteAll();
LineRepository.deleteAll();
SectionRepository.deleteAll();
}

private static void settingInitialStations() {
StationRepository.addStation(new Station(GYODAE));
StationRepository.addStation(new Station(GANGNAM));
StationRepository.addStation(new Station(YUCKSAM));
StationRepository.addStation(new Station(NAMBUTERMINAL));
StationRepository.addStation(new Station(YANGGAE));
StationRepository.addStation(new Station(YANGGAEFORREST));
StationRepository.addStation(new Station(MAEBONG));
}

private static void settingInitialLines(String lineName, String[] stationNames) {
Line line = new Line(lineName);
addStationInLine(line, stationNames);
LineRepository.addLine(line);
}

private static void addStationInLine(Line line, String[] stationNames) {
for (String stationName : stationNames) {
line.addLineStation(new Station(stationName));
}
}

private static void settingInitialSection() {
Section section = new Section(new Station(GYODAE), new Station(GANGNAM));
RequiredResources requiredResources = new RequiredResources(2, 3);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(GANGNAM), new Station(YUCKSAM));
requiredResources = new RequiredResources(2, 3);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(GYODAE), new Station(NAMBUTERMINAL));
requiredResources = new RequiredResources(3, 2);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(NAMBUTERMINAL), new Station(YANGGAE));
requiredResources = new RequiredResources(6, 5);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(YANGGAE), new Station(MAEBONG));
requiredResources = new RequiredResources(1, 1);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(GANGNAM), new Station(YANGGAE));
requiredResources = new RequiredResources(2, 8);
SectionRepository.addSection(section, requiredResources);
section = new Section(new Station(YANGGAE), new Station(YANGGAEFORREST));
requiredResources = new RequiredResources(10, 3);
SectionRepository.addSection(section, requiredResources);
}
}
Loading