[문은서] Sprint11 #156

kosy00 · 2025-10-28T02:05:34Z

요구사항

기본

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

BinaryContentStorage.put을 직접 호출하는 대신 BinaryContentCreatedEvent를 발행하세요.
- BinaryContentCreatedEvent를 정의하세요.
  - BinaryContent 메타 정보가 DB에 잘 저장되었다는 사실을 의미하는 이벤트입니다.
- 다음의 메소드에서 BinaryContentStorage를 호출하는 대신 BinaryContentCreatedEvent를 발행하세요.
  - UserService.create/update
  - MessageService.create
  - BinaryContentService.create
- ApplicationEventPublisher를 활용하세요.
이벤트를 받아 실제 바이너리 데이터를 저장하는 리스너를 구현하세요.
- 이벤트를 발행한 메인 서비스의 트랜잭션이 커밋되었을 때 리스너가 실행되도록 설정하세요.
- BinaryContentStorage를 통해 바이너리 데이터를 저장하세요.
바이너리 데이터 저장 성공 여부를 알 수 있도록 메타 데이터를 리팩토링하세요.
BinaryContent에 바이너리 데이터 업로드 상태 속성(status)을 추가하세요.
BinaryContent의 상태를 업데이트하는 메소드를 정의하세요.

3o66puyre-image.png

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

Spring Event - 알림 기능 추가하기

1)채널에 새로운 메시지가 등록되거나 2)권한이 변경된 경우 이벤트를 발행해 알림을 받을 수 있도록 구현합니다.

채널에 새로운 메시지가 등록된 경우 알림을 받을 수 있도록 리팩토링하세요.
- MessageCreatedEvent를 정의하고 새로운 메시지가 등록되면 이벤트를 발행하세요.
- 사용자 별로 관심있는 채널의 알림만 받을 수 있도록 ReadStatus 엔티티에 채널 알림 여부 속성(notificationEnabled)을 추가하세요.
- PRIVATE 채널은 알림 여부를 true로 초기화합니다.
- PUBLIC 채널은 알림 여부를 false로 초기화합니다.
- 알림 여부를 수정할 수 있게 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 어노테이션을 활용하세요.
- 실패 정보를 관리자에게 통지하세요.

1ubhvrs9g-image.png

# 알림 내용 예시
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.* 를 통해 캐시 관련 데이터를 확인해보세요.

심화

Spring Kafka 도입하기

Kafka 환경을 구성하세요.
- Docker Compose를 활용해 Kafka를 구동하세요.

# docker-compose-kafka.yaml
# https://developer.confluent.io/confluent-tutorials/kafka-on-docker/#the-docker-compose-file
services:
  broker:
    image: apache/kafka:latest
    hostname: broker
    container_name: broker
    ports:
      - 9092:9092
    environment:
      KAFKA_BROKER_ID: 1
      KAFKA_LISTENER_SECURITY_PROTOCOL_MAP: PLAINTEXT:PLAINTEXT,PLAINTEXT_HOST:PLAINTEXT,CONTROLLER:PLAINTEXT
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://broker:29092,PLAINTEXT_HOST://localhost:9092
      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
      KAFKA_GROUP_INITIAL_REBALANCE_DELAY_MS: 0
      KAFKA_TRANSACTION_STATE_LOG_MIN_ISR: 1
      KAFKA_TRANSACTION_STATE_LOG_REPLICATION_FACTOR: 1
      KAFKA_PROCESS_ROLES: broker,controller
      KAFKA_NODE_ID: 1
      KAFKA_CONTROLLER_QUORUM_VOTERS: 1@broker:29093
      KAFKA_LISTENERS: PLAINTEXT://broker:29092,CONTROLLER://broker:29093,PLAINTEXT_HOST://0.0.0.0:9092
      KAFKA_INTER_BROKER_LISTENER_NAME: PLAINTEXT
      KAFKA_CONTROLLER_LISTENER_NAMES: CONTROLLER
      KAFKA_LOG_DIRS: /tmp/kraft-combined-logs
      CLUSTER_ID: MkU3OEVBNTcwNTJENDM2Qk

- Spring Kafka 의존성을 추가하고, application.yml에 Kafka 설정을 추가하세요.

implementation 'org.springframework.kafka:spring-kafka'

# application.yaml
spring:
    ...
  kafka:
    bootstrap-servers: localhost:9092
    producer:
      key-serializer: org.apache.kafka.common.serialization.StringSerializer
      value-serializer: org.apache.kafka.common.serialization.StringSerializer
    consumer:
      group-id: discodeit-group
      auto-offset-reset: earliest
      key-deserializer: org.apache.kafka.common.serialization.StringDeserializer
      value-deserializer: org.apache.kafka.common.serialization.StringDeserializer

Spring Event를 Kafka로 발행하는 리스너를 구현하세요.
- NotificationRequiredEventListener는 비활성화하세요.
- KafkaProduceRequiredEventListener를 구현하세요.

package com.sprint.mission.discodeit.event.kafka;

@Slf4j
@RequiredArgsConstructor
@Component
public class KafkaProduceRequiredEventListener {

    private final KafkaTemplate<String, String> kafkaTemplate;
    private final ObjectMapper objectMapper;
    
  @Async("eventTaskExecutor")
  @TransactionalEventListener
  public void on(MessageCreatedEvent event) {
    ...
    String payload = objectMapper.writeValueAsString(event);
    kafkaTemplate.send("discodeit.MessageCreatedEvent", payload);
    ...
  }

  @Async("eventTaskExecutor")
  @TransactionalEventListener
  public void on(RoleUpdatedEvent event) {...}

  @Async("eventTaskExecutor")
  @EventListener
  public void on(S3UploadFailedEvent event) {...}
}

Kafka Console을 통해 Kafka 이벤트가 잘 발행되는지 확인해보세요.
Kafka 토픽을 구독해 알림을 생성하는 리스너를 구현하세요.
- 이 리스너는 메인 서비스와 별도의 서버로 구성된 알림 서비스라고 가정합니다.
- NotificationRequiredTopicListener를 구현하세요.
- 기존 @eventlistener 기반 로직을 제거하고 @KafkaListener로 대체하세요.

Redis Cache 도입하기

Redis 환경을 구성하세요.
Docker Compose를 활용해 Redis를 구동하세요.

# docker-compose-redis.yml
# https://developer.confluent.io/confluent-tutorials/kafka-on-docker/#the-docker-compose-file
services:
  redis:
    image: redis:7.2-alpine
    container_name: redis
    ports:
      - "6379:6379"
    volumes:
      - redis-data:/data
    command: redis-server --appendonly yes

volumes:
  redis-data:

Redis 의존성을 추가하고, application.yml에 Redis 설정을 추가하세요.

implementation 'com.github.ben-manes.caffeine:caffeine'
implementation 'org.springframework.boot:spring-boot-starter-data-redis'

# application.yaml
spring:
  ...
  cache:
    type: caffeine
    type: redis
    cache-names:
      - channels
      - notifications
      - users
    caffeine:
      spec: >
        maximumSize=100,
        expireAfterAccess=600s,
        recordStats
    redis:
      enable-statistics: true
  data:
    redis:
      host: ${REDIS_HOST:localhost}
      port: ${REDIS_PORT:6379}

직렬화 설정을 위해 다음과 같이 Bean을 선언하세요.

// CacheConfig
@Bean
public RedisCacheConfiguration redisCacheConfiguration(ObjectMapper objectMapper) {
  ObjectMapper redisObjectMapper = objectMapper.copy();
  redisObjectMapper.activateDefaultTyping(
      LaissezFaireSubTypeValidator.instance,
      DefaultTyping.EVERYTHING,
      As.PROPERTY
  );

  return RedisCacheConfiguration.defaultCacheConfig()
      .serializeValuesWith(
          RedisSerializationContext.SerializationPair.fromSerializer(
              new GenericJackson2JsonRedisSerializer(redisObjectMapper)
          )
      )
      .prefixCacheNameWith("discodeit:")
      .entryTtl(Duration.ofSeconds(600))
      .disableCachingNullValues();
}

DataGrip을 통해 Redis에 저장된 캐시 정보를 조회해보세요.

주요 변경사항

스크린샷

- Kafka 토픽(discodeit.MessageCreatedEvent) 정상 발행 및 수신 확인 스크린샷입니다.

멘토에게

이전 과제 pr까지 Files changed에 이전 과제들이 중복으로 올라가던 이슈를 해결했습니다.

joonfluence · 2025-11-04T17:44:13Z

src/main/java/com/sprint/mission/discodeit/event/listener/BinaryContentEventListener.java

+    private final BinaryContentStorage binaryContentStorage;
+    private final BinaryContentService binaryContentService;
+
+    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)


이벤트 소비

joonfluence · 2025-11-04T17:44:26Z

src/main/java/com/sprint/mission/discodeit/event/listener/BinaryContentEventListener.java

+    public void handle(BinaryContentCreatedEvent event) {
+        try {
+            binaryContentStorage.put(event.binaryContentId(), event.bytes());
+            binaryContentService.updateStatus(event.binaryContentId(), BinaryContentStatus.SUCCESS);


상태 변경 처리

joonfluence · 2025-11-04T17:45:30Z

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

+        contentType
+    );
+    binaryContentRepository.save(binaryContent);
+    eventPublisher.publishEvent(new BinaryContentCreatedEvent(binaryContent.getId(), bytes));


이벤트 발행

joonfluence · 2025-11-04T17:46:08Z

...main/java/com/sprint/mission/discodeit/event/listener/KafkaProduceRequiredEventListener.java

+    @Async("eventTaskExecutor")
+    @TransactionalEventListener
+    public void on(MessageCreatedEvent event) {
+    try {
+        log.info("🔥 Kafka 이벤트 수신됨: {}", event);
+        String payload = objectMapper.writeValueAsString(event);
+        kafkaTemplate.send("discodeit.MessageCreatedEvent", payload);
+        log.info("✅ Kafka 메시지 전송 완료: {}", payload);
+    } catch (JsonProcessingException e) {
+        log.error("Kafka 메세지 변환 실패", e);
+    }
+}


비동기 처리

joonfluence · 2025-11-04T17:47:08Z

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

+    private final NotificationMapper notificationMapper;
+
+    @Override
+    @Cacheable(value = "notifications", key = "#userId")


캐시 설정

joonfluence · 2025-11-04T17:47:25Z

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

+    return channelMapper.toDto(channel);
+  }
+
+  @CacheEvict(value = {"channelById", "channelsByUserId"}, allEntries = true)


캐시 만료 설정

joonfluence · 2025-11-04T18:03:00Z

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

+    @Bean
+    public RedisCacheConfiguration redisCacheConfiguration(ObjectMapper objectMapper) {
+        ObjectMapper redisObjectMapper = objectMapper.copy();
+        redisObjectMapper.activateDefaultTyping(
+                LaissezFaireSubTypeValidator.instance,
+                DefaultTyping.EVERYTHING,
+                As.PROPERTY
+        );
+


레디스 설정

문은서 added 7 commits October 28, 2025 10:19

브랜치 생성 전 초기버전을 위한 커밋

38377cb

이전 과제 파일 완전 제거

e5ed295

빌드 및 IDE 파일 제거

48ec3d6

이전 과제 파일 완전 제거 재시도(제발)

1209655

불필요한 document 폴더 완전 삭제

79ecb2b

feat:Redis 캐시 설정 및 적용

313319e

feat: Kafka 리스너 기반 알림 생성기능 구현

54f33d0

joonfluence reviewed Nov 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[문은서] Sprint11 #156

[문은서] Sprint11 #156

kosy00 commented Oct 28, 2025 •

edited

Loading

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

joonfluence Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

[문은서] Sprint11 #156

Are you sure you want to change the base?

[문은서] Sprint11 #156

Conversation

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

Uh oh!

요구사항

기본

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

Spring Event - 알림 기능 추가하기

비동기 적용하기

비동기 실패 처리하기

캐시 적용하기

심화

Spring Kafka 도입하기

Redis Cache 도입하기

주요 변경사항

스크린샷

멘토에게

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

joonfluence Nov 4, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

kosy00 commented Oct 28, 2025 •

edited

Loading