#13 Feature: 일정 관련 로직 구현 #14

hyxklee · 2024-07-08T07:59:23Z

1. 개발내용

✅ POST: 일정 생성
✅ GET: 일정 상세 조회
✅ GET: 기간 별 일정 조회
✅ PATCH: 일정 수정
✅ DELETE: 일정 삭제

2. 구현 세부사항

EventMapper를 사용해 dto -> Event로 또 Event -> dto로 손쉽게 변환해 사용
dto 명은 요청과 반환의 의미를 담기 위해 Request, Response로 작명하였음
아직 객체와의 관계는 작성하지 않았음

3. 고민

일정 삭제시 테이블에서 삭제하는 것이 좋을 지 status를 바꾸는 방식이 좋을 지 고민
조회 로직에는 @transactional(readOnly = true)를 달아뒀는데 아직 잘 몰라서 더 찾아보겠음
events 관련 경로 권한은 본인 개발 시 열어뒀다가 현재는 다시 닫아둔 상태로 PR을 올림. 주석처리 할 테니 테스트 시 주석 해제 후 사용바람
날짜 설정 시 예외처리 추가 예정

rootTiket · 2024-07-08T09:48:32Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+    @Transactional(readOnly = true)
+    public ResponseEvent getEventById(Long id) {
+        Event event = eventRepository.findById(id)
+                .orElseThrow(() -> new EntityNotFoundException("id에 해당하는 일정이 존재하지 않습니다."));


에러 메시지를 enum으로 관리하거나 커스텀 exception 안에 Message를 고정해두는 방식이 관리하기 더 좋을것 같습니다.

제가 생각하기엔 커스텀 exception 안에 메시지를 고정하면 다른 도메인에서 사용시 에러 메시지가 명시적으로 전달되기 어려울 거 같아서 도메인 별로 에러 메시지를 enum으로 관리하는 것이 나을 거 같습니다! 해당 방식으로 수정하겠습니다! 다른 방법이 있다면 알려주시면 감사하겠습니다!!

rootTiket · 2024-07-08T09:50:10Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+        List<Event> events = eventRepository.findByStartDateTimeBetween(startDate, endDate);
+        return events.stream()
+                .map(eventMapper::toDto)
+                .collect(Collectors.toList());


데이터의 불변성을 지키기 위해 toList() 를 사용해보시면 좋을 것 같아요 관련 링크 남겨둘게요
https://www.inflearn.com/questions/986386/%EC%8A%A4%ED%8A%B8%EB%A6%BC-tolist%EC%99%80-collect%EC%9D%98-%EC%B0%A8%EC%9D%B4

불변성을 위해서 그렇게 하는게 나을 거 같습니다! 수정하겠습니다

rootTiket · 2024-07-08T09:51:13Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+    @Transactional
+    public void updateEvent(Long id, RequestEvent requestEvent) {
+        Event oldEvent = eventRepository.findById(id)
+                .orElseThrow(() -> new EntityNotFoundException("id에 해당하는 일정이 존재하지 않습니다."));


위 코멘트와 마찬가지로 enum으로 관리하면 더 좋을거 같아요

rootTiket · 2024-07-08T09:51:22Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+    // 일정 삭제
+    public void deleteEvent(Long id) {
+        if (!eventRepository.existsById(id)) {
+            throw new EntityNotFoundException("id에 해당하는 일정이 존재하지 않습니다.");


여기도요!

rootTiket

고생하셨습니다!
제 생각? 을 조금 적어뒀으니까 읽어보시고 참고해서 진행해보시면 좋을것 같아요!

jwnnoh

고생하셨습니다!
근표님이 좋은 리뷰를 많이 달아주셔서, 제가 할 말이 딱히 별로 없네요 ㅎㅎ

jwnnoh · 2024-07-08T12:17:56Z

src/main/java/leets/weeth/domain/event/dto/RequestEvent.java

+import java.time.LocalDateTime;
+
+@Getter
+@Setter


record를 통해 DTO 클래스를 구현해준다면 더욱 좋을 것 같습니다!
DTO 클래스가 가져야 하는 모든 책임들을 포함하고 있습니다 :)

공부해보고 팀원들과 얘기해서 사용해보겠습니다! 감사합니다!

jiixon

이미 여러개의 리뷰가 달려서 간소하게 달았습니다!

당연히 테스트 후 PR을 올리시겠지만, 제가 생각하기에 스크린샷도 함께 첨부한다면 서로 어떤 데이터를 주고 받는지 다른 팀원들도 확인하시기 편한것 같아요(이건 제 개인적인 의견입니다!)
2.인증인가가 없는데, 유저에 대한 부분이 없어도 되는지? 궁금합니다.
3.swagger를 이미 도입하신걸로 아는데 전체적으로 그부분에 대해서 활용도가 적으신거 같아요ㅠ! 문서화하신 만큼 예를 들어 id가 일정에 대한 id이고, 이 API는 어떤 API 이고, 에러에 대한 설명도 같이 있으면 좋을 것 같아요:)
4.제가 느끼기에 일정 조회같은 경우에는 더 많은 데이터가 필요할것 같지만... ! 제가 기능명세서나 피그마 한번 더 확인 후 남기도록 하겠습니다!

고생하셨습니다!

jiixon · 2024-07-08T15:32:37Z

src/main/java/leets/weeth/domain/event/controller/EventController.java

+        return CommonResponse.createSuccess(responseEvents);
+    }
+
+    // 일정 수정


궁금한 점이 있는데, 혹시 일정 수정은 아무나 할 수 있는 건가요? 아니면 인증인가 부분을 아직 구현 전이라서 그런걸까요?

관리자만 수정할 수 있게 구현할 예정입니다! 아직 인증인가를 구현하지 않았습니다!

jiixon · 2024-07-08T15:33:28Z

src/main/java/leets/weeth/domain/event/controller/EventController.java

+            @RequestParam(name = "start") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime startDate,
+            @RequestParam(name = "end") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime endDate) {


ISO.DATA_TIME 으로 맞춘 점이 좋네요! 프론트와 데이터 타입이 맞지 않는 경우가 많은데, 신경쓰신거 같아서 좋은것 같습니다:)

jiixon · 2024-07-08T15:51:27Z

src/main/java/leets/weeth/domain/event/dto/RequestEvent.java

+import java.time.LocalDateTime;
+
+@Getter
+@Setter


dto 에 setter는 아래의 이유로 쓰지 않는다고 하네요.
1)Setter 메소드를 사용하면 값을 변경한 의도를 파악하기 힘듭니다.
2)객체의 일관성을 유지하기 어렵습니다.

대신 이렇게 많이 대신 쓰이기도 한다고 합니다.
1)생성자를 오버로딩
2)Builder 패턴 사용
3)정적 팩토리 메소드

꼭 필요한 어노테이션인지 확인하시면 좋을것 같아요:)

양 쪽 DTO 모두 사용하지 않아서 setter는 제거하였습니다!

jiixon · 2024-07-08T16:00:16Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+        oldEvent.update(
+                requestEvent.getTitle(),
+                requestEvent.getContent(),
+                requestEvent.getLocation(),
+                requestEvent.getStartDateTime(),
+                requestEvent.getEndDateTime()
+        );
+    }


이부분은 왜 MapStruct을 사용하지 않는건지 알수 있을까요?
update 할 부분이 많아 지는 경우에는 모든부분을 고칠 필요가 없는 것 같아요, 유저에 따라서 일부분만 변경 하고 싶을 수도 있다고 생각합니다. 이부분에 대해서 어떻게 생각하시는지 궁금하구요!

그래서 저같으면, mapstruct을 이미 사용하고 계시기 때문에 request값이 null이 아닌 부분만 update를 할 수 있지 않을까 생각했습니다:)

아직 라이브러리에 대한 이해도가 없어서 수정 로직을 어떻게 바꿔야할지 고민 중입니다! 테스트 해보니 현재 방식으로는 null도 같이 업데이트 되고 있어서 더 연구해보고 수정하도록 하겠습니다!

찾아보니 MapStruct를 이용해 update 하는 방식은 Event Entity에 Setter를 모두 열어놔야하는 방식이라서 다른 방식으로 구현해봤는데 한 번 확인해주실 수 있으실까요??

KoungQ

고생하셨습니다

KoungQ · 2024-07-09T04:41:49Z

src/main/java/leets/weeth/domain/event/controller/EventController.java

+    private final EventService eventService;
+
+    @Operation(summary = "일정 생성", description = "관리자가 일정을 등록합니다.")
+    @PreAuthorize("hasRole('ROLE_USER') or hasRole('ROLE_ADMIN')")


@PreAuthorize("hasAnyAuthority('ROLE_USER', 'ROLE_ADMIN')")로 둘 중에 하나만 일치하면 인가 되도록 할 수 있을거에요

개발 편의 상 둘 다 열어두는 쪽이 편할 거 같아서 열어뒀습니다!

KoungQ · 2024-07-09T04:52:31Z

src/main/java/leets/weeth/domain/event/controller/EventController.java

+
+    @Operation(summary = "일정 삭제", description = "관리자가 일정을 삭제합니다.")
+    @PreAuthorize("hasRole('ROLE_USER') or hasRole('ROLE_ADMIN')")
+    @DeleteMapping("/{id}")


create와 update 요청과는 다르게 왜 delete는 주소에 delete가 없는건가요??
POST 요청은 다양한 목적을 가진 요청일 가능성이 크므로 주소에 create가 들어가는 것도 괜찮을 것 같다고 생각해요
하지만 update와 delete는 HTTP 메서드로 충분히 목적을 밝히고 있는 것 같아 굳이 넣을 필요가 없다고 생각했어요
권장하는 RESTful API 설계 중 "행위(method)는 URL에 포함하지 않는다."는 방법을 따르는 건 어떨까요?

참고: https://library.gabia.com/contents/8339/

참고해서 수정해보겠습니다

KoungQ · 2024-07-09T04:56:22Z

src/main/java/leets/weeth/domain/event/repository/EventRepository.java

+
+    List<Event> findByStartDateTimeBetween(LocalDateTime startDate, LocalDateTime endDate);
+
+    Optional<Event> findById(Long id);


SimpleJpaRepository에 이미 구현된 메서드를 다시 구현한 이유가 있나요??

몰랐습니다...

KoungQ · 2024-07-09T04:57:38Z

src/main/java/leets/weeth/domain/event/service/EventService.java

+    @Transactional(readOnly = true)
+    public ResponseEvent getEventById(Long id) {
+        Event event = eventRepository.findById(id)


레포지토리에 달았던 코멘트와 같이 SimpleJpaRepository에 구현된 메서드를 가져다 쓰면 이미 @Transactional(readOnly = true)가 적용돼있는데 존재하는 메서드를 다시 구현해서 같은 작업을 다시 처리한 이유가 있나요??

이것도 몰랐습니다..

@transactional(readOnly = true)는 명시적으로 표시하는 게 좋을 거 같아서 성능상 차이가 없다며 남겨두겠습니다!

hyxklee added 24 commits July 8, 2024 15:02

feat: event 엔티티 구현

0e6c242

feat: event 레포지토리 구현, 일정 조회 로직 구현

b3987e9

feat: event mapper 구현

0221646

feat: event 응답 dto 구현

22d7352

feat: event 요청 dto 구현

86f55b9

feat: (EventService) 이벤트 저장 로직 구현

de5882a

feat: (EventController) 이벤트 생성 api 구현

13516d7

refactor: (EventService) 이벤트 생성 변수명 변경

7fc76e9

refactor: annotation 오타 수정

b42e6bf

refactor: 메소드 명 수정

d6cf99e

refactor: location 변수 추가

c88f41b

refactor: (EventService) 일정 상세 조회 로직 구현

11bc21e

refactor: (EventController) 일정 상세 조회 api 구현

780f0e0

refactor: (EventService) 예외처리 로직 수정

beb3e22

feat: (EventService) 기간 별 일정 조회 로직 구현

88be70c

feat: (EventController) 기간 별 일정 조회 api 구현

a16a8b9

refactor: 반환 dto에 event id 추가

701e41c

feat: (EventService) 일정 수정 로직 구현

e1f57ec

feat: (EventController) 일정 수정 api 구현

d775ff8

refactor: 사용하지 않는 import 문 정리

9605432

feat: (EventService) 일정 삭제 로직 구현

ed56c78

feat: (EventController) 일정 삭제 api 구현

bc41e21

refactor: events 관련 경로 주석 처리

83f771d

refactor: 요청 처리 완료 시 메시지 추가

9e45d04

hyxklee added the Feature 기능 개발 label Jul 8, 2024

hyxklee requested review from jj0526, rootTiket, KoungQ, jiixon and huncozyboy July 8, 2024 07:59

rootTiket reviewed Jul 8, 2024

View reviewed changes

jwnnoh reviewed Jul 8, 2024

View reviewed changes

hyxklee added 9 commits July 8, 2024 23:34

refactor: 데이터를 불변적으로 반환하기 위해 toList()로 수정

1128456

feat: ErrorMessage를 enum으로 관리

2a80e14

feat: 응답 메시지를 enum으로 관리

d13e44c

refactor: enum 형태로 응답 메시지를 반환

3803684

refactor: enum 형태로 에러 메시지를 생성

1f87e02

refactor: setter 제거

1827771

refactor: 빌더 패턴 적용

68b3016

refactor: requestEvent dto를 전달받아 update 하는 방식으로 수정

2890e83

refactor: requestEvent dto를 전달해 update 하는 방식으로 수정

7913dd3

jiixon approved these changes Jul 8, 2024

View reviewed changes

hyxklee added 9 commits July 9, 2024 11:26

refactor: null 값을 제외한 값만 업데이트 하는 방식으로 변경

673e01e

refactor: null 값을 제외한 값만 업데이트 하는 방식으로 변경

d873daf

feat: swagger 설정 파일 추가

bca5166

feat: PreAuthorize 사용을 위한 설정 추가

999aafd

feat: swagger api 명세를 위한 설정 추가, @PreAuthorize 어노테이션 추가(사용자 권한 확인)

3386392

fix: JWT 토큰으로 인증이 안되는 오류 수정

f057d03

refactor: dto를 record로 구현

66c8e2c

refactor: dto를 record로 구현함에 따라 값을 가져오는 방식 수정

f852c6a

chore: 주석 삭제

5d4da54

KoungQ reviewed Jul 9, 2024

View reviewed changes

hyxklee added 2 commits July 9, 2024 14:10

refactor: 사전 정의된 메서드 제거

bc9f26a

refactor: API 엔드포인트 수정

a4c5411

hyxklee merged commit 5dcd508 into main Jul 9, 2024
1 check passed

hyxklee deleted the feature-#13 branch July 9, 2024 05:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#13 Feature: 일정 관련 로직 구현 #14

#13 Feature: 일정 관련 로직 구현 #14

hyxklee commented Jul 8, 2024 •

edited

Loading

rootTiket Jul 8, 2024

hyxklee Jul 8, 2024

rootTiket Jul 8, 2024

hyxklee Jul 8, 2024

rootTiket Jul 8, 2024

rootTiket Jul 8, 2024

rootTiket left a comment

jwnnoh left a comment

jwnnoh Jul 8, 2024

hyxklee Jul 8, 2024

jiixon left a comment

jiixon Jul 8, 2024

hyxklee Jul 9, 2024

jiixon Jul 8, 2024

jiixon Jul 8, 2024

hyxklee Jul 9, 2024

jiixon Jul 8, 2024

hyxklee Jul 9, 2024

hyxklee Jul 9, 2024

KoungQ left a comment

KoungQ Jul 9, 2024

hyxklee Jul 9, 2024

KoungQ Jul 9, 2024

hyxklee Jul 9, 2024

KoungQ Jul 9, 2024

hyxklee Jul 9, 2024

KoungQ Jul 9, 2024

hyxklee Jul 9, 2024

hyxklee Jul 9, 2024

		@RequestParam(name = "start") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime startDate,
		@RequestParam(name = "end") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) LocalDateTime endDate) {


		List<Event> findByStartDateTimeBetween(LocalDateTime startDate, LocalDateTime endDate);

		Optional<Event> findById(Long id);

#13 Feature: 일정 관련 로직 구현 #14

#13 Feature: 일정 관련 로직 구현 #14

Conversation

hyxklee commented Jul 8, 2024 • edited Loading

1. 개발내용

2. 구현 세부사항

3. 고민

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rootTiket left a comment

Choose a reason for hiding this comment

jwnnoh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jiixon left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

KoungQ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hyxklee commented Jul 8, 2024 •

edited

Loading