Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
08850b1
docs(readme.md): 구현 기능 목록 작성
soongjamm Dec 19, 2020
7a55d32
feat(subway): 기본 뼈대 코드 작성 및 readme.md 업데이트
soongjamm Dec 19, 2020
2c026e0
feat(MainScreen): 메뉴 화면 및 입력 요구 메세지 출력
soongjamm Dec 19, 2020
f75ba57
feat: 메인화면과 경로조회에서 입력을 받는 것 까지 구현
soongjamm Dec 19, 2020
1e9f42f
refactor: 패키지를 생성해서 각 클래스를 이동시킴
soongjamm Dec 19, 2020
835d997
feat(Section): 구간 정보를 담는 Section 클래스의 생성자와 SectionRepository에서 구간 추가 …
soongjamm Dec 19, 2020
5f7ea2c
feat(initilize): 초기 정보를 설정하는 코드 작성
soongjamm Dec 19, 2020
e7d79eb
docs(readme.md): 구현 기능 목록 추가와 필요 객체 정보 추가
soongjamm Dec 19, 2020
921666c
feat(ShortestPath): 최단거리 계산을 위해 Section과 SectionRepository에 관련 메소드 추가
soongjamm Dec 19, 2020
9bdbfc3
etc: 미완성 시험 시간이 다되어서 현재 최단거리로 길찾기 구현 중 커밋
soongjamm Dec 19, 2020
9dd649d
Merge branch 'main' into soongjamm
soongjamm Dec 19, 2020
f2b5842
Update README.md
soongjamm Dec 19, 2020
dfa4859
style(screen): ScreenModel에 상수를 추가하여 DONE:종료나 뒤로가기 선택, NOTHING:다음에 표시…
soongjamm Dec 20, 2020
f402414
feat: 구간을 추가하는 방식을 수정
soongjamm Dec 20, 2020
c18965e
feat: 구간의 정보(거리, 시간) 추가하는 방식을 수정
soongjamm Dec 20, 2020
43d538f
feat: 거리기준 최소경로를 구할 때, 거리 계산까지 구현
soongjamm Dec 20, 2020
e5c0bfd
feat: 거리기준 최소경로를 구할 때, 소요되는 시간 계산 구현
soongjamm Dec 20, 2020
6114a26
Merge branch 'soongjamm' of https://github.com/soongjamm/java-subway-…
soongjamm Dec 20, 2020
3ed2800
refactor: 최단경로에 포함되는 구간인지 확인하는 메소드를 Section 클래스로 이동
soongjamm Dec 20, 2020
0af7958
feat: 경로 조회 결과 출력 구현
soongjamm Dec 20, 2020
832ea11
fix: 조회후 프로그램 종료되는 현상 수정
soongjamm Dec 20, 2020
8a6d5df
feat: 각 메뉴 선택화면에서 잘못 입력된 값 예외처리
soongjamm Dec 21, 2020
b58bc2d
feat: 경로조회시 역을 검증하는 기능 구현
soongjamm Dec 21, 2020
10bef67
style: 시간과 관련된 이름을 cost -> requiredTime 으로 변경
soongjamm Dec 21, 2020
6cd3836
feat: 시간기준 최단거리 찾기 구현
soongjamm Dec 21, 2020
22f0cfc
feat(PathResult): 경로 검색 결과를 저장하는 클래스 생성
soongjamm Dec 21, 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
292 changes: 44 additions & 248 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,251 +3,47 @@

<br>

## 🚀 기능 요구사항

> 프리코스 3주차 미션에서 사용한 코드를 참고해도 무관하다.

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

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

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

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

<br>

## ✍🏻 입출력 요구사항
- `프로그래밍 실행 결과 예시`와 동일하게 입출력을 구현한다.
- 기대하는 출력 결과는 `[INFO]`를 붙여서 출력한다. 출력값의 형식은 예시와 동일하게 한다.
- 에러 발생 시 `[ERROR]`를 붙여서 출력한다. 에러의 문구는 자유롭게 작성한다.

### 💻 프로그래밍 실행 결과 예시
#### 경로 조회
```
## 메인 화면
1. 경로 조회
Q. 종료

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

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

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

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

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

## 조회 결과
[INFO] ---
[INFO] 총 거리: 4km
[INFO] 총 소요 시간: 11분
[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.
## 기본 설정
- 역, 노선, 구간정보를 초기설정한다.
- 구간은 `노선`, `상행쪽역`, `하행쪽역`, `거리`, `시간` 으로 이루어져 있다.
```
1. 지하철역으로 교대역, 강남역, 역삼역, 남부터미널역, 양재역, 양재시민의숲역, 매봉역이 등록되어 있다.
2. 지하철 노선으로 2호선, 3호선, 신분당선이 등록되어 있다.
3. 노선에 역이 아래와 같이 등록되어 있다.(왼쪽 끝이 상행 종점)
- 2호선: 교대역 - ( 2km / 3분 ) - 강남역 - ( 2km / 3분 ) - 역삼역
- 3호선: 교대역 - ( 3km / 2분 ) - 남부터미널역 - ( 6km / 5분 ) - 양재역 - ( 1km / 1분 ) - 매봉역
- 신분당선: 강남역 - ( 2km / 8분 ) - 양재역 - ( 10km / 3분 ) - 양재시민의숲역
```

## 구현 기능 목록
- 초기 설정을 위해 역, 노선, 구간 정보를 추가할 수 있어야 한다.
- 메인 화면에서 메뉴를 출력한다.
- 메인 화면에서 경로 조회와 종료중 입력을 받는다. (1: 경로조회, Q: 종료)
- 경로 기준 화면에서 메뉴를 출력한다.
- 경로 기준을 입력받는다. (1: 최단거리, 2: 최소시간)
- 경로를 조회한다.
- 출발역을 입력받는다.
- 도착역을 입력받는다.
- (경로 기준) 출발역에서 도착역까지의 갈 수 있는 최단 거리인 경로를 계산한다.
- (시간 기준) 출발역에서 도착역까지의 총 소요시간이 가장 짧은 경로를 계산한다.
- 찾아낸 경로의 거리와 소요시간을 출력한다.
- 종료한다.

`예외처리`
- 메인화면과 경로기준 입력화면에서 정해진 키워드가 아닌 입력은 모두 예외처리
- 경로조회시 출발역과 도착역이 같은 경우
- 출발역과 도착역이 연결되어 있지 않은 경우

## 객체
- 화면 관리 객체
- 메인 화면
- 경로 기준 선택 화면
- 기능 화면
- 출력
- 입력
- 역
- 역 레포지토리
- 노선
- 노선 레포지토리
- 구간
- 구간 레포지토리
8 changes: 4 additions & 4 deletions gradlew

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

46 changes: 45 additions & 1 deletion src/main/java/subway/Application.java
Original file line number Diff line number Diff line change
@@ -1,10 +1,54 @@
package subway;

import subway.domain.*;
import subway.screen.MainScreen;
import subway.screen.ScreenManager;
import subway.screen.ScreenModel;

import java.util.Arrays;
import java.util.List;
import java.util.Scanner;

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

while (!ScreenManager.isEmpty()) {
try {
ScreenModel nextScreen = ScreenManager.pop();
ScreenManager.show(nextScreen);
} catch (IllegalArgumentException e) {
System.out.println(e.getMessage());
ScreenManager.addNextMenuScreen(new MainScreen(scanner));
}
}
}

private static void initialize() {
List<Station> stations = Arrays.asList(new Station("교대역"), new Station("강남역")
, new Station("역삼역"), new Station("남부터미널역"), new Station("양재역")
, new Station("양재시민의숲역"), new Station("매봉역"));
stations.stream().forEach(station -> StationRepository.addStation(station));

List<Line> lines = Arrays.asList(new Line("2호선").addTerminus("교대역", "역삼역")
, new Line("3호선").addTerminus("교대역", "매봉역")
, new Line("신분당선").addTerminus("강남역", "양재시민의숲역"));
lines.stream().forEach(line -> LineRepository.addLine(line));

SectionRepository.addSection("2호선", "강남역", 1);
SectionRepository.addSection("3호선", "남부터미널역", 1);
SectionRepository.addSection("3호선", "양재역", 2);
SectionRepository.addSection("신분당선", "양재역", 1);

SectionRepository.addSectinonDistanceAndTime("교대역", "강남역", 2, 3);
SectionRepository.addSectinonDistanceAndTime("강남역", "역삼역", 2, 3);
SectionRepository.addSectinonDistanceAndTime("교대역", "남부터미널역", 3, 2);
SectionRepository.addSectinonDistanceAndTime("남부터미널역", "양재역", 6, 5);
SectionRepository.addSectinonDistanceAndTime("양재역", "매봉역", 1, 1);
SectionRepository.addSectinonDistanceAndTime("강남역", "양재역", 2, 8);
SectionRepository.addSectinonDistanceAndTime("양재역", "양재시민의숲역", 10, 3);

}
}
Loading