[내일배움캠프_Spring Boot 숙련주차] My Select Shop(상품 폴더)

상품 폴더 설계

요구사항 분석

폴더 별로 관심상품을 저장/관리할 수 있는 기능 추가

• 폴더 생성
  - 회원별 폴더 추가
  - 폴더를 추가할 때 1개 ~ N개 한번에 추가 가능
• 관심상품에 폴더 설정
  - 관심상품에 폴더는 N개 설정 가능
  - 관심상품이 등록되는 시점에는 어느 폴더에도 저장되지 않음
  - 관심상품 별로 1번에서 생성한 폴더를 선택해 추가 가능
• 폴더 별 조회
  - 회원은 폴더 별로 관심상품 조회 가능
  - 조회 방법
  
  • '전체' 클릭 시: 폴더와 상관없이 회원이 저장한 전체 관심상품들 조회
  • '폴더명' 클릭 시: 폴더별 저장된 관심상품들을 조회

폴더와 회원 관계

• 폴더명(name): 회원이 등록한 폴더 이름 저장
• 폴더 : 회원 = N : 1 관계
• 회원 객체에서 폴더 객체를 조회하는 경우가 없기 때문에 폴더와 회원을 N : 1 단방향 연관관계로 설정

폴더 Entity와 Repository 생성

package com.sparta.myselectshop.entity;

import jakarta.persistence.*;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Entity
@Getter
@Setter
@NoArgsConstructor
@Table(name = "folder")
public class Folder {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(nullable = false)
    private String name;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "user_id", nullable = false)
    private User user;

    public Folder(String name, User user) {
        this.name = name;
        this.user = user;
    }
}

상품과 폴더 관계

1. 상품은 추가될 폴더의 정보가 필요함

상품 입장

• 관심 상품에 폴더 등록
• 상품은 여러 개의 폴더를 등록 가능
• 폴더 : 상품 = N : 1

2. 폴더에 관심 상품을 등록

폴더 입장

• 하나의 폴더는 여러 개의 상품을 포함할 수 있음
• 폴더 : 상품 = 1 : N

3. 결과적으로 상품과 폴더는 N : M 관계

상품과 폴더 관계

• 상품_폴더 중간 테이블 생성
• 상품 : 상품_폴더 = 1 : N
• 폴더 : 상품_폴더 = 1 : N

4. 연관관계의 방향 선택

• 관심 상품을 조회할 때 포함된 폴더들의 정보 필요(상품 객체가 폴더 객체 조회 필요)
• 상품 객체를 기준으로 해당 폴더에 포함된 상품들을 조회(상품 객체가 폴더 객체 조회 필요)
• 따라서 상품과 상품_폴더는 양방향 연관관계로 설정
• 폴더 객체에서 상품 객체를 조회하지 않을 예정이기 때문에 폴더는 상품_폴더와 관계 맺지 않음!

상품_폴더 Entity 및 Repository 생성

package com.sparta.myselectshop.entity;

import jakarta.persistence.*;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;

@Entity
@Getter
@Setter
@NoArgsConstructor
@Table(name = "product_folder")
public class ProductFolder {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "product_id", nullable = false)
    private Product product;

    @ManyToOne(fetch = FetchType.LAZY)
    @JoinColumn(name = "folder_id", nullable = false)
    private Folder folder;

    public ProductFolder(Product product, Folder folder) {
        this.product = product;
        this.folder = folder;
    }
}

 

Product 엔티티 내 상품_폴더 조회 가능하도록 수정

public class Product extends Timestamped {
	...
    
    @OneToMany(mappedBy = "product")
    private List<ProductFolder> productFolderList = new ArrayList<>();

    ...
}

---

폴더 생성 및 조회 구현

• 회원별 폴더 추가(폴더를 추가할 때 한 번에 여러 개 추가 가능)
• 회원별 저장한 폴더들 조회

API 설계

설명	URL	Request	Response
회원의 폴더 생성	POST /api/folders	{ folderName: [String, ...] }
회원의 폴더 조회	GET /api/user-folder		index.html model 추가 → folders

 

폴더 생성 API 구현

• controller > FolderController 내 폴더 생성 API 추가

package com.sparta.myselectshop.controller;

import com.sparta.myselectshop.dto.FolderRequestDto;
import com.sparta.myselectshop.security.UserDetailsImpl;
import com.sparta.myselectshop.service.FolderService;
import lombok.RequiredArgsConstructor;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
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;

import java.util.List;

@RestController
@RequestMapping("/api")
@RequiredArgsConstructor
public class FolderController {

    private final FolderService folderService;

    @PostMapping("/folders")
    public void addFolders(@RequestBody FolderRequestDto folderRequestDto, @AuthenticationPrincipal UserDetailsImpl userDetails) {
        List<String> folderNames = folderRequestDto.getFolderNames();

        folderService.addFolders(folderNames, userDetails.getUser());
    }
}

package com.sparta.myselectshop.dto;

import lombok.Getter;

import java.util.List;

@Getter
public class FolderRequestDto {
    List<String> folderNames;
}

• service > FolderService 내 폴더 생성 비즈니스 로직 생성

package com.sparta.myselectshop.service;

import com.sparta.myselectshop.entity.Folder;
import com.sparta.myselectshop.entity.User;
import com.sparta.myselectshop.repository.FolderRepository;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

import java.util.ArrayList;
import java.util.List;

@Service
@RequiredArgsConstructor
public class FolderService {

    private final FolderRepository folderRepository;

    public void addFolders(List<String> folderNames, User user) {
        // 폴더가 중복인지 확인
        // 유저 기준으로 찾고, 폴더 이름이 여러개(In)
        List<Folder> existFolderList = folderRepository.findAllByUserAndNameIn(user, folderNames);

        List<Folder> folderList = new ArrayList<>();

        for(String folderName : folderNames) {
            if(!isExistFolderName(folderName, existFolderList)) {
                // 중복되지 않을 때 폴더 저장
                Folder folder = new Folder(folderName, user);
                folderList.add(folder);
            } else {
                throw new IllegalArgumentException("폴더명이 중복되었습니다.");
            }
        }

        folderRepository.saveAll(folderList);
    }

    // 해당 이름을 가진 폴더가 존재하는지 확인하는 메서드
    private boolean isExistFolderName(String folderName, List<Folder> existFolderList) {
        for (Folder existFolder : existFolderList) {
            if(folderName.equals(existFolder.getName())) {
                return true;
            }
        }
        return false;
    }
}

package com.sparta.myselectshop.repository;

import com.sparta.myselectshop.entity.Folder;
import com.sparta.myselectshop.entity.User;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.List;

public interface FolderRepository extends JpaRepository<Folder, Long> {
    List<Folder> findAllByUserAndNameIn(User user, List<String> folderNames);
    // select * from folder where user_id = ? and name in (?, ?, ...);
}

폴더 조회 API 구현

• UserController 내 폴더 조회 API 추가

public class UserController {

    private final UserService userService;
    private final FolderService folderService;

	...

    @GetMapping("/user-folder")
    public String getUserInfo(Model model, @AuthenticationPrincipal UserDetailsImpl userDetails) {
        model.addAttribute("folders", folderService.getFolders(userDetails.getUser()));

        return "index :: #fragment";
    }
}

• FolderService 내 폴더 조회하는 비즈니스 로직 추가

package com.sparta.myselectshop.dto;

import com.sparta.myselectshop.entity.Folder;
import lombok.Getter;

@Getter
public class FolderResponseDto {
    private Long id;
    private String name;

    public FolderResponseDto(Folder folder) {
        this.id = folder.getId();
        this.name = folder.getName();
    }
}

public class FolderService {

    private final FolderRepository folderRepository;

    public List<FolderResponseDto> getFolders(User user) {
        List<Folder> folderList = folderRepository.findAllByUser(user);
        List<FolderResponseDto> responseDtoList = new ArrayList<>();

        for(Folder folder : folderList) {
            responseDtoList.add(new FolderResponseDto(folder));
        }
        
        return responseDtoList;
    }
}

• Product 조회 시, 폴더 정보도 같이 포함시키기

package com.sparta.myselectshop.dto;

import com.sparta.myselectshop.entity.Product;
import com.sparta.myselectshop.entity.ProductFolder;
import lombok.Getter;
import lombok.NoArgsConstructor;

import java.util.ArrayList;
import java.util.List;

@Getter
@NoArgsConstructor
public class ProductResponseDto {
    private Long id;
    private String title;
    private String link;
    private String image;
    private int lprice;
    private int myprice;

    private List<FolderResponseDto> productFolderList = new ArrayList<>();

    public ProductResponseDto(Product product) {
        this.id = product.getId();
        this.title = product.getTitle();
        this.link = product.getLink();
        this.image = product.getImage();
        this.lprice = product.getLprice();
        this.myprice = product.getMyprice();
        for (ProductFolder productFolder : product.getProductFolderList()) {
            productFolderList.add(new FolderResponseDto(productFolder.getFolder()));
        }
    }
}

public class ProductService {

    private final ProductRepository productRepository;

    public static final int MIN_MY_PRICE = 100;

    @Transactional(readOnly = true) // 트랜잭션 추가: 지연로딩, 성능 향상을 위해 readOnly 설정
    public Page<ProductResponseDto> getProducts(User user, int page, int size, String sortBy, boolean isAsc) {
        Sort.Direction direction = isAsc ? Sort.Direction.ASC : Sort.Direction.DESC;
        Sort sort = Sort.by(direction, sortBy); // Sort 객체 = (direction 방향, 정렬 항목)
        Pageable pageable = PageRequest.of(page, size, sort);

        // 현재 들어온 User의 권한이 Admin인지 User인지 확인
        UserRoleEnum userRoleEnum = user.getRole();

        Page<Product> productList;

        if(userRoleEnum == UserRoleEnum.USER) {
            productList = productRepository.findAllByUser(user, pageable);
        } else {
            productList = productRepository.findAll(pageable);
        }

        return productList.map(ProductResponseDto::new);
    }
}

폴더 생성 및 조회 API 호출 결과

---

관심 상품에 폴더 추가 구현

• 관심상품에 폴더는 0개 ~ N개 설정 가능

예시

• 관심상품이 등록되는 시점에는 어느 폴더에도 저장되지 않음
• 관심상품 별로 기 생성했던 폴더를 선택해 추가 가능

예시

관심 상품에 폴더 추가 API 설계

설명	URL	Request	Response
폴더 전체 조회	GET /api/folders		List<FolderResponseDto>
폴더 추가	POST /api/products/{productId}/folder	{productId}: 관심상품 ID [Form 형태] folderId: 추가할 폴더 ID

관심 상품에 폴더 추가 API 구현

폴더 전체 조회 API

• FolderController 내 전체 조회 API 추가

public class FolderController {

    private final FolderService folderService;

    ...

    @GetMapping("/folders")
    public List<FolderResponseDto> getFolders(@AuthenticationPrincipal UserDetailsImpl userDetails) {
        return folderService.getFolders(userDetails.getUser());
    }
}

 

관심 상품에 폴더 추가 API

• ProductController 내 API 추가

public class ProductController {

    private final ProductService productService;
	
    ...
    
    @PostMapping("products/{productId}/folder")
    public void addFolder(
            @PathVariable Long productId,
            @RequestParam Long folderId,
            @AuthenticationPrincipal UserDetailsImpl userDetails
    ) {
        productService.addFolder(productId, folderId, userDetails.getUser());
    }
}

• ProductService 내 비즈니스 로직 추가

public class ProductService {

    private final ProductRepository productRepository;
    private final FolderRepository folderRepository;
    private final ProductFolderRepository productFolderRepository;

    public void addFolder(Long productId, Long folderId, User user) {
        Product product = productRepository.findById(productId).orElseThrow(
                () -> new NullPointerException("해당 상품이 존재하지 않습니다."));

        Folder folder = folderRepository.findById(folderId).orElseThrow(
                () ->  new NullPointerException("해당 폴더가 존재하지 않습니다."));

        // 해당 상품 혹은 폴더 둘 중 하나라도 해당 유저가 등록한게 아닌 경우 예외 처리
        if(!product.getUser().getId().equals(user.getId())
        || !folder.getUser().getId().equals(user.getId())) {
            throw new IllegalArgumentException("회원님의 관심상품이 아니거나, 회원님의 폴더가 아닙니다.");
        }

        // 상품-폴더 중복 확인
        Optional<ProductFolder> overlapFolder =  productFolderRepository.findByProductAndFolder(product, folder);

        if(overlapFolder.isPresent()) {
            throw new IllegalArgumentException("중복된 폴더입니다.");
        }
        
        productFolderRepository.save(new ProductFolder(product, folder));
    }
}

관심 상품 폴더 추가 API 호출 결과

---

폴더 별 관심상품 조회 구현

• 회원은 폴더 별로 관심상품 조회 가능

폴더 별 관심상품 조회 API 설계

설명	URL	Request	Response
폴더별 상품 조회	GET /api/folders/{folderId}/products	{folderId}: 조회를 원하는 폴더 id	Page<ProductResponseDto>

폴더 별 관심상품 조회 API 구현

• ProductController 내 관심상품 조회 API 추가

public class ProductController {

    private final ProductService productService;

    @GetMapping("/folders/{folderId}/products")
    public Page<ProductResponseDto> getProductsInFolder(
            @PathVariable Long folderId,
            @RequestParam("page") int page,
            @RequestParam("size") int size,
            @RequestParam("sortBy") String sortBy,
            @RequestParam("isAsc") boolean isAsc,
            @AuthenticationPrincipal UserDetailsImpl userDetails
    ) {
        return productService.getProductsInFolder(
                folderId,
                page-1,
                size,
                sortBy,
                isAsc,
                userDetails.getUser()
        );
    }
}

• ProductService에 비즈니스 로직 추가

public class ProductService {

    private final ProductRepository productRepository;
    private final FolderRepository folderRepository;
    private final ProductFolderRepository productFolderRepository;

    public Page<ProductResponseDto> getProductsInFolder(Long folderId, int page, int size, String sortBy, boolean isAsc, User user) {
        Sort.Direction direction = isAsc ? Sort.Direction.ASC : Sort.Direction.DESC;
        Sort sort = Sort.by(direction, sortBy); // Sort 객체 = (direction 방향, 정렬 항목)
        Pageable pageable = PageRequest.of(page, size, sort);

        // 해당 폴더에 등록되어있는 상품 가져오기
        Page<Product> productList =  productRepository.findAllByUserAndProductFolderList_FolderId(user, folderId, pageable);

        Page<ProductResponseDto> responseDtoList = productList.map(ProductResponseDto::new);

        return responseDtoList;
    }
}

package com.sparta.myselectshop.repository;

import com.sparta.myselectshop.entity.Product;
import com.sparta.myselectshop.entity.User;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.jpa.repository.JpaRepository;

public interface ProductRepository extends JpaRepository<Product, Long> {
    Page<Product> findAllByUser(User user, Pageable pageable);

    Page<Product> findAllByUserAndProductFolderList_FolderId(User user, Long folderId, Pageable pageable);
    /*
    * select *
    * from product p
    * left join product_folder pf
    * on p.id = pf.product_id
    * where p.user_id = ?
    * and pf.folder_id = ?
    * order by p.id asc|desc
    * limit 0, 10; (페이지 번호, 한 페이지 당 보여줄 개수)
    * */
}

폴더 별 관심상품 조회 API 호출 결과