[feat] 식당 좋아요 관련 api (#43)

* [feat] create Heart object

* [feat] add hearted store

* [fix] add transactional annotation

* [refac] change to Lazy loading

* [refac] rename class name

* [refac] delete cascade

* [feat] logic for heart additional

* [feat] add global exception handler

* [refac] delete unused import

* [feat] add logic for delete heart

* [feat] add logic for delete heart

* [feat] add logic for update total heart count

* [refac] renaming dto

* [refac] apply code reviews

* [refac] change to wrapper class

* [feat] add logic for heart service

* [refac] renaming api endpoint

* [refac] delete response dto

* [refac] apply code reviews

* [refac] rename path variable

* [refac] change variable name

* [refac] return response dto

* [refac] return response dto and change http code

* [refac] add final

* [refac] divided method responsibility

* [refac] change method name

* [refac] divide method responsibility

* [refac] apply code reviews

* [refac] add missing final keyword

Author: kgy1008

src/main/java/org/hankki/hankkiserver/api/advice/GlobalExceptionHandler.java

@@ -4,6 +4,7 @@
 import org.hankki.hankkiserver.api.dto.HankkiResponse;
 import org.hankki.hankkiserver.common.code.BusinessErrorCode;
 import org.hankki.hankkiserver.common.exception.BadRequestException;
+import org.hankki.hankkiserver.common.exception.ConflictException;
 import org.hankki.hankkiserver.common.exception.NotFoundException;
 import org.hankki.hankkiserver.common.exception.UnauthorizedException;
 
@@ -32,6 +33,12 @@ public HankkiResponse<Void> handleEntityNotFoundException(NotFoundException e) {
         return HankkiResponse.fail(e.getErrorCode());
     }
 
+    @ExceptionHandler(ConflictException.class)
+    public HankkiResponse<Void> handleConflictException(ConflictException e) {
+        log.error("handleConflictException() in GlobalExceptionHandler throw ConflictException : {}", e.getMessage());
+        return HankkiResponse.fail(e.getErrorCode());
+    }
+
     @ExceptionHandler(Exception.class)
     public HankkiResponse<Void> handleException(Exception e) {
         log.error("handleException() in GlobalExceptionHandler throw Exception : {}", e.getMessage());

src/main/java/org/hankki/hankkiserver/api/auth/service/AuthService.java

@@ -36,9 +36,9 @@ public class AuthService {
     private String adminKey;
 
     private final UserFinder userFinder;
-    private final UserSaver userSaver;
+    private final UserUpdater userUpdater;
     private final UserInfoFinder userInfoFinder;
-    private final UserInfoSaver userInfoSaver;
+    private final UserInfoUpdater userInfoUpdater;
     private final UserInfoDeleter userInfoDeleter;
     private final JwtProvider jwtProvider;
     private final JwtValidator jwtValidator;
@@ -131,9 +131,9 @@ private String getRefreshToken(final Long userId) {
     }
 
     private void saveUserAndUserInfo(final User user) {
-        userSaver.saveUser(user);
+        userUpdater.saveUser(user);
         UserInfo userInfo = UserInfo.createMemberInfo(user, null);
-        userInfoSaver.saveUserInfo(userInfo);
+        userInfoUpdater.saveUserInfo(userInfo);
     }
 
     private void validateRefreshToken(final String refreshToken, final Long userId) {

src/main/java/org/hankki/hankkiserver/api/auth/service/UserFinder.java

@@ -19,11 +19,15 @@ public class UserFinder {
 
     private final UserRepository userRepository;
 
-    public User getUser(final long userId) {
-        return userRepository.findById(userId)
+    public User getUser(final Long id) {
+        return userRepository.findById(id)
                 .orElseThrow(() -> new NotFoundException(UserErrorCode.USER_NOT_FOUND));
     }
 
+    public User getUserReference(final Long id) {
+        return userRepository.getReferenceById(id);
+    }
+
     public boolean isRegisteredUser(final Platform platform, final SocialInfoDto socialInfo) {
         return userRepository.existsByPlatformAndSerialIdAndMemberStatus(
                 platform,

src/main/java/org/hankki/hankkiserver/api/auth/service/UserInfoDeleter.java

@@ -10,7 +10,7 @@ public class UserInfoDeleter {
 
     private final UserInfoRepository userInfoRepository;
 
-    public void softDelete(final long userId) {
+    public void softDelete(final Long userId) {
         userInfoRepository.softDeleteByUserId(userId);
     }
 }

src/main/java/org/hankki/hankkiserver/api/auth/service/UserInfoFinder.java

@@ -13,7 +13,7 @@ public class UserInfoFinder {
 
     private final UserInfoRepository userInfoRepository;
 
-    public UserInfo getUserInfo(final long userId) {
+    public UserInfo getUserInfo(final Long userId) {
         return userInfoRepository.findByUserId(userId)
                 .orElseThrow(() -> new NotFoundException(UserErrorCode.USER_INFO_NOT_FOUND));
     }

src/main/java/org/hankki/hankkiserver/api/auth/service/UserInfoSaver.java renamed to src/main/java/org/hankki/hankkiserver/api/auth/service/UserInfoUpdater.java

@@ -7,7 +7,7 @@
 
 @Component
 @RequiredArgsConstructor
-public class UserInfoSaver {
+public class UserInfoUpdater {
 
     private final UserInfoRepository userInfoRepository;
 

src/main/java/org/hankki/hankkiserver/api/auth/service/UserSaver.java renamed to src/main/java/org/hankki/hankkiserver/api/auth/service/UserUpdater.java

@@ -7,7 +7,7 @@
 
 @Component
 @RequiredArgsConstructor
-public class UserSaver {
+public class UserUpdater {
 
     private final UserRepository userRepository;
 

src/main/java/org/hankki/hankkiserver/api/store/controller/StoreController.java

@@ -3,22 +3,27 @@
 import lombok.RequiredArgsConstructor;
 import org.hankki.hankkiserver.api.dto.HankkiResponse;
 import org.hankki.hankkiserver.api.store.service.StoreQueryService;
-import org.hankki.hankkiserver.api.store.service.response.CategoriesResponse;
-import org.hankki.hankkiserver.api.store.service.response.PriceCategoriesResponse;
-import org.hankki.hankkiserver.api.store.service.response.SortOptionsResponse;
-import org.hankki.hankkiserver.api.store.service.response.StoreThumbnailResponse;
+import org.hankki.hankkiserver.api.store.service.response.*;
 import org.hankki.hankkiserver.common.code.CommonSuccessCode;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
+import org.hankki.hankkiserver.auth.UserId;
+import org.hankki.hankkiserver.api.store.service.HeartCommandService;
+import org.hankki.hankkiserver.api.store.service.command.StoreDeleteCommand;
+import org.hankki.hankkiserver.api.store.service.command.StorePostCommand;
+import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.*;
+
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1")
 public class StoreController {
 
     private final StoreQueryService storeQueryService;
+    private final HeartCommandService heartCommandService;
 
     @GetMapping("/stores/{id}/thumbnail")
     public HankkiResponse<StoreThumbnailResponse> getStoreThumbnail(@PathVariable Long id) {
@@ -39,4 +44,14 @@ public HankkiResponse<SortOptionsResponse> getSortOptions() {
     public HankkiResponse<PriceCategoriesResponse> getPrices() {
         return HankkiResponse.success(CommonSuccessCode.OK, storeQueryService.getPriceCategories());
     }
+
+    @PostMapping("/stores/{id}/hearts")
+    public HankkiResponse<HeartCreateResponse> createHeartStore(@UserId final Long userId, @PathVariable final Long id) {
+        return HankkiResponse.success(CommonSuccessCode.CREATED, heartCommandService.createHeart(StorePostCommand.of(userId, id)));
+    }
+
+    @DeleteMapping("/stores/{id}/hearts")
+    public HankkiResponse<HeartDeleteResponse> deleteHeartStore(@UserId final Long userId, @PathVariable final Long id) {
+        return HankkiResponse.success(CommonSuccessCode.OK, heartCommandService.deleteHeart(StoreDeleteCommand.of(userId, id)));
+    }
 }

src/main/java/org/hankki/hankkiserver/api/store/service/HeartCommandService.java

@@ -0,0 +1,69 @@
+package org.hankki.hankkiserver.api.store.service;
+
+import lombok.RequiredArgsConstructor;
+import org.hankki.hankkiserver.api.auth.service.UserFinder;
+import org.hankki.hankkiserver.api.store.service.command.StoreDeleteCommand;
+import org.hankki.hankkiserver.api.store.service.command.StorePostCommand;
+import org.hankki.hankkiserver.api.store.service.response.HeartCreateResponse;
+import org.hankki.hankkiserver.api.store.service.response.HeartDeleteResponse;
+import org.hankki.hankkiserver.common.code.HeartErrorCode;
+import org.hankki.hankkiserver.common.exception.ConflictException;
+import org.hankki.hankkiserver.domain.heart.model.Heart;
+import org.hankki.hankkiserver.domain.store.model.Store;
+import org.hankki.hankkiserver.domain.user.model.User;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service
+@RequiredArgsConstructor
+@Transactional
+public class HeartCommandService {
+
+    private final HeartUpdater heartUpdater;
+    private final HeartFinder heartFinder;
+    private final HeartDeleter heartDeleter;
+    private final UserFinder userFinder;
+    private final StoreFinder storeFinder;
+
+    public HeartCreateResponse createHeart(final StorePostCommand storePostCommand) {
+        User user = userFinder.getUserReference(storePostCommand.userId());
+        Store store = storeFinder.getStoreReference(storePostCommand.storeId());
+        validateStoreHeartCreation(user, store);
+        saveStoreHeart(user, store);
+        increaseStoreHeartCount(store);
+        return HeartCreateResponse.of(store.getId(), true);
+    }
+
+    public HeartDeleteResponse deleteHeart(final StoreDeleteCommand storeDeleteCommand) {
+        User user = userFinder.getUserReference(storeDeleteCommand.userId());
+        Store store = storeFinder.getStoreReference(storeDeleteCommand.storeId());
+        validateStoreHeartRemoval(user, store);
+        heartDeleter.deleteHeart(user,store);
+        decreaseStoreHeartCount(store);
+        return HeartDeleteResponse.of(store.getId(), false);
+    }
+
+    private void validateStoreHeartCreation(final User user, final Store store) {
+        if(heartFinder.existsByUserAndStore(user, store)){
+            throw new ConflictException(HeartErrorCode.ALREADY_EXISTED_HEART);
+        }
+    }
+
+    private void validateStoreHeartRemoval(final User user, final Store store) {
+        if(!heartFinder.existsByUserAndStore(user, store)){
+            throw new ConflictException(HeartErrorCode.ALREADY_NO_HEART);
+        }
+    }
+
+    private void saveStoreHeart(final User user, final Store store) {
+        heartUpdater.saveHeart(Heart.createHeart(user, store));
+    }
+
+    private void increaseStoreHeartCount(final Store store) {
+        store.increaseHeartCount();
+    }
+
+    private void decreaseStoreHeartCount(final Store store) {
+        store.decreaseHeartCount();
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/HeartDeleter.java

@@ -0,0 +1,18 @@
+package org.hankki.hankkiserver.api.store.service;
+
+import lombok.RequiredArgsConstructor;
+import org.hankki.hankkiserver.domain.heart.repository.HeartRepository;
+import org.hankki.hankkiserver.domain.store.model.Store;
+import org.hankki.hankkiserver.domain.user.model.User;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class HeartDeleter {
+
+    private final HeartRepository heartRepository;
+
+    public void deleteHeart(final User user, final Store store) {
+        heartRepository.deleteByUserAndStore(user, store);
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/HeartFinder.java

@@ -0,0 +1,21 @@
+package org.hankki.hankkiserver.api.store.service;
+
+import lombok.RequiredArgsConstructor;
+import org.hankki.hankkiserver.domain.heart.model.Heart;
+import org.hankki.hankkiserver.domain.heart.repository.HeartRepository;
+import org.hankki.hankkiserver.domain.store.model.Store;
+import org.hankki.hankkiserver.domain.user.model.User;
+import org.springframework.stereotype.Component;
+
+import java.util.Optional;
+
+@Component
+@RequiredArgsConstructor
+public class HeartFinder {
+
+    private final HeartRepository heartRepository;
+
+    public boolean existsByUserAndStore(final User user, final Store store) {
+        return heartRepository.existsByUserAndStore(user, store);
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/HeartUpdater.java

@@ -0,0 +1,17 @@
+package org.hankki.hankkiserver.api.store.service;
+
+import lombok.RequiredArgsConstructor;
+import org.hankki.hankkiserver.domain.heart.model.Heart;
+import org.hankki.hankkiserver.domain.heart.repository.HeartRepository;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class HeartUpdater {
+
+    private final HeartRepository heartRepository;
+
+    public void saveHeart(final Heart heart) {
+        heartRepository.save(heart);
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/StoreFinder.java

@@ -17,4 +17,8 @@ protected Store findByIdWhereDeletedIsFalse(Long id) {
         return storeRepository.findByIdAndIsDeletedIsFalse(id)
                 .orElseThrow(() -> new NotFoundException(StoreErrorCode.STORE_NOT_FOUND));
     }
+
+    public Store getStoreReference(final Long id) {
+        return storeRepository.getReferenceById(id);
+    }
 }

src/main/java/org/hankki/hankkiserver/api/store/service/command/StoreDeleteCommand.java

@@ -0,0 +1,11 @@
+package org.hankki.hankkiserver.api.store.service.command;
+
+public record StoreDeleteCommand(
+        Long userId,
+        Long storeId
+) {
+    public static StoreDeleteCommand of(final Long userId, final Long storeId) {
+        return new StoreDeleteCommand(userId, storeId);
+    }
+}
+

src/main/java/org/hankki/hankkiserver/api/store/service/command/StorePostCommand.java

@@ -0,0 +1,10 @@
+package org.hankki.hankkiserver.api.store.service.command;
+
+public record StorePostCommand(
+        Long userId,
+        Long storeId
+) {
+    public static StorePostCommand of(final Long userId, final Long storeId) {
+        return new StorePostCommand(userId, storeId);
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/response/HeartCreateResponse.java

@@ -0,0 +1,10 @@
+package org.hankki.hankkiserver.api.store.service.response;
+
+public record HeartCreateResponse(
+        Long storeId,
+        boolean isHearted
+) {
+    public static HeartCreateResponse of(final Long storeId, final boolean isHearted) {
+        return new HeartCreateResponse(storeId, isHearted);
+    }
+}

src/main/java/org/hankki/hankkiserver/api/store/service/response/HeartDeleteResponse.java

@@ -0,0 +1,10 @@
+package org.hankki.hankkiserver.api.store.service.response;
+
+public record HeartDeleteResponse(
+        Long storeId,
+        boolean isHearted
+) {
+    public static HeartDeleteResponse of(final Long storeId, final boolean isHearted) {
+        return new HeartDeleteResponse(storeId, isHearted);
+    }
+}

src/main/java/org/hankki/hankkiserver/common/code/HeartErrorCode.java

@@ -0,0 +1,16 @@
+package org.hankki.hankkiserver.common.code;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+
+@Getter
+@RequiredArgsConstructor
+public enum HeartErrorCode implements ErrorCode {
+
+    ALREADY_EXISTED_HEART(HttpStatus.CONFLICT, "이미 좋아요 한 가게입니다."),
+    ALREADY_NO_HEART(HttpStatus.CONFLICT, "이미 좋아요를 취소한 가게입니다.");
+
+    private final HttpStatus httpStatus;
+    private final String message;
+}

src/main/java/org/hankki/hankkiserver/common/exception/ConflictException.java

@@ -0,0 +1,14 @@
+package org.hankki.hankkiserver.common.exception;
+
+import lombok.Getter;
+import org.hankki.hankkiserver.common.code.ErrorCode;
+
+@Getter
+public class ConflictException extends RuntimeException {
+    private final ErrorCode errorCode;
+
+    public ConflictException(ErrorCode errorCode) {
+        super(errorCode.getMessage());
+        this.errorCode = errorCode;
+    }
+}

src/main/java/org/hankki/hankkiserver/domain/favoritestore/model/FavoriteStore.java

@@ -19,11 +19,11 @@ public class FavoriteStore {
     @Column(name = "favorite_store_id")
     private Long id;
 
-    @ManyToOne
+    @ManyToOne(fetch = FetchType.LAZY)
     @JoinColumn(name = "store_id")
     private Store store;
 
-    @ManyToOne
+    @ManyToOne(fetch = FetchType.LAZY)
     @JoinColumn(name = "favorite_id")
     private Favorite favorite;