feat: 실시간 채팅 - 기본 메세지 송수신, 세션 처리

family-moments/.gitignore

@@ -263,3 +263,4 @@ gradle-app.setting
 ### Gradle Patch ###
 # Java heap dump
 *.hprof
+/src/main/java/com/spring/familymoments/domain/chat/ChatRedisPrefix.java

family-moments/build.gradle

@@ -55,22 +55,23 @@ dependencies {
 	implementation 'org.springframework.boot:spring-boot-starter-web'
 	// S3
 	implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
-
 	// Mail
 	implementation 'org.springframework.boot:spring-boot-starter-mail'
 	// Random Code
 	implementation 'org.apache.commons:commons-lang3:3.12.0'
-
 	// jsch 라이브러리, for ssh tunneling
 	implementation 'com.github.mwiede:jsch:0.2.12'
 	// application.yml의 환경 변수를 class에서 사용하기 위한 라이브러리
 	annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
 	// swagger
 	implementation 'org.springdoc:springdoc-openapi-ui:1.7.0'
-
 	// mongoDB
 	implementation 'org.springframework.boot:spring-boot-starter-data-mongodb'
 
+	// for chatting
+	// websocket
+	implementation 'org.springframework.boot:spring-boot-starter-websocket'
+
 	// OpenFeign - social login
 	implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
 

family-moments/src/main/java/com/spring/familymoments/domain/chat/ChatDocumentRepository.java

@@ -0,0 +1,9 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.domain.chat.document.ChatDocument;
+import org.bson.types.ObjectId;
+import org.springframework.data.mongodb.repository.MongoRepository;
+
+public interface ChatDocumentRepository extends MongoRepository<ChatDocument, ObjectId> {
+
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/ChatEventHandler.java

@@ -0,0 +1,40 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.domain.user.UserService;
+import com.spring.familymoments.domain.user.entity.User;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.event.EventListener;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.stereotype.Component;
+import org.springframework.web.socket.messaging.SessionConnectedEvent;
+import org.springframework.web.socket.messaging.SessionDisconnectEvent;
+
+@Component
+@RequiredArgsConstructor
+public class ChatEventHandler {
+    private final UserService userService; // TODO: 임시, 차후 삭제
+    private final SessionService sessionService;
+
+    @EventListener
+    public void handleSessionConnected(SessionConnectedEvent event) {
+        StompHeaderAccessor accessor = StompHeaderAccessor.wrap(event.getMessage());
+        StompHeaderAccessor headerAccessor = StompHeaderAccessor.wrap((Message<?>) accessor.getHeader("simpConnectMessage"));
+
+        // TODO: 유저 & 세션 정보 확인, Authentication 필요
+        String sessionId = headerAccessor.getSessionId();
+
+        // TODO: User 정보 검증 과정 수정 필요
+        String userId = headerAccessor.getNativeHeader("id").get(0);
+        User user = userService.getUserById(userId);
+
+        sessionService.connect(sessionId, user);
+    }
+
+    @EventListener
+    public void handleSessionDisconnected(SessionDisconnectEvent event) {
+        String sessionId = event.getSessionId();
+
+        sessionService.disconnect(sessionId);
+    }
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/ChatService.java

@@ -0,0 +1,65 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.domain.chat.document.ChatDocument;
+import com.spring.familymoments.domain.chat.model.MessageReq;
+import com.spring.familymoments.domain.chat.model.MessageRes;
+import com.spring.familymoments.domain.chat.model.MessageTemplate;
+import com.spring.familymoments.domain.common.UserFamilyRepository;
+import com.spring.familymoments.domain.redis.RedisService;
+import com.spring.familymoments.domain.user.entity.User;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.messaging.simp.SimpMessagingTemplate;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.time.LocalDateTime;
+import java.util.Set;
+
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class ChatService {
+    private final ChatDocumentRepository chatDocumentRepository;
+    private final RedisService redisService;
+    private final UserFamilyRepository userFamilyRepository;
+    private final SimpMessagingTemplate simpMessagingTemplate;
+
+    // chat Document에 저장
+    public MessageRes createChat(Long familyId, MessageReq messageReq) {
+        ChatDocument chatDocument = ChatDocument.builder()
+                .familyId(familyId)
+                .sender(messageReq.getSender())
+                .message(messageReq.getMessage())
+                .sendedTime(LocalDateTime.now())
+                .build();
+
+        chatDocument = chatDocumentRepository.save(chatDocument);
+
+        MessageRes messageRes = MessageRes.builder()
+                .messageId(chatDocument.getId().toString())
+                .familyId(chatDocument.getFamilyId())
+                .sender(chatDocument.getSender())
+                .message(chatDocument.getMessage())
+                .sendedTime(chatDocument.getSendedTime())
+                .build();
+
+        return messageRes;
+    }
+
+    @Transactional(readOnly = true)
+    public void sendAlarm(long familyId, MessageRes messageRes) {
+        Set<String> unsubMembers = redisService.getMembers(ChatRedisPrefix.FAMILY_UNSUB.value + familyId);
+        Set<String> offlineMembers = redisService.getMembers(ChatRedisPrefix.FAMILY_OFF.value + familyId);
+
+        // Online-unsub 유저에게 알림 발송
+        for(String uuid : unsubMembers) {
+            User user = userFamilyRepository.findActiveUserByFamilyIdAndUuid(familyId, uuid).orElseThrow();
+            MessageTemplate messageTemplate = new MessageTemplate(MessageTemplate.MessageType.NOTIFICATION, messageRes);
+
+            simpMessagingTemplate.convertAndSend("/sub/notification." + user.getId(), messageTemplate);
+        }
+        // TODO: offline 유저에게 알림 발송
+    }
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/SessionService.java

@@ -0,0 +1,128 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.config.BaseException;
+import com.spring.familymoments.config.BaseResponseStatus;
+import com.spring.familymoments.domain.common.UserFamilyRepository;
+import com.spring.familymoments.domain.common.entity.UserFamily;
+import com.spring.familymoments.domain.family.FamilyRepository;
+import com.spring.familymoments.domain.family.entity.Family;
+import com.spring.familymoments.domain.redis.RedisService;
+import com.spring.familymoments.domain.user.UserRepository;
+import com.spring.familymoments.domain.user.entity.User;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import java.time.LocalDateTime;
+import java.util.List;
+import java.util.Set;
+
+import static com.spring.familymoments.config.BaseResponseStatus.minnie_FAMILY_INVALID_USER;
+import static com.spring.familymoments.domain.chat.ChatRedisPrefix.*;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class SessionService {
+    private final RedisService redisService;
+    private final UserFamilyRepository userFamilyRepository;
+    private final FamilyRepository familyRepository;
+    private final UserRepository userRepository;
+
+    // 연결
+    @Transactional
+    public void connect(String sessionId, User user) {
+        saveSessionInfo(sessionId, user.getUuid());
+
+        List<UserFamily> userFamilyList = userFamilyRepository.findAllActiveUserFamilyByUser(user);
+
+        for(UserFamily userFamily : userFamilyList) {
+            Family family = userFamily.getFamilyId();
+
+            // offline 세션에서 제거
+            redisService.removeMember(FAMILY_OFF.value + family.getFamilyId(), user.getUuid());
+
+            // unsub 세션에 추가
+            redisService.addValues(FAMILY_UNSUB.value + family.getFamilyId(), user.getUuid());
+        }
+    }
+
+    // 연결 해제
+    @Transactional
+    public void disconnect(String sessionId) {
+        String uuid = redisService.getValues(SESSION_ID.value + sessionId);
+        User user = userRepository.findUserByUuid(uuid).orElseThrow(() -> new BaseException(BaseResponseStatus.FIND_FAIL_USER));
+
+        // userID를 바탕으로 unsub 중인 내역이 있다면 offline으로 변경
+        List<UserFamily> userFamilyList = userFamilyRepository.findAllActiveUserFamilyByUser(user);
+
+        for(UserFamily userFamily : userFamilyList) {
+            Family family = userFamily.getFamilyId();
+
+            Set<String> members = redisService.getMembers(FAMILY_UNSUB.value + family.getFamilyId());
+            boolean isSubscribing = !members.contains(uuid);
+
+            // unsub 세션에서 제거
+            redisService.removeMember(FAMILY_UNSUB.value + family.getFamilyId(), uuid);
+
+            // sub 중인 채팅방이 있다면 lastAccessedTime 갱신
+            if(isSubscribing) {
+                userFamily.updateLastAccessedTime(LocalDateTime.now());
+            }
+
+            // offline 세션에 추가
+            redisService.addValues(FAMILY_OFF.value + family.getFamilyId(), uuid);
+        }
+
+        // sessionId:userID 삭제
+        redisService.deleteValues(SESSION_ID.value + sessionId);
+    }
+
+
+    // 가족 방 구독
+    @Transactional(readOnly = true)
+    public void subscribeFamily(User user, Long familyId) {
+        Family family = familyRepository.findById(familyId).orElseThrow(() -> new BaseException(BaseResponseStatus.FIND_FAIL_FAMILY));
+        UserFamily userFamily = userFamilyRepository.findActiveUserFamilyByFamilyAndUser(family, user)
+                .orElseThrow(() -> new BaseException(BaseResponseStatus.minnie_FAMILY_INVALID_USER));
+
+        // unsub 세션에서 제거
+        redisService.removeMember(FAMILY_UNSUB.value + familyId, user.getUuid());
+    }
+
+    // 가족 방 구독 해제
+    @Transactional
+    public void unsubscribeFamily(User user, Long familyId) {
+        Family family = familyRepository.findById(familyId).orElseThrow(() -> new BaseException(BaseResponseStatus.FIND_FAIL_FAMILY));
+        UserFamily userFamily = userFamilyRepository.findActiveUserFamilyByFamilyAndUser(family, user)
+                .orElseThrow(() -> new BaseException(BaseResponseStatus.minnie_FAMILY_INVALID_USER));
+
+        unsubscribeFamily(userFamily);
+    }
+
+    // 가족 방 구독 해제
+    @Transactional
+    public void unsubscribeFamily(UserFamily userFamily) {
+        // 마지막 접속 시간 갱신
+        userFamily.updateLastAccessedTime(LocalDateTime.now());
+
+        // unsub 세션에 추가
+        redisService.addValues(FAMILY_UNSUB.value + userFamily.getFamilyId().getFamilyId(), userFamily.getUserId().getUuid());
+    }
+
+    // 접속한 유저의 세션 정보 저장
+    public void saveSessionInfo(String sessionId, String userId) {
+        redisService.setValues(SESSION_ID.value + sessionId, userId);
+    }
+
+    // 마지막 접속 시간 조회 TODO: 차후 삭제
+    @Transactional
+    public LocalDateTime getLastAccessedTime(User user, Family family) {
+        UserFamily userFamily = userFamilyRepository.findActiveUserFamilyByFamilyAndUser(family, user)
+                .orElseThrow(()-> new BaseException(minnie_FAMILY_INVALID_USER));
+
+        return userFamily.getLastAccessedTime();
+    }
+
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/StompController.java

@@ -0,0 +1,31 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.domain.chat.model.MessageReq;
+import com.spring.familymoments.domain.chat.model.MessageRes;
+import com.spring.familymoments.domain.chat.model.MessageTemplate;
+import lombok.RequiredArgsConstructor;
+import org.springframework.messaging.handler.annotation.DestinationVariable;
+import org.springframework.messaging.handler.annotation.MessageMapping;
+import org.springframework.stereotype.Controller;
+import org.springframework.messaging.simp.SimpMessagingTemplate;
+
+import java.time.LocalDateTime;
+
+@Controller
+@MessageMapping("")
+@RequiredArgsConstructor
+public class StompController {
+    private final SimpMessagingTemplate simpMessagingTemplate;
+    private final ChatService chatService;
+
+    @MessageMapping("{familyId}.send")
+    public void handleSend(@DestinationVariable("familyId") long familyId, MessageReq messageReq) {
+        MessageRes messageRes = chatService.createChat(familyId, messageReq);
+        MessageTemplate response = new MessageTemplate(MessageTemplate.MessageType.MESSAGE, messageRes);
+
+        simpMessagingTemplate.convertAndSend("/sub/" + familyId, response);
+
+        // TODO: online-unsub & offline 유저에게 알림 발송
+        chatService.sendAlarm(familyId, messageRes);
+    }
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/StompInterceptor.java

@@ -0,0 +1,52 @@
+package com.spring.familymoments.domain.chat;
+
+import com.spring.familymoments.domain.user.UserService;
+import com.spring.familymoments.domain.user.entity.User;
+import lombok.RequiredArgsConstructor;
+import org.springframework.messaging.Message;
+import org.springframework.messaging.MessageChannel;
+import org.springframework.messaging.simp.stomp.StompCommand;
+import org.springframework.messaging.simp.stomp.StompHeaderAccessor;
+import org.springframework.messaging.support.ChannelInterceptor;
+import org.springframework.stereotype.Component;
+
+@Component
+@RequiredArgsConstructor
+public class StompInterceptor implements ChannelInterceptor {
+    private static final String NOTIFICATION = "notification";
+
+    private final SessionService sessionService;
+    private final UserService userService; // TODO: 임시, 차후 삭제
+
+    @Override
+    public Message<?> preSend(Message<?> message, MessageChannel channel) {
+        StompHeaderAccessor headerAccessor = StompHeaderAccessor.wrap(message);
+        StompCommand command = headerAccessor.getCommand();
+        String destination = headerAccessor.getDestination();
+
+        if(command.equals(StompCommand.SUBSCRIBE) && !destination.contains(NOTIFICATION)) {
+            // 가족 채팅방 구독 시
+            // TODO: Authentication - user & familyId (SubscriptionId 검증)
+            // TODO: User 정보 검증 과정 수정 필요
+            String userInfo = headerAccessor.getNativeHeader("id").get(0);
+            String userId = userInfo.substring(0, userInfo.lastIndexOf("-"));
+            Long familyId = Long.valueOf(userInfo.substring(userInfo.lastIndexOf("-") + 1));
+            User user = userService.getUserById(userId);
+
+            sessionService.subscribeFamily(user, familyId);
+        } else if (command.equals(StompCommand.UNSUBSCRIBE)) {
+            //구독 해제 시
+            // TODO: 가족 채팅방 - noti 채널 구분 필요
+            // TODO: Authentication - user & familyId (SubscriptionId 검증)
+            // TODO: User 정보 검증 과정 수정 필요
+            String userInfo = headerAccessor.getNativeHeader("id").get(0);
+            String userId = userInfo.substring(0, userInfo.lastIndexOf("-"));
+            Long familyId = Long.valueOf(userInfo.substring(userInfo.lastIndexOf("-") + 1));
+            User user = userService.getUserById(userId);
+
+            sessionService.unsubscribeFamily(user, familyId);
+        }
+
+        return message;
+    }
+}

family-moments/src/main/java/com/spring/familymoments/domain/chat/document/ChatDocument.java

@@ -0,0 +1,23 @@
+package com.spring.familymoments.domain.chat.document;
+
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Getter;
+import org.bson.types.ObjectId;
+import org.springframework.data.annotation.Id;
+import org.springframework.data.mongodb.core.mapping.Document;
+
+import java.time.LocalDateTime;
+
+@Getter
+@AllArgsConstructor
+@Builder
+@Document(collection = "chat")
+public class ChatDocument {
+    @Id
+    private ObjectId id;
+    private Long familyId;
+    private String sender;
+    private String message;
+    private LocalDateTime sendedTime;
+}