2호선 VIP by woo-chang · Pull Request #14 · woowacourse-code-review-study/jwp-subway-path

woo-chang · 2023-05-22T05:14:58Z

No description provided.

* docs: 기능 요구사항 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 이름 길이 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 이름 형식 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 이름이 공백일 때 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * test: 이름에 대한 생성 테스트 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 거리 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 두 역과 역 사이의 거리를 가지는 구역 추가 Co-authored-by: woo-chang <clllickme@naver.com> * remove: 사용하지 않는 파일 정리 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 이름 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 색 검증 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * docs: API 명세 작성 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 등록 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 정보 조회 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * docs: API 명세 수정 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 등록 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 조회 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 목록 조회 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 역 등록 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선에서 역 삭제 API 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선에 새로운 역 등록 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선에 존재하는 역 제거 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * test: 노선에 역 추가, 삭제 후 거리를 검증하는 테스트 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역을 생성하는 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역을 조회하는 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선을 등록하는 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: 노선 목록 조회시 노선 안의 역 정보를 포함하도록 변경 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 조회 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 목록 조회 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선에 역 등록 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노션 역 삭제 로직 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에 역을 저장하는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에 노선을 저장하는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에 구간을 저장하는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에서 모든 노선 조회 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에서 노선 업데이트 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에서 특정 노선의 구간을 삭제하는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: DB에 모든 구간 정보를 저장하는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 역 ID로 역 정보 조회 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 저장 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 ID로 정보 조회 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 정보 조회 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 노선 정보 업데이트 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: 모든 노선 정보 조회 시 노선을 다시 조회하지 않도록 수정 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 예외 발생 시 로그를 남기는 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: 유효한 구간 정보가 순서대로 입력되지 않아도 정상적으로 노선을 생성하도록 변경 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: 컨벤션 통일 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: Service에 Transactional 적용 Co-authored-by: woo-chang <clllickme@naver.com> * test: Controller 통합테스트 추가 Co-authored-by: woo-chang <clllickme@naver.com> * feat: 내부 예외처리 기능 추가 Co-authored-by: woo-chang <clllickme@naver.com> * docs: README 업데이트 Co-authored-by: woo-chang <clllickme@naver.com> * fix: 역간 거리의 최대길이 제한 삭제 Co-authored-by: woo-chang <clllickme@naver.com> * refactor: 예외 메시지 수정 Co-authored-by: woo-chang <clllickme@naver.com> * test: 거리에 대한 테스트 수정 Co-authored-by: woo-chang <clllickme@naver.com> * docs: 수정된 기능 반영 * chore: 코드 컨벤션 수정 * feat: Swagger를 이용해 API 문서화 * refactor: 예상할 수 없는 예외에 대한 로그 레벨 수정 * refactor: 노선 색에 대한 예외 세분화 * test: 의도와 다른 테스트명 수정 * refactor: 예외에서 상태 코드 관리 책임 분리 * refactor: request 기본 생성자 접근 제어자 수정 * refactor: 도메인 검증 통일성 있게 수정 * refactor: service에서 repository를 사용하도록 수정 * refactor: 도메인 정적 팩토리 메서드 수정 * refactor: 코드 컨벤션 수정 --------- Co-authored-by: bjk1649 <qhwns1649@naver.com>

greeng00se

다즐 고수시네요 👍 잘 보고갑니다.
도메인이 외부 라이브러리에 많이 의존하고 있는데 이 부분을 인터페이스를 통해 결합도를 낮춰보는건 어떨까?

greeng00se · 2023-05-22T06:41:17Z

+    public FareStrategy fareStrategy() {
+        return new FareStrategyComposite(
+                List.of(
+                        new DistanceFareStrategy(),
+                        new RouteFareStrategy(),
+                        new AgeFareStrategy()
+                )
+        );


Composite 👍

greeng00se · 2023-05-22T06:41:29Z

+    @Bean
+    public OpenAPI openAPI() {
+        final Info info = new Info()
+                .title("지하철 API Document")
+                .version("v0.0.1")
+                .description("지하철 API 명세서입니다.");
+        return new OpenAPI()
+                .components(new Components())


Swagger 👍

greeng00se · 2023-05-22T06:43:08Z

+
+    @Operation(summary = "경로 정보 조회 API", description = "출발역에서 도착역까지의 경로 정보를 조회합니다.")
+    @GetMapping("/shortest-path")
+    public ResponseEntity<ShortestPathResponse> findShortestPath(@Valid @RequestBody PassengerRequest request) {


쿼리 스트링으로 받아보는건 어떨까?

greeng00se · 2023-05-22T06:47:57Z

+
+public enum AgePolicy {
+
+    BABY(age -> age < 6, fare -> fare),


애기는 꼬맹이랑 청소년보다 돈을 많이 받나요?

greeng00se · 2023-05-22T06:48:59Z

+    BASE_FIFTY(50, distance -> {
+        final long additionDistance = distance - 50;
+        return calculateDistanceFarePerStep(additionDistance, 8);
+    }),
+    BASE_TEN(10, distance -> {
+        final long additionDistance = Math.min(BASE_FIFTY.base, distance) - 10;
+        return calculateDistanceFarePerStep(additionDistance, 5);
+    });


거리별 정책도 enum으로 만들어줬넹

greeng00se · 2023-05-22T06:50:10Z

+        if (upwardPosition == ADDITIONAL_INDEX) {
+            if (isAddAtFront(downwardPosition)) {
+                addSectionEndPoints(true, upward, downward, distance);
+                return;
+            }
+            addUpwardSectionBetweenStations(upward, downward, distance, downwardPosition);
+        }
+
+        if (downwardPosition == ADDITIONAL_INDEX) {
+            if (isAddAtEnd(upwardPosition)) {
+                addSectionEndPoints(false, upward, downward, distance);
+                return;
+            }
+            addDownwardSectionBetweenStations(upward, downward, distance, upwardPosition);


전략 패턴으로 분리해보는건 어떨까요?

greeng00se · 2023-05-22T06:52:14Z

+    private static final int MINIMUM_VALUE = 0;
+
+    private final int value;
+
+    public Distance(final int value) {
+        validate(value);
+        this.value = value;
+    }
+
+    private void validate(final int value) {
+        if (value < MINIMUM_VALUE) {
+            throw new InvalidDistanceException("역 사이의 거리는 0이상이어야합니다.");
+        }
+    }


요구사항에 따르면 1이상이어야 되는거 아닐까요?

greeng00se · 2023-05-22T06:55:42Z

+        final List<StationResponse> stationsOfLineTwo = List.of(
+                new StationResponse(1L, "잠실역"),
+                new StationResponse(2L, "잠실새내역")
+        );
+        final List<StationResponse> stationsOfLineFour = List.of(
+                new StationResponse(3L, "이수역"),
+                new StationResponse(4L, "서울역")
+        );
+        final List<LineResponse> lines = List.of(
+                new LineResponse(1L, "2호선", "초록색", 500, stationsOfLineTwo),
+                new LineResponse(2L, "4호선", "하늘색", 1000, stationsOfLineFour));
+        final LinesResponse response = new LinesResponse(lines);
+
+        given(lineService.findLines()).willReturn(response);
+
+        final MvcResult mvcResult = mockMvc.perform(get("/lines"))
+                .andDo(print())
+                .andExpect(status().isOk())
+                .andReturn();
+
+        final String jsonResponse = mvcResult.getResponse().getContentAsString(Charset.forName("UTF-8"));
+        final LinesResponse result = objectMapper.readValue(jsonResponse, LinesResponse.class);
+        assertThat(result).usingRecursiveComparison().isEqualTo(response);


테스트 코드가 길어지는데 given-when-then 패턴을 사용해보는건 어떨까요?

woo-chang and others added 30 commits May 14, 2023 10:31

build: 최단 경로 라이브러리 의존성 추가

d95a57e

docs: 기능 요구사항 추가

28d5842

feat: 거리에 따른 요금 계산 기능 구현

189f140

build: 최단 경로 라이브러리 의존성 수정

825bef1

refactor: Line에서 필요하지 않은 구간 정보 필터링하도록 수정

2b05c90

feat: 출발역과 도착역 사이의 최단 경로, 거리를 구하는 기능 구현

03a2ad7

refactor: 지하철 역을 통해 경로를 조회하도록 수정

2bdd661

feat: 지하철 노선 기능 추출

7ffb165

chore: 메서드명 수정

6a4adfa

feat: 지하철에서 최단 경로 조회 기능 구현

085ad8f

feat: 최단 경로 조회 API 구현

d3563ff

feat: 노선에 추가 요금 정보 추가

9de64b8

feat: 노선 추가 요금 구현

d565e54

feat: 거리별 추가요금 정책 구현

0bba461

feat: 지하철 맵을 통해 최단 경로, 최단 거리 구하는 기능 구현

6e0d4c1

feat: 거리에 따른 요금을 계산하는 기능 구현

4315242

feat: 노선 추가 요금에 따른 요금을 계산하는 기능 구현

422ee0d

feat: 나이에 따른 할인 금액 계산 기능 구현

b86b7bc

feat: 나이에 따른 요금 계산 기능 구현

2cfc943

feat: 복합 요구 정책을 수행하기 위한 기능 구현

5e2c0ad

refactor: 노선 정보, 탑승자 정보 추가에 대한 수정

c5a393c

refactor: 경로 조회 시 반환하고자 하는 정보 수정

5721896

feat: 경로 조회 기능 구현

b9b7435

test: 경로 조회 API 통합 테스트

b182c26

refactor: 사용하지 않는 클래스 제거

9b7471a

docs: API 명세 문서화

10d83f8

chore: 코드 컨벤션 수정

4539c99

refactor: 청소년, 어린이인 경우에만 공제가 이루어지도록 수정

b49b926

chore: 코드 컨벤션 수정

ea0d0cf

woo-chang added 8 commits May 18, 2023 02:36

refactor: 노선에 역 추가하는 기능 리팩토링

6f45d17

fix: 다음 노선 번호로 업데이트되지 않는 문제 수정

ca69a6a

feat: 프로덕션과 테스트 데이터베이스 설정 분리

b3461b8

docs: 애플리케이션 빠른 실행을 위한 문서화

469118d

refactor: 행위에 대한 의미 부여를 위한 메서드 추출

ac9382c

refactor: 요금 정책 생성을 테스트 안에서 수행하도록 수정

bbfecb6

refactor: dto swagger 예시 작성

084d6c0

test: 구간 목록 테스트 추가

50bfbb3

greeng00se reviewed May 22, 2023

View reviewed changes

woo-chang added 2 commits May 23, 2023 00:05

refactor: FareStrategyComposite를 컴포넌트 스캔으로 빈 등록

8d88f7f

refactor: 환경에 따른 설정 수정

1d0e6c3

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

2호선 VIP#14

2호선 VIP#14
woo-chang wants to merge 40 commits into
woowacourse-code-review-study:mainfrom
woo-chang:step2

woo-chang commented May 22, 2023

Uh oh!

greeng00se left a comment

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

greeng00se May 22, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

woo-chang commented May 22, 2023

Uh oh!

greeng00se left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants