[FEAT] 쿠폰 API 구현 - Redis Spin Lock, Pub/sub Lock

build.gradle

@@ -28,6 +28,7 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-data-redis'
 	implementation 'org.springframework.boot:spring-boot-starter-validation'
 	implementation 'org.springframework.boot:spring-boot-starter-web'
+	implementation 'org.redisson:redisson-spring-boot-starter:3.18.0'
 	compileOnly 'org.projectlombok:lombok'
 	runtimeOnly 'com.h2database:h2'
 	runtimeOnly 'com.mysql:mysql-connector-j'

src/main/java/com/example/book_your_seat/common/SessionConst.java

@@ -2,4 +2,5 @@
 
 public class SessionConst {
     public static final String LOGIN_USER = "loginUser";
+
 }

src/main/java/com/example/book_your_seat/common/constants/Constants.java

@@ -1,4 +1,6 @@
 package com.example.book_your_seat.common.constants;
 
 public final class Constants {
+
+    public static final String NOT_VALIDATION = "로그인은 필수 입니다";
 }

src/main/java/com/example/book_your_seat/coupon/CouponConst.java

@@ -0,0 +1,19 @@
+package com.example.book_your_seat.coupon;
+
+public final class CouponConst {
+
+    public static final String STOCK_ZERO = "수량이 부족합니다";
+
+    public static final String NOTFOUND_COUPON = "쿠폰을 찾을수 없습니다";
+
+    public static final String VALIDATION_COUPON = "이미 쿠폰을 받으셨습니다";
+
+    public static final String COUPON_MESSAGE = "축하합니다 쿠폰에 당첨되었습니다";
+
+    public static final String TIME_OUT = "redisson getLock timeout";
+
+    public static final String QUANTITY_COUPON = "수량을 입력해주세요";
+    public static final String DISCOUNT_COUPON = "할인률을 입력해주세요";
+
+    private CouponConst() {}
+}

src/main/java/com/example/book_your_seat/coupon/controller/CouponController.java

@@ -0,0 +1,32 @@
+package com.example.book_your_seat.coupon.controller;
+
+import com.example.book_your_seat.coupon.controller.Dto.CouponRequest;
+import com.example.book_your_seat.coupon.controller.Dto.CouponResponse;
+import com.example.book_your_seat.coupon.service.CouponCommandService;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+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.RestController;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/coupon")
+public class CouponController {
+
+    private final CouponCommandService couponCommandService;
+
+
+    @PostMapping
+    public ResponseEntity<CouponResponse> addCoupon(@RequestBody @Valid CouponRequest couponRequest) {
+        CouponResponse couponResponse = couponCommandService.saveCoupon(couponRequest);
+
+        return new ResponseEntity<>(couponResponse, HttpStatus.CREATED);
+    }
+
+
+
+}

src/main/java/com/example/book_your_seat/coupon/controller/Dto/CouponRequest.java

@@ -0,0 +1,28 @@
+package com.example.book_your_seat.coupon.controller.Dto;
+
+import com.example.book_your_seat.coupon.domain.Coupon;
+import com.example.book_your_seat.coupon.domain.DiscountRate;
+import com.fasterxml.jackson.annotation.JsonFormat;
+import jakarta.validation.constraints.NotNull;
+
+import java.time.LocalDateTime;
+
+import static com.example.book_your_seat.coupon.CouponConst.*;
+
+public record CouponRequest (
+
+    @NotNull(message = QUANTITY_COUPON)
+    Integer amount,
+
+    @NotNull(message = DISCOUNT_COUPON)
+    DiscountRate discountRate,
+
+    @JsonFormat(pattern = "yyyy-MM-dd'T'HH:mm:ss")
+    LocalDateTime dateTime
+
+    ){
+
+    public static Coupon to(CouponRequest couponRequest){
+        return new Coupon(couponRequest.amount, couponRequest.discountRate, couponRequest.dateTime);
+    }
+}

src/main/java/com/example/book_your_seat/coupon/controller/Dto/CouponResponse.java

@@ -0,0 +1,19 @@
+package com.example.book_your_seat.coupon.controller.Dto;
+
+import com.example.book_your_seat.coupon.domain.Coupon;
+import lombok.Getter;
+
+@Getter
+public class CouponResponse {
+
+    private Long id;
+
+    public CouponResponse(Long id) {
+        this.id = id;
+    }
+
+    public static CouponResponse fromDto(Coupon coupon) {
+        return new CouponResponse(coupon.getId());
+    }
+
+}

src/main/java/com/example/book_your_seat/coupon/controller/Dto/UserCouponResponse.java

@@ -0,0 +1,22 @@
+package com.example.book_your_seat.coupon.controller.Dto;
+
+import com.example.book_your_seat.coupon.domain.Coupon;
+import com.example.book_your_seat.coupon.domain.DiscountRate;
+import lombok.Getter;
+
+@Getter
+public class UserCouponResponse {
+
+    private String message;
+
+    private DiscountRate discountRate;
+
+    public UserCouponResponse(Coupon coupon, String message) {
+        this.message = message;
+        this.discountRate = coupon.getDiscountRate();
+    }
+
+    public static UserCouponResponse fromCoupon(Coupon coupon, String message) {
+        return new UserCouponResponse(coupon, message);
+    }
+}

src/main/java/com/example/book_your_seat/coupon/controller/UserCouponController.java

@@ -0,0 +1,45 @@
+package com.example.book_your_seat.coupon.controller;
+
+import com.example.book_your_seat.coupon.controller.Dto.UserCouponResponse;
+import com.example.book_your_seat.coupon.service.facade.LockCouponRedissonFacade;
+import com.example.book_your_seat.user.controller.dto.UserResponse;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpSession;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+import static com.example.book_your_seat.common.SessionConst.LOGIN_USER;
+import static com.example.book_your_seat.common.constants.Constants.NOT_VALIDATION;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/usersCoupon")
+public class UserCouponController {
+    private final LockCouponRedissonFacade lockCouponRedissonFacade;
+
+    @PostMapping
+    public ResponseEntity<UserCouponResponse> getCoupon(@RequestParam Long couponId, HttpServletRequest request) {
+
+        HttpSession session = request.getSession(false);
+
+        Long userId = sessionMember(session);
+
+        UserCouponResponse couponResponse = lockCouponRedissonFacade.useCoupon(userId, couponId);
+
+        return new ResponseEntity<>(couponResponse, HttpStatus.OK);
+    }
+
+    private static Long sessionMember(HttpSession session) {
+        if(session == null) {
+            throw new IllegalArgumentException(NOT_VALIDATION);
+        }
+        UserResponse userResponse = (UserResponse) session.getAttribute(LOGIN_USER);
+
+        return userResponse.userId();
+    }
+}

src/main/java/com/example/book_your_seat/coupon/domain/Coupon.java

@@ -10,12 +10,16 @@
 import jakarta.persistence.GenerationType;
 import jakarta.persistence.Id;
 import jakarta.persistence.OneToMany;
+
+import java.time.LocalDateTime;
 import java.util.ArrayList;
 import java.util.List;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+import static com.example.book_your_seat.coupon.CouponConst.STOCK_ZERO;
+
 @Entity
 @Getter
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
@@ -33,12 +37,25 @@ public class Coupon extends BaseEntity {
     @OneToMany(mappedBy = "coupon", cascade = CascadeType.ALL)
     private final List<UserCoupon> userCoupons = new ArrayList<>();
 
-    public Coupon(int amount, DiscountRate discountRate) {
+    private LocalDateTime expired;
+
+    public Coupon(int amount, DiscountRate discountRate, LocalDateTime expired) {
         this.amount = amount;
         this.discountRate = discountRate;
+        this.expired = expired;
     }
 
     public void addUserCoupon(UserCoupon userCoupon) {
         this.userCoupons.add(userCoupon);
     }
+
+    public void removeCoupon(int quantity){
+        if(amount - quantity < 0){
+            throw new IllegalArgumentException(STOCK_ZERO);
+        }
+
+        amount -= quantity;
+    }
+
+
 }

src/main/java/com/example/book_your_seat/coupon/domain/UserCoupon.java

@@ -31,9 +31,12 @@ public class UserCoupon extends BaseEntity {
     @JoinColumn(name = "coupon_id")
     private Coupon coupon;
 
+    private boolean useStatus;
+
     public UserCoupon(User user, Coupon coupon) {
         this.user = user;
         this.coupon = coupon;
+        this.coupon.removeCoupon(1);
         user.adduserCoupon(this);
         coupon.addUserCoupon(this);
     }

src/main/java/com/example/book_your_seat/coupon/repository/CouponRepository.java

@@ -4,4 +4,5 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 
 public interface CouponRepository extends JpaRepository<Coupon, Long> {
+
 }

src/main/java/com/example/book_your_seat/coupon/repository/UserCouponRepository.java

@@ -4,4 +4,6 @@
 import org.springframework.data.jpa.repository.JpaRepository;
 
 public interface UserCouponRepository extends JpaRepository<UserCoupon, Long> {
+
+    boolean existsByUserIdAndCouponId(Long userId, Long couponId);
 }

src/main/java/com/example/book_your_seat/coupon/repository/redis/RedisLockRepository.java

@@ -0,0 +1,27 @@
+package com.example.book_your_seat.coupon.repository.redis;
+
+import org.springframework.data.redis.core.RedisTemplate;
+import org.springframework.stereotype.Component;
+
+import java.time.Duration;
+
+@Component
+public class RedisLockRepository {
+
+    private RedisTemplate<String, String> redisTemplate;
+
+    public RedisLockRepository(RedisTemplate<String, String> redisTemplate) {
+        this.redisTemplate = redisTemplate;
+    }
+
+    public Boolean lock(Long key){
+
+        return redisTemplate
+                .opsForValue()
+                .setIfAbsent(key.toString(), "lock", Duration.ofMillis(3000));
+    }
+
+    public Boolean unlock(Long key){
+        return redisTemplate.delete(key.toString());
+    }
+}

src/main/java/com/example/book_your_seat/coupon/service/CouponCommandService.java

@@ -0,0 +1,17 @@
+package com.example.book_your_seat.coupon.service;
+
+import com.example.book_your_seat.coupon.controller.Dto.CouponRequest;
+import com.example.book_your_seat.coupon.controller.Dto.CouponResponse;
+import com.example.book_your_seat.coupon.controller.Dto.UserCouponResponse;
+
+public interface CouponCommandService {
+
+    UserCouponResponse useCoupon(Long userId, Long couponId);
+
+
+
+    CouponResponse saveCoupon(CouponRequest couponRequest);
+
+
+
+}

src/main/java/com/example/book_your_seat/coupon/service/CouponCommandServiceImpl.java

@@ -0,0 +1,60 @@
+package com.example.book_your_seat.coupon.service;
+
+import com.example.book_your_seat.coupon.controller.Dto.CouponRequest;
+import com.example.book_your_seat.coupon.controller.Dto.CouponResponse;
+import com.example.book_your_seat.coupon.controller.Dto.UserCouponResponse;
+import com.example.book_your_seat.coupon.domain.Coupon;
+import com.example.book_your_seat.coupon.domain.UserCoupon;
+import com.example.book_your_seat.coupon.repository.CouponRepository;
+import com.example.book_your_seat.coupon.repository.UserCouponRepository;
+import com.example.book_your_seat.user.domain.User;
+import com.example.book_your_seat.user.repository.UserRepository;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import static com.example.book_your_seat.coupon.CouponConst.*;
+import static com.example.book_your_seat.user.UserConst.NOTFOUND_USER;
+
+
+@Service
+@RequiredArgsConstructor
+@Slf4j
+public class CouponCommandServiceImpl implements CouponCommandService{
+
+    private final CouponRepository couponRepository;
+    private final UserCouponRepository userCouponRepository;
+    private final UserRepository userRepository;
+
+    @Override
+    public UserCouponResponse useCoupon(Long userId, Long couponId) {
+        validationUserCoupon(userId, couponId);
+
+        User user = userRepository.findById(userId).orElseThrow(() -> new IllegalArgumentException(NOTFOUND_USER));
+        Coupon coupon = couponRepository.findById(couponId).orElseThrow(() -> new IllegalArgumentException(NOTFOUND_COUPON)); //쿠폰 찾기
+
+        userCouponRepository.save( new UserCoupon(user, coupon)); // 쿠폰 발급
+
+        return UserCouponResponse.fromCoupon(coupon, COUPON_MESSAGE);
+    }
+
+
+    @Override
+    public CouponResponse saveCoupon(CouponRequest couponRequest) {
+
+        Coupon coupon = CouponRequest.to(couponRequest);
+
+        couponRepository.save(coupon);
+
+        return CouponResponse.fromDto(coupon);
+    }
+
+
+    public void validationUserCoupon(Long userId, Long couponId) {
+        if(userCouponRepository.existsByUserIdAndCouponId(userId, couponId)) {
+            throw new IllegalArgumentException(VALIDATION_COUPON);
+        }
+    }
+
+}