Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: 페이징 방식을 오프셋 기반에서 커서 기반으로 변경한다. #44

Merged
merged 6 commits into from
Aug 31, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import com.dnd.accompany.domain.accompany.api.dto.CreateAccompanyBoardRequest;
import com.dnd.accompany.domain.accompany.api.dto.CreateAccompanyBoardResponse;
import com.dnd.accompany.domain.accompany.api.dto.CreateAccompanyRequest;
import com.dnd.accompany.domain.accompany.api.dto.PageRequest;
import com.dnd.accompany.domain.accompany.api.dto.PageResponse;
import com.dnd.accompany.domain.accompany.api.dto.ReadAccompanyBoardResponse;
import com.dnd.accompany.domain.accompany.entity.enums.Region;
Expand Down Expand Up @@ -50,13 +51,11 @@ public ResponseEntity<CreateAccompanyBoardResponse> create(
}

@Operation(summary = "동행글 목록 조회")
@GetMapping
@PostMapping("/all")
public ResponseEntity<PageResponse<AccompanyBoardThumbnail>> readAll(
@PageableDefault(
sort = {"updatedAt", "createdAt"},
direction = Sort.Direction.DESC) Pageable pageable,
@RequestBody @Valid PageRequest request,
@RequestParam(value = "region", required = false) Region region) {
return ResponseEntity.ok(accompanyBoardService.getAllBoards(pageable, region));
return ResponseEntity.ok(accompanyBoardService.getAllBoards(request, region));
}

@Operation(summary = "동행글 상세 조회")
Expand Down Expand Up @@ -93,12 +92,10 @@ public ResponseEntity<Void> remove(
}

@Operation(summary = "동행 기록 조회")
@GetMapping("/records")
@PostMapping("/records")
public ResponseEntity<PageResponse<AccompanyBoardThumbnail>> readAllRecords(
@PageableDefault(
sort = {"createdAt"},
direction = Sort.Direction.DESC) Pageable pageable,
@RequestBody @Valid PageRequest request,
@AuthenticationPrincipal JwtAuthentication user) {
return ResponseEntity.ok(accompanyBoardService.getAllRecords(pageable, user.getId()));
return ResponseEntity.ok(accompanyBoardService.getAllRecords(request, user.getId()));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.dnd.accompany.domain.accompany.api.dto.PageRequest;
import com.dnd.accompany.domain.accompany.api.dto.PageResponse;
import com.dnd.accompany.domain.accompany.api.dto.ReadAccompanyResponse;
import com.dnd.accompany.domain.accompany.api.dto.ReceivedAccompany;
Expand All @@ -20,9 +22,8 @@
import com.dnd.accompany.domain.auth.dto.jwt.JwtAuthentication;

import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.tags.Tag;
import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;

@Tag(name = "AccompanyRequest")
Expand All @@ -35,23 +36,19 @@ public class AccompanyRequestController {
private final AccompanyRequestService accompanyRequestService;

@Operation(summary = "보낸 동행 신청서 목록 조회")
@GetMapping("/sended")
@PostMapping("/sended")
public ResponseEntity<PageResponse<SendedAccompany>> readAllSended(
@PageableDefault(
sort = {"updatedAt", "createdAt"},
direction = Sort.Direction.DESC) Pageable pageable,
@RequestBody @Valid PageRequest request,
@AuthenticationPrincipal JwtAuthentication user) {
return ResponseEntity.ok(accompanyRequestService.getAllSendedAccompanies(pageable, user.getId()));
return ResponseEntity.ok(accompanyRequestService.getAllSendedAccompanies(request, user.getId()));
}

@Operation(summary = "받은 동행 신청서 목록 조회")
@GetMapping("/received")
@PostMapping("/received")
public ResponseEntity<PageResponse<ReceivedAccompany>> readAllReceived(
@PageableDefault(
sort = {"updatedAt", "createdAt"},
direction = Sort.Direction.DESC) Pageable pageable,
@RequestBody @Valid PageRequest request,
@AuthenticationPrincipal JwtAuthentication user) {
return ResponseEntity.ok(accompanyRequestService.getAllReceivedAccompanies(pageable, user.getId()));
return ResponseEntity.ok(accompanyRequestService.getAllReceivedAccompanies(request, user.getId()));
}

@Operation(summary = "동행 신청서 조회")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,31 @@
import java.util.Arrays;
import java.util.List;

public record FindApplicantDetailsResult(
Long requestId,
Long userId,
String nickname,
String provider,
String profileImageUrl,
String imageUrls
) {
import lombok.Getter;
import lombok.experimental.SuperBuilder;

@Getter
@SuperBuilder
public class FindApplicantDetailsResult extends FindSlicesResult {
private final Long requestId;
private final Long userId;
private final String nickname;
private final String provider;
private final String profileImageUrl;
private final String imageUrls;

public FindApplicantDetailsResult(Long requestId, Long userId, String nickname, String provider,
String profileImageUrl, String imageUrls, String cursor) {
super(cursor);

this.requestId = requestId;
this.userId = userId;
this.nickname = nickname;
this.provider = provider;
this.profileImageUrl = profileImageUrl;
this.imageUrls = imageUrls;
}

public List<String> getImageUrlsAsList() {
if (imageUrls == null || imageUrls.isEmpty()) {
return emptyList();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,37 @@

import com.dnd.accompany.domain.accompany.entity.enums.Region;

public record FindBoardThumbnailsResult(
Long requestId,
String title,
Region region,
LocalDateTime startDate,
LocalDateTime endDate,
String nickname,
String imageUrls
) {
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;

@Getter
@SuperBuilder
public class FindBoardThumbnailsResult extends FindSlicesResult{
private final Long requestId;
private final String title;
private final Region region;
private final LocalDateTime startDate;
private final LocalDateTime endDate;
private final String nickname;
private final String imageUrls;

public FindBoardThumbnailsResult(Long requestId, String title, Region region,
LocalDateTime startDate, LocalDateTime endDate,
String nickname, String imageUrls, String cursor) {
super(cursor);

this.requestId = requestId;
this.title = title;
this.region = region;
this.startDate = startDate;
this.endDate = endDate;
this.nickname = nickname;
this.imageUrls = imageUrls;
}

public List<String> getImageUrlsAsList() {
if (imageUrls == null || imageUrls.isEmpty()) {
return emptyList();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package com.dnd.accompany.domain.accompany.api.dto;

import java.util.List;

import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Slice;
import org.springframework.data.domain.SliceImpl;

import lombok.AccessLevel;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.experimental.SuperBuilder;

@Getter
@AllArgsConstructor(access = AccessLevel.PROTECTED)
@SuperBuilder
public abstract class FindSlicesResult {
private final String cursor;

public static <T extends FindSlicesResult> String getLastCursor(List<T> result) {
return result.get(result.size() - 1).getCursor();
}

public static <T extends FindSlicesResult> Slice<T> createSlice(int size, List<T> content) {
boolean hasNext = content.size() > size;

if (hasNext) {
content.remove(content.size() - 1);
}

return new SliceImpl<>(content, PageRequest.of(0, size), hasNext);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
package com.dnd.accompany.domain.accompany.api.dto;

import java.time.LocalDateTime;

import org.springframework.boot.context.properties.bind.DefaultValue;
import org.springframework.lang.Nullable;

import com.querydsl.core.BooleanBuilder;
import com.querydsl.core.types.dsl.DateTimePath;
import com.querydsl.core.types.dsl.Expressions;
import com.querydsl.core.types.dsl.NumberPath;
import com.querydsl.core.types.dsl.NumberTemplate;
import com.querydsl.core.types.dsl.StringTemplate;

import io.swagger.v3.oas.annotations.media.Schema;

public record PageRequest(
@Schema(nullable = true) String cursor,
@Schema(nullable = true) Integer size
) {

public PageRequest {
if (size == null) {
size = 10;
}
}

public static BooleanBuilder cursorCondition(String cursor, DateTimePath<LocalDateTime> updatedAt, NumberPath<Long> id) {
BooleanBuilder builder = new BooleanBuilder();

if (cursor == null) return builder;

StringTemplate nextCursor = Expressions.stringTemplate(
"CONCAT(DATE_FORMAT({0}, '%Y%m%d%H%i%S'), LPAD(CAST({1} AS STRING), 6, '0'))",
updatedAt,
id
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Q. updatedA을 사용하는 이유가 있을까요 ?

Copy link
Collaborator Author

@min429 min429 Aug 30, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

커서 페이징은 정렬할 컬럼에 중복된 값이 존재하면 안되고, 순차적이어야 하기 때문에 updateAt 기준으로 정렬하면서 중복을 피하기 위해 boardId와 updateAt을 합쳐서 cursor를 만들었습니다.

정렬 기준이 updatedAt -> id 순서인데, 만약 cursor를 id로만 할 경우, id값을 기준으로 정렬되어있지 않기 때문에 값을 제대로 가져오지 못할 수도 있다고 판단했습니다.
예를들어, 데이터가 다음 그림과 같은경우, 만약 id만 cursor로 쓴다면 size가 1일때, id 3을 가져오고 나서 그 뒤의 값들을 읽을 수 없게 된다고 생각했습니다.
image

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

생성일 기준으로 정렬하는거면, id값도 어짜피 생성일 순서랑 같을 것 같아서 cursor를 id로 해도 상관없을 것 같은데, 업데이트 날짜 기준으로 정렬할 때는 두가지 다 고려해야하지 않을까 싶네요

builder.and(nextCursor.lt(cursor));

return builder;
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

public record PageResponse<T>(
boolean hasNext,
List<T> data
List<T> data,
String cursor
) {
}
Loading