[신은수] Sprint11 by Shinsu98 · Pull Request #161 · codeit-bootcamp-spring/4-sprint-mission

Shinsu98 · 2025-10-28T09:03:45Z

요구사항

기본

Spring Event - 파일 업로드 로직 분리하기

디스코드잇은 BinaryContent의 메타 데이터(DB)와 바이너리 데이터(FileSystem/S3)를 분리해 저장합니다.
만약 지금처럼 두 로직이 하나의 트랜잭션으로 묶인 경우 트랜잭션을 과도하게 오래 점유할 수 있는 문제가 있습니다.
- 바이너리 데이터 저장 연산은 오래 걸릴 수 있는 연산이며, 해당 연산이 끝날 때까지 트랜잭션이 대기해야합니다.
따라서 Spring Event를 활용해 메타 데이터 저장 트랜잭션으로부터 바이너리 데이터 저장 로직을 분리하여, 메타데이터 저장 트랜잭션이 종료되면 바이너리 데이터를 저장하도록 변경합니다.
BinaryContentStorage.put을 직접 호출하는 대신 BinaryContentCreatedEvent를 발행하세요.
- BinaryContentCreatedEvent를 정의하세요.
  - BinaryContent 메타 정보가 DB에 잘 저장되었다는 사실을 의미하는 이벤트입니다.
- 다음의 메소드에서 BinaryContentStorage를 호출하는 대신 BinaryContentCreatedEvent를 발행하세요.
  - UserService.create/update
  - MessageService.create
  - BinaryContentService.create
- ApplicationEventPublisher를 활용하세요.
이벤트를 받아 실제 바이너리 데이터를 저장하는 리스너를 구현하세요.
- 이벤트를 발행한 메인 서비스의 트랜잭션이 커밋되었을 때 리스너가 실행되도록 설정하세요.
- BinaryContentStorage를 통해 바이너리 데이터를 저장하세요.

바이너리 데이터 저장 성공 여부를 알 수 있도록 메타 데이터를 리팩토링하세요.

BinaryContent에 바이너리 데이터 업로드 상태 속성(status)을 추가하세요.

PROCESSING: 업로드 중
- 기본값입니다.
SUCCESS: 업로드 완료

FAIL: 업로드 실패

   ```
   -- schema.sql
   CREATE TABLE binary_contents
   (
       id           uuid PRIMARY KEY,
       created_at   timestamp with time zone NOT NULL,
       updated_at timestamp with time zone,
       file_name    varchar(255)             NOT NULL,
       size         bigint                   NOT NULL,
       content_type varchar(100)             NOT NULL,
       status       varchar(20)              NOT NULL
   );

   -- ALTER TABLE binary_contents
   --      ADD COLUMN updated_at timestamp with time zone;
   -- ALTER TABLE binary_contents
   --      ADD COLUMN status varchar(20) NOT NULL;
   ```

BinaryContent의 상태를 업데이트하는 메소드를 정의하세요.
- 트랜잭션 전파 범위에 유의하세요.

바이너리 데이터 저장 성공 여부를 메타 데이터에 반영하세요.
- 성공 시 BinaryContent의 status를 SUCCESS로 업데이트하세요.
- 실패 시 BinaryContent의 status를 FAIL로 업데이트하세요.

Spring Event - 알림 기능 추가하기

1)채널에 새로운 메시지가 등록되거나 2)권한이 변경된 경우 이벤트를 발행해 알림을 받을 수 있도록 구현합니다.
채널에 새로운 메시지가 등록된 경우 알림을 받을 수 있도록 리팩토링하세요.
- MessageCreatedEvent를 정의하고 새로운 메시지가 등록되면 이벤트를 발행하세요.
- 사용자 별로 관심있는 채널의 알림만 받을 수 있도록 ReadStatus 엔티티에 채널 알림 여부 속성(notificationEnabled)을 추가하세요.
  - PRIVATE 채널은 알림 여부를 true로 초기화합니다.
  - PUBLIC 채널은 알림 여부를 false로 초기화합니다.
```
-- schema.sql
CREATE TABLE read_statuses
(
    id           uuid PRIMARY KEY,
    created_at   timestamp with time zone NOT NULL,
    updated_at   timestamp with time zone,
    user_id      uuid                     NOT NULL,
    channel_id   uuid                     NOT NULL,
    last_read_at timestamp with time zone NOT NULL,
    notification_enabled boolean NOT NULL,
    UNIQUE (user_id, channel_id)
);

-- ALTER TABLE read_statuses
--      ADD COLUMN notification_enabled boolean NOT NULL;
```
- 알림 여부를 수정할 수 있게 ReadStatusUpdateRequest를 수정하세요.
  - 알림이 활성화 되어 있는 경우
  - 알림이 활성화 되어 있지 않은 경우
사용자의 권한(Role)이 변경된 경우 알림을 받을 수 있도록 리팩토링하세요.
- RoleUpdatedEvent를 정의하고 권한이 변경되면 이벤트를 발행하세요.
알림 API를 구현하세요.
- NotificationDto를 정의하세요.
  - receiverId: 알림을 수신할 User의 id입니다.
- 알림 조회
  - 엔드포인트: GET /api/notifications
  - 요청
    - 헤더: 엑세스 토큰
  - 응답
    - 200 List
    - 401 ErrorResponse
- 알림 확인
  - 엔드포인트: DELETE /api/notifications/{notificationId}
  - 요청
    - 헤더: 엑세스 토큰
  - 응답
    - 204 Void
    - 인증되지 않은 요청: 401 ErrorResponse
    - 인가되지 않은 요청: 403 ErrorResponse
      - 요청자 본인의 알림에 대해서만 수행할 수 있습니다.
    - 알림이 없는 경우: 404 ErrorResponse
알림이 필요한 이벤트가 발행되었을 때 알림을 생성하세요.
- 이벤트를 처리할 리스너를 구현하세요.
```
public class NotificationRequiredEventListener {

  @TransactionalEventListener
  public void on(MessageCreatedEvent event) {...}

  @TransactionalEventListener
  public void on(RoleUpdatedEvent event) {...}
}
```
  - on(MessageCreatedEvent)
    - 해당 채널의 알림 여부를 활성화한 ReadStatus를 조회합니다.
    - 해당 ReadStatus의 사용자들에게 알림을 생성합니다.
      # 알림 예시 title: "보낸 사람 (#채널명)" content: "메시지 내용"
    - 단, 해당 메시지를 보낸 사람은 알림 대상에서 제외합니다.
  - on(RoleUpdatedEvent)
    - 권한이 변경된 당사자에게 알림을 생성합니다.
      # 알림 예시 title: "권한이 변경되었습니다." content: "USER -> CHANNEL_MANAGER"

비동기 적용하기

비동기를 적용하기 위한 설정(AsyncConfig) 클래스를 구현하세요.
- @EanbleAsync 어노테이션을 활용하세요.
- TaskExecutor를 Bean으로 등록하세요.
- TaskDecorator를 활용해 MDC의 Request ID, SecurityContext의 인정 정보가 비동기 스레드에서도 유지되도록 구현하세요.
앞서 구현한 Event Listener를 비동기적으로 처리하세요.
- @async 어노테이션을 활용하세요.

동기 처리와 비동기 처리 간 성능 차이를 비교해보세요.

파일 업로드 로직에 의도적인 지연(Thread.sleep(…))을 발생시키세요.

// LocalBinaryContentStorage
public UUID put(UUID binaryContentId, byte[] bytes) {
    try {
      Thread.sleep(3000);
    } catch (InterruptedException e) {
      Thread.currentThread().interrupt();
      throw new RuntimeException("Thread interrupted while simulating delay", e);
    }
    ...
}

메시지 생성 API의 실행 시간을 측정해보세요.

@timed 어노테이션을 메소드에 추가합니다.

// MessageController
@Timed("message.create.async")
@PostMapping(consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public ResponseEntity<MessageDto> create(...) {...}

Actuator 설정을 추가합니다.

# application.yaml
management:
    ...
  observations:
    annotations:
      enabled: true

/actuator/metrics/message.create.async 에서 측정된 시간을 확인할 수 있습니다.

@EnableAsync를 활성화 / 비활성화 해보면서 동기 / 비동기 처리 간 응답 속도의 차이를 확인해보세요.

비동기 실패 처리하기

비동기로 처리하는 로직이 실패하는 경우 사용자에게 즉각적인 에러 전파가 되지 않을 가능성이 높습니다.
따라서 비동기로 처리하는 로직은 자동 재시도 전략을 통해 더 견고하게 구현해야 합니다.
또, 실패하더라도 그 사실을 명확하게 기록해두어야 에러에 대응할 수 있습니다.
S3를 활용해 바이너리 데이터 저장 시 자동 재시도 매커니즘을 구축하세요.
- Spring Retry를 위한 환경을 구성하세요.
  - org.springframework.retry:spring-retry 의존성을 추가하세요.
  - @EnableRetry 어노테이션을 활용해 Spring Retry를 활성화 하세요.
- 바이너리 데이터를 저장하는 메소드에 @retryable 어노테이션을 사용해 재시도 정책(횟수, 대기 시간 등)을 설정하세요.
재시도가 모두 실패했을 때 대응 전략을 구축하세요.
- @recover 어노테이션을 활용하세요.
- 실패 정보를 관리자에게 통지하세요.
  # 알림 내용 예시 RequestId: 7641467e369e458a98033558a83321fb BinaryContentId: b0549c2a-014c-4761-8b21-4b77d3bd011c Error: The AWS Access Key Id you provided does not exist in our records. (Service: S3, Status Code: 403, Request ID: B7KCVSRCGPYJZREX, Extended Request ID: AWRVuJJJ3upwwOkCnd+yhHkgSajUxdg7L4195lbMVTIka6WnBpjZLLRTReoHbgIMf9zzH/QQM0Y5ZOVJCHF2F+l2mSyPG/+8Ee2XBS8hcqk=) (SDK Attempt Count: 1)
  - 실패 정보에는 추후 디버깅을 위해 필요한 정보를 포함하세요.
    - 실패한 작업 이름
    - MDC의 Request ID
    - 실패 이유 (예외 메시지)

캐시 적용하기

Caffeine 캐시를 위한 환경을 구성하세요.
- org.springframework.boot:spring-boot-starter-cache 의존성을 추가하세요.
- com.github.ben-manes.caffeine:caffeine 의존성을 추가하세요.
- application.yaml 설정 또는 Bean을 통해 캐시 Caffeine 캐시를 설정하세요.
@Cacheable 어노테이션을 활용해 캐시가 필요한 메소드에 적용하세요.
- 사용자별 채널 목록 조회
- 사용자별 알림 목록 조회
- 사용자 목록 조회
데이터 변경 시, 캐시를 갱신 또는 무효화하는 로직을 구현하세요.
- @CacheEvict, @cACHEpUT, CacheManager 등을 활용하세요.
- 예시:
  - 새로운 채널 추가/수정/삭제 → 채널 목록 캐시 무효화
  - 알림 추가/삭제 → 알림 목록 캐시 무효화
  - 사용자 추가/로그인/로그아웃 → 사용자 목록 캐시 무효화
캐시 적용 전후의 차이를 비교해보세요.
- 로그를 통해 SQL 실행 여부를 확인해보세요.
Spring Actuator를 활용해 캐시 관련 통계 지표를 확인해보세요.
- Caffein Spec에 recordStats 옵션을 추가하세요.
```
# application.yaml
cache:
   ...
caffeine:
 spec: >
   maximumSize=100,
   expireAfterAccess=600s,
   recordStats
```
- /actuator/caches, /actuator/metrics/cache.* 를 통해 캐시 관련 데이터를 확인해보세요.

심화

심화 항목 1
심화 항목 2

주요 변경사항

스크린샷

멘토에게

셀프 코드 리뷰를 통해 질문 이어가겠습니다.

[강은혁]Sprint1

spring-kang · 2025-11-05T08:27:59Z

src/main/java/com/sprint/mission/discodeit/event/BinaryContentCreatedEventListener.java

+
+    private final BinaryContentAsyncWorker binaryContentAsyncWorker;
+
+    @EventListener


TransactionalEventListener 를 안쓰고 EventListener를 활용한 의도가 있으신가요?

spring-kang · 2025-11-05T08:29:27Z

src/main/java/com/sprint/mission/discodeit/service/basic/BasicMessageService.java

+          BinaryContent binaryContent = new BinaryContent(fileName, (long) bytes.length,
+              contentType);
+          binaryContentRepository.save(binaryContent);
+          eventPublisher.publishEvent(new BinaryContentCreatedEvent(binaryContent.getId(), bytes, fileName, contentType));


여긴 메시지 관련 이벤트에 대한 발행 로직이 들어가야할 것 같습니다.

spring-kang · 2025-11-05T08:30:04Z

src/main/java/com/sprint/mission/discodeit/config/AsyncConfig.java

+    @Bean(name = {"taskExecutor", "applicationTaskExecutor"})
+    public Executor taskExecutor(TaskDecorator mdcSecurityContextTaskDecorator) {
+        ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
+        // 운영 환경에 맞게 조정하세요.
+        executor.setCorePoolSize(4);
+        executor.setMaxPoolSize(16);
+        executor.setQueueCapacity(1000);
+        executor.setThreadNamePrefix("async-");
+        executor.setTaskDecorator(mdcSecurityContextTaskDecorator);
+        executor.initialize();
+        return executor;
+    }
+}


이게 더 먼저 선언되면 가독성이 올라갈것 같습니다.

spring-kang · 2025-11-05T08:30:40Z

src/main/java/com/sprint/mission/discodeit/event/BinaryContentAsyncWorker.java

+    private final BinaryContentStorage binaryContentStorage;
+    private final BinaryContentService binaryContentService;
+
+    @Async


빈으로 설정해둔 executor를 명시해주세요.

spring-kang · 2025-11-05T08:31:20Z

src/main/java/com/sprint/mission/discodeit/config/RetryConfig.java

+
+@Configuration
+@EnableRetry
+public class RetryConfig {


AppConfig를 추가하고 여기에 공통된 기능들을 모으는게 더 자연스러울것 같습니다.

spring-kang · 2025-11-05T08:32:06Z

src/main/java/com/sprint/mission/discodeit/storage/s3/S3BinaryContentStorage.java

+    }
+
+    log.error("S3 업로드 최종 실패(재시도 모두 소진): key={}, reason={}", key, errorMessage, e);
+    throw new RuntimeException("S3에 파일 업로드 실패(최종): " + key, e);


cusotom exception으로 처리하시는것도 좋을것 같습니다.

Eunhye0k and others added 5 commits June 5, 2025 11:09

Sprint 1 과제 제출

f44f601

Merge branch 'codeit-bootcamp-spring:main' into sprint1

244826b

Merge pull request codeit-bootcamp-spring#14 from Eunhye0k/sprint1

b9e3968

[강은혁]Sprint1

sprint11 commit.

ec6f76a

sprint11 changed commit.

8647bb9

spring-kang reviewed Nov 5, 2025

View reviewed changes

spring-kang approved these changes Nov 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

[신은수] Sprint11#161

[신은수] Sprint11#161
Shinsu98 wants to merge 5 commits intocodeit-bootcamp-spring:신은수from
Shinsu98:sprint11

Shinsu98 commented Oct 28, 2025 •

edited

Loading

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

spring-kang Nov 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants


		private final BinaryContentAsyncWorker binaryContentAsyncWorker;

		@EventListener

Comments

Conversation

Shinsu98 commented Oct 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

요구사항

기본

Spring Event - 파일 업로드 로직 분리하기

Spring Event - 알림 기능 추가하기

비동기 적용하기

비동기 실패 처리하기

캐시 적용하기

심화

주요 변경사항

스크린샷

멘토에게

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Shinsu98 commented Oct 28, 2025 •

edited

Loading