Feat: 주점 프로필 사진 업로드 기능 추가#113
Conversation
|
Caution Review failedThe pull request is closed. ## Walkthrough
이 변경사항은 매장 이미지 관리 기능을 확장하여, 프로필 이미지와 배너 이미지를 분리하여 관리할 수 있도록 API, DTO, 엔티티, 서비스, 리포지토리를 수정합니다. 새로운 프로필 이미지 업로드 엔드포인트가 추가되고, 관련 데이터 구조와 저장 로직이 이미지 타입별로 구분되어 동작하도록 변경되었습니다.
## Changes
| 파일/경로 요약 | 변경 내용 요약 |
|---|---|
| .../store/controller/StoreImageController.java | 복수 이미지 업로드 엔드포인트를 `/store-images/{storeId}`에서 `/banner-images/{storeId}`로 변경. 단일 프로필 이미지 업로드용 `/profile-images/{storeId}` POST 엔드포인트 추가 및 Swagger 문서화. |
| .../store/service/StoreImageService.java | `saveAll`에서 이미지 타입을 BANNER로 지정. 단일 프로필 이미지 업로드용 `saveProfileImage` 메서드 추가 및 기존 프로필 이미지 삭제 로직 포함. |
| .../store/dto/StoreImageUploadResponse.java<br>.../store/dto/StoreReadDto.java<br>.../applicationuser/store/dto/StoreImageUploadResponse.java<br>.../applicationuser/store/dto/StoreReadDto.java | DTO에 `imageType` 필드 추가. 기존 이미지 리스트 필드를 프로필 이미지와 배너 이미지로 분리. 정적 팩토리 메서드에서 이미지 타입별 분기 처리 추가. |
| .../domaincorerdb/store/entity/ImageType.java | `PROFILE`, `BANNER` 값을 가지는 새 enum `ImageType` 추가. 각 타입에 대한 설명 및 OpenAPI 문서화 어노테이션 적용. |
| .../domaincorerdb/store/entity/StoreImage.java | `imageType` 필드(enum, not null) 추가 및 DB에 문자열로 저장되도록 어노테이션 적용. |
| .../domaincorerdb/store/repository/StoreImageRepository.java | 매장 ID와 이미지 타입으로 단일 이미지를 조회하는 `findByStoreStoreIdAndImageType` 메서드 추가. |
| .../applicationuser/store/controller/StoreController.java | 코드 포맷팅 개선(로직 변화 없음). |
## Sequence Diagram(s)
```mermaid
sequenceDiagram
participant Client
participant StoreImageController
participant StoreImageService
participant StoreRepository
participant StoreImageRepository
participant S3
Client->>StoreImageController: POST /profile-images/{storeId} (file)
StoreImageController->>StoreImageService: saveProfileImage(storeId, file)
StoreImageService->>StoreRepository: findById(storeId)
StoreImageService->>StoreImageRepository: findByStoreStoreIdAndImageType(storeId, PROFILE)
alt 기존 프로필 이미지 존재
StoreImageService->>S3: delete(existingProfileImage)
StoreImageService->>StoreImageRepository: delete(existingProfileImage)
end
StoreImageService->>S3: upload(file)
StoreImageService->>StoreImageRepository: save(new StoreImage with imageType=PROFILE)
StoreImageService-->>StoreImageController: StoreImageUploadResponse
StoreImageController-->>Client: 201 Created + 응답sequenceDiagram
participant Client
participant StoreImageController
participant StoreImageService
participant StoreRepository
participant StoreImageRepository
participant S3
Client->>StoreImageController: POST /banner-images/{storeId} (files)
StoreImageController->>StoreImageService: saveAll(storeId, files)
StoreImageService->>StoreRepository: findById(storeId)
loop 각 파일
StoreImageService->>S3: upload(file)
StoreImageService->>StoreImageRepository: save(new StoreImage with imageType=BANNER)
end
StoreImageService-->>StoreImageController: List<StoreImageUploadResponse>
StoreImageController-->>Client: 201 Created + 응답
sequenceDiagram
participant Client
participant StoreController
participant StoreService
Client->>StoreController: GET /stores
StoreController->>StoreService: getAllStores(pageable)
StoreService->>...: (매장, 이미지 목록 조회)
StoreService-->>StoreController: StoreReadDto(profileImage, bannerImages)
StoreController-->>Client: 200 OK + 응답
Possibly related PRs
Suggested reviewers
|
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (3)
nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/dto/StoreImageUploadResponse.java (1)
16-22: 코드 중복 개선을 검토해보세요.admin API와 user API의 StoreImageUploadResponse 클래스가 동일합니다. 공통 모듈로 추출하여 중복을 제거하는 것을 고려해보세요.
공통 DTO를 domain 또는 별도의 shared 모듈로 이동하여 중복을 제거할 수 있습니다:
// domain-core 또는 shared 모듈에 공통 DTO 생성 package com.nowait.shared.dto; public class StoreImageUploadResponse { // 현재 구현과 동일 }nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/repository/StoreImageRepository.java (1)
18-18: 새로운 리포지토리 메소드 구현 검토메소드 시그니처와 Spring Data JPA 네이밍 규칙이 올바릅니다. Optional 사용으로 null 안전성도 확보되었습니다.
더 간결한 메소드명 고려:
- Optional<StoreImage> findByStoreStoreIdAndImageType(Long storeId, ImageType imageType); + Optional<StoreImage> findByStore_StoreIdAndImageType(Long storeId, ImageType imageType);nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/dto/StoreReadDto.java (1)
28-37: 이미지 타입별 필터링 로직사용자 API와 동일한 필터링 로직이 올바르게 구현되었습니다.
코드 중복을 줄이기 위해 공통 유틸리티 클래스 생성을 고려해보세요:
public class ImageFilterUtils { public static StoreImageUploadResponse extractProfileImage(List<StoreImageUploadResponse> images) { return images.stream() .filter(image -> image.getImageType() == ImageType.PROFILE) .findFirst() .orElse(null); } public static List<StoreImageUploadResponse> extractBannerImages(List<StoreImageUploadResponse> images) { return images.stream() .filter(image -> image.getImageType() == ImageType.BANNER) .toList(); } }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/controller/StoreImageController.java(2 hunks)nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/dto/StoreImageUploadResponse.java(2 hunks)nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/dto/StoreReadDto.java(3 hunks)nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/service/StoreImageService.java(5 hunks)nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/controller/StoreController.java(1 hunks)nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/dto/StoreImageUploadResponse.java(2 hunks)nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/dto/StoreReadDto.java(3 hunks)nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/entity/ImageType.java(1 hunks)nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/entity/StoreImage.java(2 hunks)nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/repository/StoreImageRepository.java(1 hunks)
🔇 Additional comments (21)
nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/entity/ImageType.java (1)
1-18: 잘 구현된 ImageType enum입니다.이미지 타입을 구분하는 enum이 명확하게 정의되어 있고, 적절한 한국어 설명과 OpenAPI 어노테이션이 추가되어 있습니다.
nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/controller/StoreController.java (1)
52-56: 코드 포맷팅 개선이 적절합니다.메서드 체이닝을 멀티라인으로 포맷팅하여 가독성이 향상되었습니다.
nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/dto/StoreImageUploadResponse.java (2)
3-3: Import 추가가 적절합니다.ImageType enum을 정확히 import하여 타입 안전성을 보장합니다.
14-14: imageType 필드 추가가 적절합니다.이미지 타입을 구분할 수 있는 필드가 추가되어 프로필과 배너 이미지를 구별할 수 있습니다.
nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/entity/StoreImage.java (1)
7-8: JPA enum 처리를 위한 적절한 import입니다.enum 타입을 데이터베이스에 저장하기 위한 필수 어노테이션들이 정확히 import되었습니다.
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/dto/StoreImageUploadResponse.java (2)
3-3: Import 추가가 적절합니다.ImageType enum을 정확히 import하여 타입 안전성을 보장합니다.
14-14: imageType 필드 추가가 적절합니다.이미지 타입을 구분할 수 있는 필드가 추가되어 프로필과 배너 이미지를 구별할 수 있습니다.
nowait-domain/domain-core-rdb/src/main/java/com/nowait/domaincorerdb/store/repository/StoreImageRepository.java (2)
4-4: 임포트 추가 확인Optional 임포트가 올바르게 추가되었습니다.
9-9: ImageType 임포트 확인ImageType 엔티티 임포트가 올바르게 추가되었습니다.
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/service/StoreImageService.java (4)
5-5: 임포트 추가 확인Optional 임포트가 올바르게 추가되었습니다.
14-14: ImageType 임포트 확인ImageType 엔티티 임포트가 올바르게 추가되었습니다.
36-37: 예외 처리 개선예외 처리 형식이 일관되게 개선되었습니다.
66-66: 배너 이미지 타입 설정기존 이미지들을 BANNER 타입으로 명시적으로 설정한 것이 좋습니다.
nowait-app-user-api/src/main/java/com/nowait/applicationuser/store/dto/StoreReadDto.java (4)
6-6: ImageType 임포트 확인ImageType 엔티티 임포트가 올바르게 추가되었습니다.
22-23: 이미지 필드 분리단일 이미지 리스트에서 profileImage와 bannerImages로 분리한 것이 도메인 로직을 잘 반영합니다.
28-37: 이미지 타입별 필터링 로직스트림을 사용한 필터링 로직이 올바르게 구현되었습니다. PROFILE 타입의 첫 번째 이미지를 추출하고 BANNER 타입의 모든 이미지를 수집하는 로직이 적절합니다.
48-49: 빌더 패턴 필드 설정새로운 필드들이 빌더 패턴에 올바르게 설정되었습니다.
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/dto/StoreReadDto.java (3)
6-6: ImageType 임포트 확인ImageType 엔티티 임포트가 올바르게 추가되었습니다.
22-23: 이미지 필드 분리profileImage와 bannerImages로 필드를 분리한 것이 도메인 로직을 잘 반영합니다.
48-49: 빌더 패턴 필드 설정새로운 필드들이 빌더 패턴에 올바르게 설정되었습니다.
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/controller/StoreImageController.java (1)
32-32: 엔드포인트 경로 변경기존
/store-images에서/banner-images로 변경하여 이미지 타입을 명확히 구분한 것이 좋습니다.
| @Transactional | ||
| public StoreImageUploadResponse saveProfileImage(Long storeId, MultipartFile file) { | ||
|
|
||
| String type = "store"; | ||
| Store store = storeRepository.findById(storeId) | ||
| .orElseThrow(StoreNotFoundException::new); | ||
|
|
||
| Optional<StoreImage> existingProfileImage = storeImageRepository.findByStoreStoreIdAndImageType(store.getStoreId(), | ||
| ImageType.PROFILE); | ||
|
|
||
| existingProfileImage.ifPresent(profile -> { | ||
| s3Service.delete(profile.getFileKey()); | ||
| storeImageRepository.delete(profile); | ||
| }); | ||
|
|
||
| S3Service.S3UploadResult uploadResult = s3Service.upload(type, storeId, file).join(); | ||
|
|
||
| // StoreImage 엔티티 생성 및 저장 | ||
| StoreImage storeImage = StoreImage.builder() | ||
| .store(store) | ||
| .imageUrl(uploadResult.url()) | ||
| .fileKey(uploadResult.key()) | ||
| .imageType(ImageType.PROFILE) | ||
| .build(); | ||
|
|
||
| storeImageRepository.save(storeImage); | ||
|
|
||
| return StoreImageUploadResponse.fromEntity(storeImage); | ||
| } |
There was a problem hiding this comment.
🛠️ Refactor suggestion
프로필 이미지 업로드 메소드 구현 검토
프로필 이미지 교체 로직이 올바르게 구현되었습니다. 기존 이미지 삭제 후 새 이미지 업로드하는 플로우가 적절합니다.
동시성 문제를 해결하기 위한 개선사항을 제안합니다:
@Transactional
public StoreImageUploadResponse saveProfileImage(Long storeId, MultipartFile file) {
String type = "store";
Store store = storeRepository.findById(storeId)
.orElseThrow(StoreNotFoundException::new);
+ // 동시성 문제 해결을 위한 락 사용 고려
Optional<StoreImage> existingProfileImage = storeImageRepository.findByStoreStoreIdAndImageType(store.getStoreId(),
ImageType.PROFILE);
existingProfileImage.ifPresent(profile -> {
s3Service.delete(profile.getFileKey());
storeImageRepository.delete(profile);
});
- S3Service.S3UploadResult uploadResult = s3Service.upload(type, storeId, file).join();
+ // 트랜잭션 외부에서 S3 업로드 수행하거나 비동기 처리 개선 고려
+ S3Service.S3UploadResult uploadResult = s3Service.upload(type, storeId, file).join();추가적으로 비동기 업로드 처리를 개선하여 성능을 향상시킬 수 있습니다.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| @Transactional | |
| public StoreImageUploadResponse saveProfileImage(Long storeId, MultipartFile file) { | |
| String type = "store"; | |
| Store store = storeRepository.findById(storeId) | |
| .orElseThrow(StoreNotFoundException::new); | |
| Optional<StoreImage> existingProfileImage = storeImageRepository.findByStoreStoreIdAndImageType(store.getStoreId(), | |
| ImageType.PROFILE); | |
| existingProfileImage.ifPresent(profile -> { | |
| s3Service.delete(profile.getFileKey()); | |
| storeImageRepository.delete(profile); | |
| }); | |
| S3Service.S3UploadResult uploadResult = s3Service.upload(type, storeId, file).join(); | |
| // StoreImage 엔티티 생성 및 저장 | |
| StoreImage storeImage = StoreImage.builder() | |
| .store(store) | |
| .imageUrl(uploadResult.url()) | |
| .fileKey(uploadResult.key()) | |
| .imageType(ImageType.PROFILE) | |
| .build(); | |
| storeImageRepository.save(storeImage); | |
| return StoreImageUploadResponse.fromEntity(storeImage); | |
| } | |
| @Transactional | |
| public StoreImageUploadResponse saveProfileImage(Long storeId, MultipartFile file) { | |
| String type = "store"; | |
| Store store = storeRepository.findById(storeId) | |
| .orElseThrow(StoreNotFoundException::new); | |
| // 동시성 문제 해결을 위한 락 사용 고려 | |
| Optional<StoreImage> existingProfileImage = storeImageRepository.findByStoreStoreIdAndImageType(store.getStoreId(), | |
| ImageType.PROFILE); | |
| existingProfileImage.ifPresent(profile -> { | |
| s3Service.delete(profile.getFileKey()); | |
| storeImageRepository.delete(profile); | |
| }); | |
| // 트랜잭션 외부에서 S3 업로드 수행하거나 비동기 처리 개선 고려 | |
| S3Service.S3UploadResult uploadResult = s3Service.upload(type, storeId, file).join(); | |
| // StoreImage 엔티티 생성 및 저장 | |
| StoreImage storeImage = StoreImage.builder() | |
| .store(store) | |
| .imageUrl(uploadResult.url()) | |
| .fileKey(uploadResult.key()) | |
| .imageType(ImageType.PROFILE) | |
| .build(); | |
| storeImageRepository.save(storeImage); | |
| return StoreImageUploadResponse.fromEntity(storeImage); | |
| } |
🤖 Prompt for AI Agents
In
nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/service/StoreImageService.java
between lines 76 and 104, the current saveProfileImage method deletes the
existing profile image and uploads a new one sequentially, which may cause
concurrency issues if multiple requests happen simultaneously. To fix this, wrap
the deletion and saving of the new StoreImage entity in a synchronized block or
use database-level locking to prevent race conditions. Additionally, improve the
asynchronous upload by handling exceptions from the join() call and consider
using CompletableFuture chaining to better manage the upload process without
blocking.
There was a problem hiding this comment.
이건 나중에 개선할게 이슈로 등록해줘
There was a problem hiding this comment.
🧩 Analysis chain
@Jjiggu 동시성 문제 개선을 위한 이슈를 생성하겠습니다.
이슈가 생성되었습니다. 나중에 동시성 문제 개선 작업을 진행하실 수 있습니다!
🏁 Script executed:
#!/bin/bash
# Create GitHub issue for concurrency improvements in saveProfileImage method
gh issue create \
--title "StoreImageService.saveProfileImage 메소드 동시성 문제 개선" \
--body "## 문제 상황
프로필 이미지 업로드 메소드에서 동시성 문제가 발생할 수 있습니다.
## 개선 필요 사항
1. **동시성 문제 해결**: 여러 요청이 동시에 발생할 때 기존 이미지 삭제와 새 이미지 저장 간의 경쟁 조건 방지
2. **데이터베이스 레벨 락킹**: synchronized 블록 또는 데이터베이스 락 사용
3. **비동기 업로드 개선**: join() 호출 시 예외 처리 및 CompletableFuture 체이닝으로 블로킹 없는 처리
4. **트랜잭션 범위 최적화**: S3 업로드를 트랜잭션 외부에서 수행하거나 비동기 처리 개선
## 관련 코드
\`nowait-app-admin-api/src/main/java/com/nowait/applicationadmin/store/service/StoreImageService.java\`의 \`saveProfileImage\` 메소드
## 백링크
- PR: https://github.com/GTable/NoWait_BE_MultiModule/pull/113
- 코멘트: https://github.com/GTable/NoWait_BE_MultiModule/pull/113#discussion_r2210800060
- 요청자: @Jjiggu" \
--assignee "Jjiggu"
Length of output: 777
@Jjiggu 이슈가 성공적으로 생성되었습니다!
이슈 URL: #114
동시성 문제 개선 작업을 나중에 진행하실 때 참고하시면 됩니다. 이슈에 상세한 개선 사항과 관련 코드 위치가 포함되어 있습니다.
🧬 Code Graph Analysis Results
Relevant snippet from nowait-app-user-api/src/main/java/com/nowait/applicationuser/security/jwt/JwtAuthorizationFilter.java (lines 24-99)
@RequiredArgsConstructor
@Slf4j
public class JwtAuthorizationFilter extends OncePerRequestFilter {
private final JwtUtil jwtUtil;
@Override
protected void doFilterInternal(HttpServletRequest request, HttpServletResponse response, FilterChain filterChain)
throws ServletException, IOException {
String header = request.getHeader("Authorization");
// 인증헤더 Bearer가 없다면, 다음 필터로 넘김
if (header == null || !header.startsWith("Bearer ")) {
filterChain.doFilter(request, response);
log.debug("JwtAuthorizationFilter: Authorization 헤더가 없거나 Bearer 토큰 형식이 아님. JWT 인증 필터를 건너뜁니다. [header={}] ", header);
return;
}
log.info("header :: {}, header.substring(7) :: {}", header, header.substring(7));
String accessToken = header.substring(7);
// 토큰 만료 여부 확인, 만료 시 다음 필터로 넘기지 않음
try {
jwtUtil.isExpired(accessToken);
} catch (ExpiredJwtException e) {
// response status code + msg
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
response.getWriter().print("access token expired");
log.warn("JwtAuthorizationFilter: 만료된 AccessToken 입니다. 토큰 인증 거부, URI: {}", request.getRequestURI());
return;
}
// 토큰이 accessToken 종류인지 확인
String tokenCategory = jwtUtil.getTokenCategory(accessToken);
if (!tokenCategory.equals("accessToken")) {
//response status code
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
response.getWriter().print("invalid access token");
log.warn("JwtAuthorizationFilter: 잘못된 토큰 유형(accessToken 아님)으로 인증 요청. URI: {}, tokenCategory: {}", request.getRequestURI(), tokenCategory);
return;
}
// userId와 role 값 추출
Long userId = jwtUtil.getUserId(accessToken);
String roleString = jwtUtil.getRole(accessToken);
if (userId == null || roleString == null) {
log.warn("JwtAuthorizationFilter: JWT에서 userId 또는 role 추출 실패. 토큰: {}", accessToken);
response.setStatus(HttpServletResponse.SC_UNAUTHORIZED);
response.getWriter().print("invalid token");
return;
}
User user = User.createUserWithId(userId, "sampleEmail", "sampleNickname", "sampleProfileImg"
, SocialType.KAKAO, Role.fromString(roleString),5000L);
CustomOAuth2User customOAuth2User = new CustomOAuth2User(user);
// 스프링 시큐리티 인증 토큰 생성
UsernamePasswordAuthenticationToken usernamePasswordAuthenticationToken = new UsernamePasswordAuthenticationToken(
customOAuth2User, null, customOAuth2User.getAuthorities());
// 생성한 인증 정보를 SecurityContext에 설정
SecurityContextHolder.getContext().setAuthentication(usernamePasswordAuthenticationToken);
log.info("JwtAuthorizationFilter: 인증 성공. userId={}, role={}, URI={}", userId, roleString, request.getRequestURI());
filterChain.doFilter(request, response);
}
}Summary:
- This class is a Spring Security filter that intercepts HTTP requests to perform JWT token validation.
- It checks for the presence of an "Authorization" header with a Bearer token.
- Validates token expiration and token type (must be "accessToken").
- Extracts userId and role from the token.
- Creates a Spring Security Authentication object and sets it in the SecurityContext.
- Handles error cases by setting HTTP 401 Unauthorized status and appropriate messages.
- Logs relevant information for debugging and auditing.
This snippet is relevant because the StoreImageService likely requires authenticated access, and this filter is part of the authentication mechanism ensuring that only authorized users can perform operations such as uploading or deleting store images. Understanding this filter helps contextualize security concerns related to the service.
작업 요약
Issue Link
#112
문제점 및 어려움
해결 방안
Reference
Summary by CodeRabbit
신규 기능
기능 개선
/store-images/{storeId}에서/banner-images/{storeId}로 변경되었습니다.기타