feat: 추억 목록 정렬, 필터링 API 구현 #583

linirini · 2025-01-08T18:59:20Z

⭐️ Issue Number

feat: 추억 목록 정렬, 필터링 API 구현 #546

🚩 Summary

/memories?term=true&sort=NEWEST와 같은 형식으로 필터링과 정렬 조건을 query string으로 전달하여 적용합니다.
query string의 value로 유효하지 않은 값이 전달될 경우 default 정렬 조건을 사용하고, 필터링은 무시 되도록 구현하였습니다.
- 잘못된 query string의 value에 대해서 사용자가 예외를 반환받을 필요는 없다고 생각하였습니다.
- 다만, 클라이언트 측에서는 명세서를 잘 확인하여 잘못된 값을 전달하지 않도록 유의해야 합니다.

🛠️ Technical Concerns

Controller테스트에서 Application Context를 재사용하도록 리팩터링 했습니다. 최적화를 의도했지만, 확연한 성능 최적화는 경험하지 못했습니다..
필터링과 정렬은 Enum으로 관심사를 분리하였습니다.
내부적으로 함수형으로 관련 정렬 / 필터링 로직을 적용하도록 구현했습니다.
최근 수정 순을 구현하기 위해 EntityListener의 CallbackMethod를 활용하여 MomentEntityListener를 만들고 Moment 엔티티에 등록하였습니다. 해당 리스너에서는 Moment에 대한 Persist, Remove, Update 작업이 발생하였을 때 Memory의 UpdatedAt을 갱신합니다. 이때 트랜잭션 내부에서 작업하도록 PreXXX 콜백을 사용하였습니다.

🙂 To Reviewer

고민이 되었던 부분에 대해서는 코멘트를 작성해놓았습니다. 확인 부탁드립니다.
추가로, 갑자기 momentRepositoryTest.findAllByMemoryIdOrderByCreatedAt()가 터지는데, 왜인지 모르겠습니다. 그 외에도 어떤 생성 날짜/수정 날짜 갱신에 대한 테스트가 랜덤하게 터지고 있습니다.....

📋 To Do

github-actions · 2025-01-08T19:00:55Z

Test Results

29 files 29 suites 5s ⏱️
180 tests 180 ✅ 0 💤 0 ❌
188 runs 188 ✅ 0 💤 0 ❌

Results for commit 0b3710c.

♻️ This comment has been updated with latest results.

github-actions · 2025-01-08T19:00:56Z

🌻Test Coverage Report

Overall Project	78.81% `-0.41%`	🍏
Files changed	94.55%	🍏

File	Coverage
MemoryController.java	100%	🍏
Term.java	100%	🍏
MemoryMembers.java	100%	🍏
MemorySort.java	100%	🍏
MemoryFilter.java	100%	🍏
MemoryService.java	97.1%	🍏
Memory.java	88.69%	🍏
MomentEntityListener.java	80% `-20%`	🍏
MemoryReadRequest.java	77.14% `-22.86%`	🍏
BaseEntity.java	76.47% `-23.53%`	❌
Moment.java	64.94%	🍏

linirini · 2025-01-08T19:06:17Z

backend/src/main/java/com/staccato/memory/service/MemoryMembers.java

+public class MemoryMembers {
+    private final List<MemoryMember> memoryMembers;
+
+    public List<Memory> operate(List<String> filters, String sort) {


필터링과 정렬 연산을 수행하는 역할을 합니다. 도메인일까요, 서비스일까요?

음 명확하게 구분하는 것이 애매할 수 있지만 지금 구성에서는 MemoryFilter와 MemroySort를 통해 결과를 반환하는 역할이기에 stream과 굉장히 유사한 역할을 하고있다고 생각합니다 따라서 도메인보다는 서비스의 성격에 가깝지 않나라는 생각을 했습니다

linirini · 2025-01-08T19:06:51Z

backend/src/main/java/com/staccato/memory/service/MemoryService.java

-        sortByCreatedAtDescending(memoryMembers);
+    public MemoryNameResponses readAllMemoriesByDate(Member member, LocalDate currentDate) {
+        MemoryMembers memoryMembers = new MemoryMembers(memoryMemberRepository.findAllByMemberIdAndDate(member.getId(), currentDate));
+        List<Memory> memories = memoryMembers.operate();


default용 operate() 메서드를 오버로딩했습니다. 내부적으로 operate(Filter, Sort)를 호출합니다.

위의 코멘트와 유사하게 만약 현재의 MemoryMembers가 Memories로 변화하면서 필드로 List<Memory>를 가지게 된다면 해당 메서드는 없어질 수 있을 것 같아요!

linirini · 2025-01-08T19:09:08Z

backend/src/main/java/com/staccato/memory/service/dto/request/MemoryReadRequest.java

+    @Schema(hidden = true)
+    public List<String> getFilters() {
+        List<String> filters = new ArrayList<>();
+        if (isActive(term)) {


아주........마음에 안듭니다...... 이상태로는 필터링 조건이 늘어날 때마다 분기가 늘어날텐데 분기 처리를 줄일 수 있는 방법이 떠오르지 않아요..

위의 코멘트에 달아놓은 것 처럼 List<Enum>으로 받는다면 해결 가능할 것 같네요

Ho-Tea

고생하셨습니다 리니!!!
개인적으로 많은 고민과 시간이 쏟아부어진 느낌이 드네요🥲
얘기나눠볼 코멘트 달아드렸으니 확인 부탁드려요!

Ho-Tea · 2025-01-10T08:59:31Z

backend/src/main/java/com/staccato/memory/domain/Term.java

@@ -42,18 +39,18 @@ private boolean isOnlyOneDatePresent(LocalDate startAt, LocalDate endAt) {
    }

    private boolean isInvalidTerm(LocalDate startAt, LocalDate endAt) {
-        return isExist(startAt, endAt) && endAt.isBefore(startAt);
+        return Objects.nonNull(startAt) && Objects.nonNull(endAt) && endAt.isBefore(startAt);


밑에서 사용하는 isExist()를 사용하지 않으신 이유가 있을까요?

Ho-Tea · 2025-01-10T09:43:17Z

backend/src/main/java/com/staccato/memory/service/MemoryMembers.java

+    private List<Memory> getMemories() {
+        return memoryMembers.stream()
+                .map(MemoryMember::getMemory)
+                .collect(Collectors.toList());


불변한다면 toList()를 사용하는게 더 나을 것 같아요!

Ho-Tea · 2025-01-11T07:32:19Z

backend/src/main/java/com/staccato/memory/service/dto/request/MemoryReadRequest.java

+@Schema(description = "추억 목록 조회시 정렬과 필터링 조건을 위한 요청 형식입니다.")
+public record MemoryReadRequest(
+        @Schema(description = "기간 필터 사용 여부 (대소문자 구분 X)", example = "true")
+        String term,


기간 필터의 사용 유무라면 boolean으로 표현하는 방법도 있을 것 같은데 String으로 표현하신 이유가 있을가용?

우선은 추후 필터링 조건이 늘어날 수 있기에 String으로 표현하신걸로 알고 넘어갈게요!

필터링 조건이 중복되어 있을 수 있기에 처음 받을때 List<Enum>으로 받는다면 더 괜찮을 것 같아요!

public static class MemoryReadRequest { private List<Status> statuses; // Status 는 Enum GET /example?statuses=ACTIVE&statuses=INACTIVE&statuses=PENDING

Ho-Tea · 2025-01-11T07:42:30Z

backend/src/main/java/com/staccato/memory/service/MemoryService.java

-        List<MemoryMember> memoryMembers = memoryMemberRepository.findAllByMemberId(member.getId());
-        sortByCreatedAtDescending(memoryMembers);
+    public MemoryResponses readAllMemories(Member member, MemoryReadRequest memoryReadRequest) {
+        MemoryMembers memoryMembers = new MemoryMembers(memoryMemberRepository.findAllByMemberId(member.getId()));


현재 인자로 MemoryMember의 List 형을 받지만 내부적으로는 Memory 의 List만을 사용하는 것으로 보입니다.
클래스 명을 Memories로 변경하고 필드로 List<Memory>만 받는 것으로 바꾸는 건 어떨까요?
(memoryMembers.operate 가 조금은 어색하게 다가왔습니다)

Ho-Tea · 2025-01-11T07:47:02Z

backend/src/main/java/com/staccato/memory/service/MemoryFilter.java

+            memoryList.stream()
+                    .filter(Memory::hasTerm)
+                    .collect(Collectors.toList())


enum 내부에 함수형 인터페이스를 구현하는 것과 외부의 메서드로 메서드를 구성해놓은 것 중 함수형 인터페이스를 내부에 구현하는 방법을 선택하신 이유가 궁금합니다!

Ho-Tea · 2025-01-11T08:19:38Z

backend/src/main/java/com/staccato/memory/service/MemoryService.java

-        sortByCreatedAtDescending(memoryMembers);
+    public MemoryNameResponses readAllMemoriesByDate(Member member, LocalDate currentDate) {
+        MemoryMembers memoryMembers = new MemoryMembers(memoryMemberRepository.findAllByMemberIdAndDate(member.getId(), currentDate));
+        List<Memory> memories = memoryMembers.operate();


위의 코멘트와 유사하게 만약 현재의 MemoryMembers가 Memories로 변화하면서 필드로 List<Memory>를 가지게 된다면 해당 메서드는 없어질 수 있을 것 같아요!

Ho-Tea · 2025-01-11T08:20:54Z

backend/src/main/java/com/staccato/memory/service/MemorySort.java

+    private final Function<List<Memory>, List<Memory>> operation;
+
+    public static List<Memory> apply(String sortValue, List<Memory> memories) {
+        return Stream.of(MemorySort.values())


values() 만 사용해도 될 것 같아요!

Ho-Tea · 2025-01-11T08:34:13Z

backend/src/main/java/com/staccato/memory/service/dto/request/MemoryReadRequest.java

+    @Schema(hidden = true)
+    public List<String> getFilters() {
+        List<String> filters = new ArrayList<>();
+        if (isActive(term)) {


위의 코멘트에 달아놓은 것 처럼 List<Enum>으로 받는다면 해결 가능할 것 같네요

Ho-Tea · 2025-01-11T08:38:28Z

backend/src/main/java/com/staccato/config/domain/BaseEntity.java

+@Setter
 public abstract class BaseEntity {
    @CreatedDate
    private LocalDateTime createdAt;


createdAt까지 setter의 영향을 받을 수 있다 생각되어 새로운 updatedAt 수정 메서드만 구성하는게 좋을 것 같아요!

Ho-Tea · 2025-01-11T08:39:57Z

backend/src/main/java/com/staccato/moment/domain/Moment.java

@@ -25,6 +27,7 @@

 @Entity
 @Getter
+@EntityListeners({MomentEntityListener.class})


해당 Moment 내부에서 메서드를 구현한 후 EntityListener를 구성하는 방법도 있었는데 새롭게 클래스를 만드신 이유가 궁금해요!

linirini added 26 commits December 5, 2024 20:16

refactor: Moment 단위 테스트 픽스처 리팩터링

54cdeaf

refactor: 메서드 순서 조정

cde822a

refactor: 메서드명 변경

4db59bb

refactor: 컨텍스트 재사용 구조로 controller 단위 테스트 리팩터링

e190916

refactor: 픽스처 메서드명 변경

1fe325c

refactor: 정렬 책임 분리

ab4d6ba

feat: 스타카토 CUD 시 추억 수정일시 갱신되도록 구현

1042629

refactor: 서비스 테스트에서 하위 계층 테스트에서 이미 검증했던 부분에 대한 검증 제거

f24ccaa

refactor: MomentRequest 픽스처 분리

fb9e955

refactor: flush 전에 updatedAt 갱신하도록 listener 변경

d62b4b3

test: test 오류 수정

43c7d32

feat: 최근 수정 순으로 추억 정렬

42da4dc

feat: 최신순/오래된순으로 추억 정렬

92ae0ea

feat: 기간이 있는 추억만 필터링하여 조회

f1cb8da

feat: 추억 목록 조회 시 필터링 정렬 조건 받도록 컨트롤러 구현

3d84cbd

feat: 기본 필터링/정렬 조건 세팅

05ee85f

refactor: 필터링 Enum 분리

fd33b64

refactor: 정렬 Enum 분리

0d021ab

refactor: 정렬과 필터링 관심사 분리

0c007e3

fix: 유효하지 않은 필터링 값은 무시하도록 구현

a23724f

docs: API 명세서 작성

f342d17

fix: 테스트 인자 타입 오류 수정

4ea0727

test: 유효하지 않은 필터링 조건은 무시하는 컨트롤러 테스트 추가

b00778d

docs: 명세서 예시 수정

5d5ff3b

docs: 사용하지 않는 query string은 명세서에 뜨지 않도록 수정

ee37cfc

docs: 정렬/필터링 값 설명 보충

d6e8bc8

linirini added backend We are backend>< feat 기능 (새로운 기능) labels Jan 8, 2025

linirini requested review from BurningFalls and Ho-Tea January 8, 2025 18:59

linirini self-assigned this Jan 8, 2025

linirini linked an issue Jan 8, 2025 that may be closed by this pull request

feat: 추억 목록 정렬, 필터링 API 구현 #546

Open

10 tasks

linirini commented Jan 8, 2025

View reviewed changes

refactor: 중복 메서드 제거

0b3710c

linirini commented Jan 8, 2025

View reviewed changes

Ho-Tea requested changes Jan 11, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: 추억 목록 정렬, 필터링 API 구현 #583

feat: 추억 목록 정렬, 필터링 API 구현 #583

linirini commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading

linirini Jan 8, 2025

Ho-Tea Jan 11, 2025

linirini Jan 8, 2025

Ho-Tea Jan 11, 2025

linirini Jan 8, 2025

Ho-Tea Jan 11, 2025

Ho-Tea left a comment

Ho-Tea Jan 10, 2025

Ho-Tea Jan 10, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

Ho-Tea Jan 11, 2025

feat: 추억 목록 정렬, 필터링 API 구현 #583

Are you sure you want to change the base?

feat: 추억 목록 정렬, 필터링 API 구현 #583

Conversation

linirini commented Jan 8, 2025 • edited Loading

⭐️ Issue Number

🚩 Summary

🛠️ Technical Concerns

🙂 To Reviewer

📋 To Do

github-actions bot commented Jan 8, 2025 • edited Loading

Test Results

github-actions bot commented Jan 8, 2025 • edited Loading

🌻Test Coverage Report

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

Ho-Tea 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

linirini commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading

github-actions bot commented Jan 8, 2025 •

edited

Loading