Merge pull request #156 from prgrms-web-devcourse/feature/book-recent-search

[#155]최근 도서 검색어 기능 구현

Author: tinajeong

src/docs/asciidoc/index.adoc

@@ -451,6 +451,29 @@ include::{snippets}/book-controller-slice-test/find-book_success/http-response.a
 
 include::{snippets}/book-controller-slice-test/find-book_success/response-fields.adoc[]
 
+=== 최근 책 검색어
+
+==== Request
+
+include::{snippets}/book-controller-slice-test/test-find-recent-query/http-request.adoc[]
+
+==== Request Param
+
+include::{snippets}/book-controller-slice-test/test-find-recent-query/request-parameters.adoc[]
+
+==== Request Header
+
+include::{snippets}/book-controller-slice-test/test-find-recent-query/request-headers.adoc[]
+
+==== Response
+
+include::{snippets}/book-controller-slice-test/test-find-recent-query/http-response.adoc[]
+
+==== Response fields
+
+include::{snippets}/book-controller-slice-test/test-find-recent-query/response-fields.adoc[]
+
+
 === 책 상세 정보
 
 ==== Request

src/main/java/com/dadok/gaerval/domain/book/api/BookController.java

@@ -18,9 +18,11 @@
 import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
 
 import com.dadok.gaerval.domain.book.dto.request.BookCreateRequest;
+import com.dadok.gaerval.domain.book.dto.request.BookRecentSearchRequest;
 import com.dadok.gaerval.domain.book.dto.request.BookSearchRequest;
 import com.dadok.gaerval.domain.book.dto.request.SuggestionsBookFindRequest;
 import com.dadok.gaerval.domain.book.dto.response.BookIdResponse;
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponses;
 import com.dadok.gaerval.domain.book.dto.response.BookResponse;
 import com.dadok.gaerval.domain.book.dto.response.BookResponses;
 import com.dadok.gaerval.domain.book.dto.response.SuggestionsBookFindResponses;
@@ -52,8 +54,27 @@ public class BookController {
 	@GetMapping(produces = APPLICATION_JSON_VALUE)
 	@PreAuthorize(value = "hasAnyRole('ROLE_ADMIN', 'ROLE_USER','ROLE_ANONYMOUS')")
 	@LogHttpRequests
-	public ResponseEntity<BookResponses> findBooksByQuery(@ModelAttribute @Valid BookSearchRequest bookSearchRequest) {
-		return ResponseEntity.ok().body(bookService.findAllByKeyword(bookSearchRequest));
+	public ResponseEntity<BookResponses> findBooksByQuery(@ModelAttribute @Valid BookSearchRequest bookSearchRequest,
+		@CurrentUserPrincipal UserPrincipal userPrincipal) {
+		return ResponseEntity.ok().body(bookService.findAllByKeyword(bookSearchRequest, userPrincipal.getUserId()));
+	}
+
+	/**
+	 * <pre>
+	 *     사용자의 최근 검색어 목록을 가져온다.
+	 * </pre>
+	 *
+	 * @param bookRecentSearchRequest 가져올 검색어 개수
+	 * @return status : ok
+	 */
+	@GetMapping(value = "/recent-searches", produces = APPLICATION_JSON_VALUE)
+	@PreAuthorize(value = "hasAnyRole('ROLE_ADMIN', 'ROLE_USER','ROLE_ANONYMOUS')")
+	@LogHttpRequests
+	public ResponseEntity<BookRecentSearchResponses> findRecentQuery(
+		@ModelAttribute @Valid BookRecentSearchRequest bookRecentSearchRequest,
+		@CurrentUserPrincipal UserPrincipal userPrincipal) {
+		return ResponseEntity.ok()
+			.body(bookService.findKeywordsByUserId(userPrincipal.getUserId(), bookRecentSearchRequest.limit()));
 	}
 
 	/**

src/main/java/com/dadok/gaerval/domain/book/converter/BookMapper.java

@@ -5,9 +5,11 @@
 import org.mapstruct.ReportingPolicy;
 
 import com.dadok.gaerval.domain.book.dto.request.BookCreateRequest;
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponse;
 import com.dadok.gaerval.domain.book.dto.response.BookResponse;
 import com.dadok.gaerval.domain.book.dto.response.SearchBookResponse;
 import com.dadok.gaerval.domain.book.entity.Book;
+import com.dadok.gaerval.domain.book.entity.BookRecentSearch;
 import com.dadok.gaerval.global.common.JacocoExcludeGenerated;
 
 @Mapper(componentModel = "spring", unmappedTargetPolicy = ReportingPolicy.IGNORE)
@@ -25,4 +27,5 @@ default Book createBookRequestToEntity(BookCreateRequest bookCreateRequest) {
 			bookCreateRequest.apiProvider(), bookCreateRequest.publisher());
 	}
 
+	BookRecentSearchResponse entityToBookRecentSearchResponse(BookRecentSearch bookRecentSearch);
 }

src/main/java/com/dadok/gaerval/domain/book/dto/request/BookRecentSearchRequest.java

@@ -0,0 +1,14 @@
+package com.dadok.gaerval.domain.book.dto.request;
+
+import javax.validation.constraints.Max;
+import javax.validation.constraints.Min;
+
+public record BookRecentSearchRequest(
+	@Min(value = 1, message = "Limit must be at least 1")
+	@Max(value = 100, message = "Limit cannot exceed 100") Long limit
+) {
+
+	public BookRecentSearchRequest(Long limit) {
+		this.limit = limit == null ? 10L : limit;
+	}
+}

src/main/java/com/dadok/gaerval/domain/book/dto/request/SearchTarget.java

@@ -7,15 +7,14 @@
 @RequiredArgsConstructor
 public enum SearchTarget implements EnumType {
 
-	TITLE("title","책 제목"),
+	TITLE("title", "책 제목"),
 	PERSON("person", "인명"),
-	PUBLISHER("publisher","출판사"),
-	ISBN("isbn","isbn");
+	PUBLISHER("publisher", "출판사"),
+	ISBN("isbn", "isbn");
 
 	private final String name;
 	private final String description;
 
-
 	@Override
 	public String getName() {
 		return this.name;

src/main/java/com/dadok/gaerval/domain/book/dto/request/SortingPolicy.java

@@ -7,8 +7,8 @@
 @RequiredArgsConstructor
 public enum SortingPolicy implements EnumType {
 
-	ACCURACY("accuracy","정확도 순"),
-	LATEST("latest","최신순");
+	ACCURACY("accuracy", "정확도 순"),
+	LATEST("latest", "최신순");
 
 	private final String name;
 	private final String description;

src/main/java/com/dadok/gaerval/domain/book/dto/request/SuggestionsBookFindRequest.java

@@ -20,7 +20,8 @@ public record SuggestionsBookFindRequest(
 	SortDirection sortDirection
 ) {
 
-	public SuggestionsBookFindRequest(JobGroup jobGroup, Integer pageSize, Long bookCursorId, SortDirection sortDirection) {
+	public SuggestionsBookFindRequest(JobGroup jobGroup, Integer pageSize, Long bookCursorId,
+		SortDirection sortDirection) {
 		this.jobGroup = jobGroup;
 		this.pageSize = pageSize == null ? 10 : pageSize;
 		this.bookCursorId = bookCursorId;

src/main/java/com/dadok/gaerval/domain/book/dto/response/BookRecentSearchResponse.java

@@ -0,0 +1,12 @@
+package com.dadok.gaerval.domain.book.dto.response;
+
+import java.time.LocalDateTime;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+
+public record BookRecentSearchResponse(
+	String keyword,
+	@JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss", timezone = "Asia/Seoul")
+	LocalDateTime createdAt
+) {
+}

src/main/java/com/dadok/gaerval/domain/book/dto/response/BookRecentSearchResponses.java

@@ -0,0 +1,13 @@
+package com.dadok.gaerval.domain.book.dto.response;
+
+import java.util.List;
+
+public record BookRecentSearchResponses(
+	int count, // 결과 총 갯수
+	boolean isEmpty, // 반환 값이 0개인가
+	List<BookRecentSearchResponse> bookRecentSearchResponses
+) {
+	public BookRecentSearchResponses(List<BookRecentSearchResponse> bookRecentSearchResponses) {
+		this(bookRecentSearchResponses.size(), bookRecentSearchResponses.isEmpty(), bookRecentSearchResponses);
+	}
+}

src/main/java/com/dadok/gaerval/domain/book/dto/response/BookResponses.java

@@ -2,7 +2,7 @@
 
 import java.util.List;
 
-public record BookResponses (
+public record BookResponses(
 	Integer requestedPageNumber,
 	Integer requestedPageSize,
 	Boolean isLast,

src/main/java/com/dadok/gaerval/domain/book/dto/response/OriginalBookData.java

@@ -15,13 +15,15 @@ public record OriginalBookData(
 	String url,
 	String[] authors,
 	String[] translators
-	) {
+) {
 
 	@Override
 	public boolean equals(Object o) {
-		if (this == o) return true;
-		if (o == null || getClass() != o.getClass()) return false;
-		OriginalBookData that = (OriginalBookData) o;
+		if (this == o)
+			return true;
+		if (o == null || getClass() != o.getClass())
+			return false;
+		OriginalBookData that = (OriginalBookData)o;
 		return Objects.equals(contents, that.contents) &&
 			Objects.equals(datetime, that.datetime) &&
 			Objects.equals(isbn, that.isbn) &&

src/main/java/com/dadok/gaerval/domain/book/dto/response/SuggestionsBookFindResponses.java

@@ -6,7 +6,6 @@
 
 import com.dadok.gaerval.domain.job.entity.JobGroup;
 
-
 public record SuggestionsBookFindResponses(
 
 	boolean isFirst, // 첫번째냐

src/main/java/com/dadok/gaerval/domain/book/entity/BookComment.java

@@ -34,7 +34,7 @@ public class BookComment extends BaseTimeColumn {
 	private Long id;
 
 	@ManyToOne(fetch = FetchType.LAZY)
-	@JoinColumn(name= "user_id", nullable = false)
+	@JoinColumn(name = "user_id", nullable = false)
 	private User user;
 
 	@ManyToOne(fetch = FetchType.LAZY)
@@ -44,7 +44,6 @@ public class BookComment extends BaseTimeColumn {
 	@Column(name = "comment", nullable = false, length = 500)
 	private String comment;
 
-
 	protected BookComment(User user, Book book, String comment) {
 		this.user = user;
 		this.book = book;

src/main/java/com/dadok/gaerval/domain/book/entity/BookRecentSearch.java

@@ -0,0 +1,50 @@
+package com.dadok.gaerval.domain.book.entity;
+
+import javax.persistence.Column;
+import javax.persistence.Entity;
+import javax.persistence.FetchType;
+import javax.persistence.GeneratedValue;
+import javax.persistence.GenerationType;
+import javax.persistence.Id;
+import javax.persistence.JoinColumn;
+import javax.persistence.ManyToOne;
+import javax.persistence.Table;
+import javax.validation.constraints.Size;
+
+import com.dadok.gaerval.domain.user.entity.User;
+import com.dadok.gaerval.global.common.entity.BaseTimeColumn;
+import com.dadok.gaerval.global.util.CommonValidator;
+
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@Table(name = "book_recent_searches")
+@Getter
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+public class BookRecentSearch extends BaseTimeColumn {
+
+	@Id
+	@GeneratedValue(strategy = GenerationType.IDENTITY)
+	private Long id;
+
+	@ManyToOne(fetch = FetchType.LAZY)
+	@JoinColumn(name = "user_id", nullable = false)
+	private User user;
+
+	@Column(nullable = false)
+	@Size(min = 1)
+	private String keyword;
+
+	protected BookRecentSearch(User user, String keyword) {
+		this.user = user;
+		this.keyword = keyword;
+		CommonValidator.validateLengthGraterThen(keyword, 1, "검색어는 한글자 이상이어야 합니다.");
+	}
+
+	public static BookRecentSearch create(User user, String keyword) {
+		return new BookRecentSearch(user, keyword);
+	}
+
+}

src/main/java/com/dadok/gaerval/domain/book/repository/BookRecentSearchRepository.java

@@ -0,0 +1,8 @@
+package com.dadok.gaerval.domain.book.repository;
+
+import org.springframework.data.jpa.repository.JpaRepository;
+
+import com.dadok.gaerval.domain.book.entity.BookRecentSearch;
+
+public interface BookRecentSearchRepository extends JpaRepository<BookRecentSearch, Long>, BookRecentSearchSupport {
+}

src/main/java/com/dadok/gaerval/domain/book/repository/BookRecentSearchSupport.java

@@ -0,0 +1,8 @@
+package com.dadok.gaerval.domain.book.repository;
+
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponses;
+
+public interface BookRecentSearchSupport {
+	BookRecentSearchResponses findRecentSearches(Long userId, Long limit);
+}
+

src/main/java/com/dadok/gaerval/domain/book/repository/BookRecentSearchSupportImpl.java

@@ -0,0 +1,36 @@
+package com.dadok.gaerval.domain.book.repository;
+
+import static com.dadok.gaerval.domain.book.entity.QBookRecentSearch.*;
+import static com.dadok.gaerval.domain.user.entity.QUser.*;
+
+import java.util.List;
+
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponse;
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponses;
+import com.querydsl.core.types.Projections;
+import com.querydsl.jpa.impl.JPAQueryFactory;
+
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+public class BookRecentSearchSupportImpl implements BookRecentSearchSupport {
+
+	private final JPAQueryFactory query;
+
+	@Override
+	public BookRecentSearchResponses findRecentSearches(Long userId, Long limit) {
+		List<BookRecentSearchResponse> bookRecentSearchResponseList = query.select(
+				Projections.constructor(BookRecentSearchResponse.class,
+					bookRecentSearch.keyword.as("keyword"),
+					bookRecentSearch.createdAt.as("createdAt")
+				)
+			)
+			.from(bookRecentSearch)
+			.innerJoin(user).on(user.id.eq(bookRecentSearch.user.id))
+			.orderBy(bookRecentSearch.createdAt.desc())
+			.limit(limit)
+			.fetch();
+
+		return new BookRecentSearchResponses(bookRecentSearchResponseList);
+	}
+}

src/main/java/com/dadok/gaerval/domain/book/service/BookService.java

@@ -5,6 +5,7 @@
 import com.dadok.gaerval.domain.book.dto.request.BookCreateRequest;
 import com.dadok.gaerval.domain.book.dto.request.BookSearchRequest;
 import com.dadok.gaerval.domain.book.dto.request.SuggestionsBookFindRequest;
+import com.dadok.gaerval.domain.book.dto.response.BookRecentSearchResponses;
 import com.dadok.gaerval.domain.book.dto.response.BookResponse;
 import com.dadok.gaerval.domain.book.dto.response.BookResponses;
 import com.dadok.gaerval.domain.book.dto.response.SuggestionsBookFindResponses;
@@ -13,7 +14,7 @@
 
 public interface BookService {
 
-	BookResponses findAllByKeyword(BookSearchRequest bookSearchRequest);
+	BookResponses findAllByKeyword(BookSearchRequest bookSearchRequest, Long userId);
 
 	Long createBookAndReturnId(BookCreateRequest bookCreateRequest);
 
@@ -28,4 +29,6 @@ public interface BookService {
 	SuggestionsBookFindResponses findSuggestionBooks(SuggestionsBookFindRequest request);
 
 	UserByBookResponses findUserByBookId(Long bookId, Long userId);
+
+	BookRecentSearchResponses findKeywordsByUserId(Long userId, Long limit);
 }

src/main/java/com/dadok/gaerval/domain/book/service/DefaultBookCommentService.java

@@ -46,7 +46,7 @@ public Long createBookComment(Long bookId, Long userId, BookCommentCreateRequest
 		boolean existsComment = bookCommentRepository.existsByBookIdAndUserId(bookId, userId);
 		boolean existsBookmark = bookshelfService.existsByUserIdAndBookId(userId, bookId);
 
-		if(!existsBookmark) {
+		if (!existsBookmark) {
 			throw new NotMarkedBookException(ErrorCode.INVALID_COMMENT_NOT_BOOKMARK);
 		}
 		if (existsComment) {
@@ -82,7 +82,7 @@ public BookCommentResponse updateBookComment(Long bookId, Long userId,
 		BookCommentUpdateRequest bookCommentUpdateRequest) {
 		boolean existsBookmark = bookshelfService.existsByUserIdAndBookId(userId, bookId);
 
-		if(!existsBookmark) {
+		if (!existsBookmark) {
 			throw new NotMarkedBookException(ErrorCode.INVALID_COMMENT_NOT_BOOKMARK);
 		}
 		return bookCommentRepository.updateBookComment(bookId, userId, bookCommentUpdateRequest);