[신은수] Sprint12 #170

Shinsu98 · 2025-11-07T10:59:06Z

요구사항

기본

웹소켓 구현하기

1. 웹소켓 환경 구성
- spring-boot-starter-websocket 의존성을 추가하세요.
```
implementation 'org.springframework.boot:spring-boot-starter-websocket'
```
- 웹소켓 메시지 브로커 설정
  @Configuration @EnableWebSocketMessageBroker public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {...}
  - 메모리 기반 SimpleBroker를 사용하세요.
    @Override public void configureMessageBroker(MessageBrokerRegistry config) {...}
    - SimpleBroker의 Destination Prefix는 /sub 으로 설정하세요.
      - 클라이언트에서 메시지를 구독할 때 사용합니다.
    - Application Destination Prefix는 /pub 으로 설정하세요.
      - 클라이언트에서 메시지를 발행할 때 사용합니다.
        @Override public void registerStompEndpoints(StompEndpointRegistry registry) {...}
    - STOMP 엔드포인트는 /ws로 설정하고, SockJS 연결을 지원해야 합니다.
메시지 송신
- 첨부파일이 없는 단순 텍스트 메시지인 경우 STOMP를 통해 메시지를 전송할 수 있도록 컨트롤러를 구현하세요.
  @Controller public class MessageWebSocketController { ... @MessageMapping(...) }
  - 클라이언트는 웹소켓으로 /pub/messages 엔드포인트에 메시지를 전송할 수 있어야 합니다.
    - @MessageMapping을 활용하세요.
  - 메시지 전송 요청의 페이로드 타입은 MessageCreateRequest 를 그대로 활용합니다.
- 첨부파일이 포함된 메시지는 기존의 API (POST /api/messages)를 그대로 활용합니다.
메시지 수신
- 클라이언트는 채널 입장 시 웹소켓으로 /sub/channels.{channelId}.messages 를 구독해 메시지를 수신합니다.
- 이를 고려해 메시지가 생성되면 해당 엔드포인트로 메시지를 보내는 컴포넌트를 구현하세요.
```
@Component
public class WebSocketRequiredEventListener {
    ...
    private final SimpMessagingTemplate messagingTemplate;
    
  @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
  public void handleMessage(MessageCreatedEvent event) {...}
}
```
  - MessageCreatedEvent를 통해 새로운 메시지 생성 이벤트를 확인하세요.
  - SimpMessagingTemplate를 통해 적절한 엔드포인트로 메시지를 전송하세요.

2. SSE 구현하기

SSE 환경을 구성하세요.
- 클라이언트에서 SSE 연결을 위한 엔드포인트를 구현하세요.
  - GET /api/sse
- 사용자별 SseEmitter 객체를 생성하고 메시지를 전송하는 컴포넌트를 구현하세요.
```
@Service
public class SseService {

  public SseEmitter connect(UUID receiverId, UUID lastEventId) {...}

  public void send(Collection<UUID> receiverIds, String eventName, Object data) {...}

  public void broadcast(String eventName, Object data) {...}

  @Scheduled(fixedDelay = 1000 * 60 * 30)
  public void cleanUp() {...}

  private boolean ping(SseEmitter sseEmitter) {...}
}
```
  - connect: SseEmitter 객체를 생성합니다.
  - send, broadcast: SseEmitter 객체를 통해 이벤트를 전송합니다.
  - cleanUp: 주기적으로 ping을 보내서 만료된 SseEmitter 객체를 삭제합니다.
  - ping: 최초 연결 또는 만료 여부를 확인하기 위한 용도로 더미 이벤트를 보냅니다.
- SseEmitter 객체를 메모리에서 저장하는 컴포넌트를 구현하세요.
```
@Repository
public class SseEmitterRepository {
  private final ConcurrentMap<UUID, List<SseEmitter>> data = new ConcurrentHashMap<>();
    ...
}
```
  - ConcurrentMap: 스레드 세이프한 자료구조를 사용합니다.
  - List: 사용자 당 N개의 연결을 허용할 수 있도록 합니다. (예: 다중 탭)
- 이벤트 유실 복원을 위해 SSE 메시지를 저장하는 컴포넌트를 구현하세요.
```
@Repository
public class SseMessageRepository {
  private final ConcurrentLinkedDeque<UUID> eventIdQueue = new ConcurrentLinkedDeque<>();
  private final Map<UUID, SseMessage> messages = new ConcurrentHashMap<>();
  ...
}
```
  - 각 메시지 별로 고유한 ID를 부여합니다.
  - 클라이언트에서 LastEventId를 전송해 이벤트 유실 복원이 가능하도록 해야 합니다.
기존에 클라이언트에서 폴링 방식으로 주기적으로 요청하던 데이터를 SSE를 이용해 서버에서 실시간으로 전달하는 방식으로 리팩토링하세요.
- 새로운 알림 이벤트 전송
  - 새 알림이 생성되었을 때 클라이언트에 이벤트를 전송하세요.
  - 클라이언트는 이 이벤트를 수신하면 알림 목록에 알림을 추가합니다.
  - 이벤트 명세

id	이벤트 고유 ID
name	binaryContents.updated
data	BinaryContentDto

파일 업로드 상태 변경 이벤트 전송
- 파일 업로드 상태가 변경될 때 이벤트를 발송하세요.
- 클라이언트는 해당 상태를 수신하면 파일 상태 UI를 다시 렌더링합니다.
- 이벤트 명세

id	이벤트 고유 ID
name	binaryContents.updated
data	BinaryContentDto

채널 갱신 이벤트 전송
- 채널 정보가 변경될 때, 이벤트를 발송하세요.
- 클라이언트는 해당 이벤트를 수신하면 채널 UI를 다시 렌더링합니다.
- 이벤트 명세

id	이벤트 고유 ID
name	channels.created or updated or deleted
data	ChannelDto

사용자 갱신 이벤트 전송
- 사용자 정보 또는 로그인 상태가 변경될 때, 이벤트를 발송하세요.
- 클라이언트는 해당 이벤트를 수신하면 사용자 UI를 다시 렌더링합니다.
- 이벤트 명세

id	이벤트 고유 ID
name	users.created or updated or deleted
data	UserDto

3. 배포 아키텍처 구성하기

다음의 다이어그램에 부합하는 배포 아키텍처를 Docker Compose를 통해 구현하세요.
- Reverse Proxy
  - Nginx 기반의 리버스 프록시 컨테이너를 구성하세요.
  - 역할 및 설정은 다음과 같습니다:
    - /api/, /ws/ 요청은 Backend 컨테이너로 프록시 처리합니다.
    - 이 외의 모든 요청은 정적 리소스(프론트엔드 빌드 결과)를 서빙합니다.
      - 프론트엔드 정적 리소스는 Nginx 컨테이너 내부의 적절한 경로(/usr/share/nginx/html 등)에 복사하세요.
  - 외부에서 접근 가능한 유일한 컨테이너이며, 3000번 포트를 통해 접근할 수 있어야 합니다.
- Backend
  - Spring Boot 기반의 백엔드 서버를 Docker 컨테이너로 구성하세요.
  - Reverse Proxy를 통해 /api/, /ws/ 요청이 이 서버로 전달됩니다.
- DB, Memory DB, Message Broker
  - Backend 컨테이너가 접근 가능한 다음의 인프라 컨테이너들을 구성하세요
    - DB: PostgreSQL
    - Memory DB: Redis
    - Message Broker: Kafka
  - 각 컨테이너는 Docker Compose 네트워크를 통해 백엔드에서 통신할 수 있어야 합니다.
  - 외부 네트워크와 단절되어야 합니다.

심화

심화 항목 1
심화 항목 2

주요 변경사항

스크린샷

멘토에게

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

[강은혁]Sprint1

spring-kang · 2025-11-12T03:46:23Z

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

+    public void registerStompEndpoints(StompEndpointRegistry registry) {
+        // 클라이언트가 연결할 WebSocket 엔드포인트 정의
+        registry.addEndpoint("/ws")
+                .withSockJS(); // SockJS fallback 지원


.setAllowedOriginPatterns("*") 도 추가해주세요.

spring-kang · 2025-11-12T03:46:57Z

src/main/java/com/sprint/mission/discodeit/controller/MessageWebSocketController.java

+@RequiredArgsConstructor
+public class MessageWebSocketController {
+
+    private final SimpMessagingTemplate messagingTemplate;


SimpMessagingTemplate 에 대한 의존은 서비스 단이나 리스너 단에서 처리되도록 구현해주세요!

spring-kang · 2025-11-12T03:47:33Z

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

+    private final SimpMessagingTemplate messagingTemplate;
+
+    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)
+    public void handleMessage(MessageCreatedEvent event) {


여기도 비동기로 처리되도록 처리하시면 좋을것 같아요!

spring-kang · 2025-11-12T03:50:30Z

src/main/java/com/sprint/mission/discodeit/controller/SseController.java

+    private final SseService sseService;
+
+    @GetMapping(produces = MediaType.TEXT_EVENT_STREAM_VALUE)
+    public SseEmitter connect(@AuthenticationPrincipal DiscodeitUserDetails userDetails) {


@RequestParam(value = "LastEventId", required = false) UUID lastEventId 를 받아오도록 처리하시고 connect에 null이 아닌 lastEventId 를 받아서 처리하도록 구현하시면 될것 같습니다.

spring-kang · 2025-11-12T03:52:13Z

Sse 를 이벤트 핸들러를 통해 발행되도록 개선해보세요!

Copilot

Pull Request Overview

This PR implements WebSocket messaging, Server-Sent Events (SSE) for real-time notifications, and Docker Compose deployment architecture. The implementation includes comprehensive test coverage with unit, integration, and repository tests, along with configuration files for different deployment environments.

Reviewed Changes

Copilot reviewed 201 out of 208 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
src/test/resources/application-test.yaml	Test environment configuration with H2 database and JWT settings
src/test/java/*/storage/s3/	S3 storage integration and API tests
src/test/java/*/service/basic/	Unit tests for core services (User, Notification, Message, Channel, BinaryContent, Auth)
src/test/java/*/security/jwt/	JWT token provider, authentication filter, and login handler tests
src/test/java/*/security/	Login and CSRF security tests
src/test/java/*/repository/	Repository layer tests for User, ReadStatus, Message, and Channel
src/test/java/*/integration/	API integration tests for all major endpoints
src/test/java/*/event/listener/	Event listener tests for notifications and binary content
src/test/java/*/controller/	Controller layer unit tests
src/main/resources/static/*	Frontend static assets (HTML, CSS, JS)
src/main/resources/*.yaml	Application configuration for different environments (dev, prod)
src/main/resources/schema.sql	Database schema definition
src/main/resources/logback-spring.xml	Logging configuration with MDC support
src/main/java/*/storage/	Storage abstraction with local and S3 implementations
src/main/java/*/service/basic/	Core service implementations
settings.gradle	Gradle project configuration

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-12T03:54:00Z

src/main/java/com/sprint/mission/discodeit/storage/local/LocalBinaryContentStorage.java

+  }
+
+  public UUID put(UUID binaryContentId, byte[] bytes) {
+    delay(4);


The hardcoded delay of 4 seconds in the put method appears to be for testing/simulation purposes. This should either be removed for production use, made configurable via application properties, or at minimum documented with a comment explaining why this delay exists.

Copilot · 2025-11-12T03:54:01Z

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

+    User user = userRepository.findById(userId)
+            .orElseThrow(() -> UserNotFoundException.withId(userId));


The user retrieval before deletion is unnecessary since userRepository.deleteById() will throw an exception if the user doesn't exist. Consider checking existence with existsById() instead if validation is required, or remove this check entirely to reduce database calls.

Copilot · 2025-11-12T03:54:01Z

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

+        .orElseThrow(() -> {
+          UserNotFoundException exception = UserNotFoundException.withId(userId);
+          return exception;
+        });


The exception creation can be simplified. Instead of creating a local variable and returning it, directly throw the exception inline: .orElseThrow(() -> UserNotFoundException.withId(userId))

Suggested change

.orElseThrow(() -> {

UserNotFoundException exception = UserNotFoundException.withId(userId);

return exception;

});

.orElseThrow(() -> UserNotFoundException.withId(userId));

Copilot · 2025-11-12T03:54:01Z

src/main/resources/application.yaml

+      secret: ${JWT_ACCESS_SECRET:your-access-token-secret-key-here-make-it-long-and-random}
+      expiration-ms: ${JWT_ACCESS_EXPIRATION_MS:1800000} # 30 minutes
+    refresh-token:
+      secret: ${JWT_REFRESH_SECRET:your-refresh-token-secret-key-here-make-it-different-and-long}


The default JWT secret values are insecure placeholder strings. While using environment variables is correct, the fallback default values should either be removed entirely or fail fast if not provided, as these defaults could accidentally be used in production.

Suggested change

secret: ${JWT_ACCESS_SECRET:your-access-token-secret-key-here-make-it-long-and-random}

expiration-ms: ${JWT_ACCESS_EXPIRATION_MS:1800000} # 30 minutes

refresh-token:

secret: ${JWT_REFRESH_SECRET:your-refresh-token-secret-key-here-make-it-different-and-long}

secret: ${JWT_ACCESS_SECRET}

expiration-ms: ${JWT_ACCESS_EXPIRATION_MS:1800000} # 30 minutes

refresh-token:

secret: ${JWT_REFRESH_SECRET}

Copilot · 2025-11-12T03:54:02Z

src/main/resources/schema.sql

+    size         bigint                   NOT NULL,
+    content_type varchar(100)             NOT NULL,
+    status       varchar(20)              NOT NULL
+--     ,bytes        bytea        NOT NULL


The commented-out bytes column should either be removed if it's no longer needed, or properly documented explaining why it's commented out and when/if it should be enabled.

Suggested change

-- ,bytes bytea NOT NULL

Copilot · 2025-11-12T03:54:02Z

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

+  private S3Client getS3Client() {
+    return S3Client.builder()
+        .region(Region.of(region))
+        .credentialsProvider(
+            StaticCredentialsProvider.create(
+                AwsBasicCredentials.create(accessKey, secretKey)
+            )
+        )
+        .build();
+  }


Creating a new S3Client instance on every method call is inefficient. The S3Client should be created once during initialization and reused. Consider making this a final field initialized in the constructor or a PostConstruct method.

Copilot · 2025-11-12T03:54:02Z

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

+  }
+
+  private String generatePresignedUrl(String key, String contentType) {
+    try (S3Presigner presigner = getS3Presigner()) {


Similar to the S3Client, creating a new S3Presigner instance for each presigned URL generation is inefficient. The S3Presigner should be created once and reused as a class field.

Eunhye0k and others added 7 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

sprint12 commit.

f34af88

Delete README.md

8f74771

spring-kang reviewed Nov 12, 2025

View reviewed changes

spring-kang requested a review from Copilot November 12, 2025 03:52

spring-kang approved these changes Nov 12, 2025

View reviewed changes

Copilot AI reviewed Nov 12, 2025

View reviewed changes

spring-kang approved these changes Nov 12, 2025

View reviewed changes

		User user = userRepository.findById(userId)
		.orElseThrow(() -> UserNotFoundException.withId(userId));

[신은수] Sprint12 #170

Are you sure you want to change the base?

[신은수] Sprint12 #170

Uh oh!

Conversation

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

Uh oh!

요구사항

기본

웹소켓 구현하기

2. SSE 구현하기

3. 배포 아키텍처 구성하기

심화

주요 변경사항

스크린샷

멘토에게

Uh oh!

spring-kang Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

spring-kang commented Nov 12, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 12, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Shinsu98 commented Nov 7, 2025 •

edited

Loading