feat: 콕 찌르기 알림 서비스 기능 구현

.github/workflows/ci.yml

@@ -1,46 +1,48 @@
 name: ci
 
 on:
-    pull_request:
-        branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
 
 jobs:
-    build:
-        name: build
-        runs-on: ubuntu-latest
-        steps:
-            -   uses: actions/checkout@v3
-                with:
-                    fetch-depth: 0
+  build:
+    name: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          submodules: true
+          token: ${{ secrets.MOABAM_SUBMODULE_KEY }}
 
-            -   name: JDK 17 셋업
-                uses: actions/setup-java@v3
-                with:
-                    java-version: '17'
-                    distribution: 'corretto'
+      - name: JDK 17 셋업
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'corretto'
 
-            -   name: Gradle 캐싱
-                uses: actions/cache@v3
-                with:
-                    path: |
-                        ~/.gradle/caches
-                        ~/.gradle/wrapper
-                    key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
-                    restore-keys: |
-                        ${{ runner.os }}-gradle-
+      - name: Gradle 캐싱
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
 
-            -   name: Gradle Grant 권한 부여
-                run: chmod +x gradlew
+      - name: Gradle Grant 권한 부여
+        run: chmod +x gradlew
 
-            -   name: SonarCloud 캐싱
-                uses: actions/cache@v3
-                with:
-                    path: ~/.sonar/cache
-                    key: ${{ runner.os }}-sonar
-                    restore-keys: ${{ runner.os }}-sonar
+      - name: SonarCloud 캐싱
+        uses: actions/cache@v3
+        with:
+          path: ~/.sonar/cache
+          key: ${{ runner.os }}-sonar
+          restore-keys: ${{ runner.os }}-sonar
 
-            -   name: 빌드 및 분석
-                run: ./gradlew build jacocoTestReport sonar --info --stacktrace
-                env:
-                    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                    SONAR_TOKEN: ${{ secrets.SONAR_CLOUD_TOKEN }}
+      - name: 빌드 및 분석
+        run: ./gradlew build jacocoTestReport sonar --info --stacktrace
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_CLOUD_TOKEN }}

build.gradle

@@ -55,6 +55,12 @@ dependencies {
 
     // Configuration Binding
     annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
+
+    // Redis
+    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+
+    // Firebase Admin
+    implementation 'com.google.firebase:firebase-admin:9.2.0'
 }
 
 tasks.named('test') {

src/main/java/com/moabam/api/application/NotificationService.java

@@ -0,0 +1,50 @@
+package com.moabam.api.application;
+
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+import com.google.firebase.messaging.FirebaseMessaging;
+import com.google.firebase.messaging.Message;
+import com.google.firebase.messaging.Notification;
+import com.moabam.api.domain.repository.NotificationRepository;
+import com.moabam.api.dto.NotificationMapper;
+import com.moabam.global.common.annotation.MemberTest;
+import com.moabam.global.error.exception.ConflictException;
+import com.moabam.global.error.exception.NotFoundException;
+import com.moabam.global.error.model.ErrorMessage;
+
+import lombok.RequiredArgsConstructor;
+
+@Service
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+public class NotificationService {
+
+	private final FirebaseMessaging firebaseMessaging;
+	private final NotificationRepository notificationRepository;
+
+	@Transactional
+	public void sendKnockNotification(MemberTest member, Long targetId, Long roomId) {
+		validateFcmToken(targetId);
+		validateKnockNotification(member.memberId(), targetId, roomId);
+
+		String fcmToken = notificationRepository.findFcmTokenByMemberId(targetId);
+		Notification notification = NotificationMapper.toKnockNotificationEntity(member.memberId());
+		Message message = NotificationMapper.toMessageEntity(notification, fcmToken);
+
+		firebaseMessaging.sendAsync(message);
+		notificationRepository.saveKnockNotification(member.memberId(), targetId, roomId);
+	}
+
+	private void validateFcmToken(Long memberId) {
+		if (!notificationRepository.existsFcmTokenByMemberId(memberId)) {
+			throw new NotFoundException(ErrorMessage.FCM_TOKEN_NOT_FOUND);
+		}
+	}
+
+	private void validateKnockNotification(Long memberId, Long targetId, Long roomId) {
+		if (notificationRepository.existsKnockByMemberId(memberId, targetId, roomId)) {
+			throw new ConflictException(ErrorMessage.KNOCK_CONFLICT);
+		}
+	}
+}

src/main/java/com/moabam/api/domain/repository/NotificationRepository.java

@@ -0,0 +1,55 @@
+package com.moabam.api.domain.repository;
+
+import static com.moabam.global.common.util.GlobalConstant.*;
+import static java.util.Objects.*;
+
+import java.time.Duration;
+
+import org.springframework.stereotype.Repository;
+
+import com.moabam.global.common.repository.StringRedisRepository;
+
+import lombok.RequiredArgsConstructor;
+
+@Repository
+@RequiredArgsConstructor
+public class NotificationRepository {
+
+	private static final long EXPIRE_KNOCK = 12;
+	private static final long EXPIRE_FCM_TOKEN = 60;
+	private static final String TO = "_TO_";
+
+	private final StringRedisRepository stringRedisRepository;
+
+	// TODO : 세연님 로그인 시, 해당 메서드 사용해서 해당 유저의 FCM TOKEN 저장하면 됩니다.
+	public void saveFcmToken(Long key, String value) {
+		stringRedisRepository.save(
+			String.valueOf(requireNonNull(key)),
+			requireNonNull(value),
+			requireNonNull(Duration.ofDays(EXPIRE_FCM_TOKEN))
+		);
+	}
+
+	public void saveKnockNotification(Long memberId, Long targetId, Long roomId) {
+		String key = requireNonNull(roomId) + UNDER_BAR + requireNonNull(memberId) + TO + requireNonNull(targetId);
+		stringRedisRepository.save(key, BLANK, requireNonNull(Duration.ofHours(EXPIRE_KNOCK)));
+	}
+
+	// TODO : 세연님 로그아웃 시, 해당 메서드 사용해서 해당 유저의 FCM TOKEN 삭제하시면 됩니다.
+	public void deleteFcmTokenByMemberId(Long memberId) {
+		stringRedisRepository.delete(String.valueOf(requireNonNull(memberId)));
+	}
+
+	public String findFcmTokenByMemberId(Long memberId) {
+		return stringRedisRepository.get(String.valueOf(requireNonNull(memberId)));
+	}
+
+	public boolean existsFcmTokenByMemberId(Long memberId) {
+		return stringRedisRepository.hasKey(String.valueOf(requireNonNull(memberId)));
+	}
+
+	public boolean existsKnockByMemberId(Long memberId, Long targetId, Long roomId) {
+		String key = requireNonNull(roomId) + UNDER_BAR + requireNonNull(memberId) + TO + requireNonNull(targetId);
+		return stringRedisRepository.hasKey(key);
+	}
+}

src/main/java/com/moabam/api/dto/NotificationMapper.java

@@ -0,0 +1,28 @@
+package com.moabam.api.dto;
+
+import com.google.firebase.messaging.Message;
+import com.google.firebase.messaging.Notification;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class NotificationMapper {
+
+	private static final String TITLE = "모아밤";
+	private static final String KNOCK_BODY = "님이 콕 찔렀습니다.";
+
+	public static Notification toKnockNotificationEntity(Long memberId) {
+		return Notification.builder()
+			.setTitle(TITLE)
+			.setBody(memberId + KNOCK_BODY)
+			.build();
+	}
+
+	public static Message toMessageEntity(Notification notification, String fcmToken) {
+		return Message.builder()
+			.setNotification(notification)
+			.setToken(fcmToken)
+			.build();
+	}
+}

src/main/java/com/moabam/global/common/annotation/MemberTest.java

@@ -0,0 +1,7 @@
+package com.moabam.global.common.annotation;
+
+public record MemberTest(
+	Long memberId
+) {
+
+}

src/main/java/com/moabam/global/common/repository/StringRedisRepository.java

@@ -0,0 +1,39 @@
+package com.moabam.global.common.repository;
+
+import java.time.Duration;
+
+import org.springframework.data.redis.core.StringRedisTemplate;
+import org.springframework.stereotype.Repository;
+import org.springframework.transaction.annotation.Transactional;
+
+import lombok.RequiredArgsConstructor;
+
+@Repository
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+public class StringRedisRepository {
+
+	private final StringRedisTemplate stringRedisTemplate;
+
+	@Transactional
+	public void save(String key, String value, Duration timeout) {
+		stringRedisTemplate
+			.opsForValue()
+			.set(key, value, timeout);
+	}
+
+	@Transactional
+	public void delete(String key) {
+		stringRedisTemplate.delete(key);
+	}
+
+	public String get(String key) {
+		return stringRedisTemplate
+			.opsForValue()
+			.get(key);
+	}
+
+	public Boolean hasKey(String email) {
+		return stringRedisTemplate.hasKey(email);
+	}
+}

src/main/java/com/moabam/global/common/util/GlobalConstant.java

@@ -6,6 +6,8 @@
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 public class GlobalConstant {
 
+	public static final String BLANK = "";
+	public static final String UNDER_BAR = "_";
 	public static final String COMMA = ",";
 	public static final String CHARSET_UTF_8 = ";charset=UTF-8";
 }

src/main/java/com/moabam/global/config/FcmConfig.java

@@ -0,0 +1,45 @@
+package com.moabam.global.config;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.io.ClassPathResource;
+import org.springframework.scheduling.annotation.EnableScheduling;
+
+import com.google.auth.oauth2.GoogleCredentials;
+import com.google.firebase.FirebaseApp;
+import com.google.firebase.FirebaseOptions;
+import com.google.firebase.messaging.FirebaseMessaging;
+import com.moabam.global.error.exception.FcmException;
+import com.moabam.global.error.model.ErrorMessage;
+
+import lombok.extern.slf4j.Slf4j;
+
+@Slf4j
+@Configuration
+@EnableScheduling
+public class FcmConfig {
+
+	private static final String FIREBASE_PATH = "config/moabam-firebase.json";
+
+	@Bean
+	public FirebaseMessaging firebaseMessaging() {
+		try (InputStream inputStream = new ClassPathResource(FIREBASE_PATH).getInputStream()) {
+			GoogleCredentials credentials = GoogleCredentials.fromStream(inputStream);
+			FirebaseOptions firebaseOptions = FirebaseOptions.builder()
+				.setCredentials(credentials)
+				.build();
+			if (FirebaseApp.getApps().isEmpty()) {
+				FirebaseApp.initializeApp(firebaseOptions);
+				log.info("======= Firebase init start =======");
+			}
+
+			return FirebaseMessaging.getInstance();
+		} catch (IOException e) {
+			log.error("======= firebase moabam error =======" + e + "");
+			throw new FcmException(ErrorMessage.FCM_INIT_FAILED);
+		}
+	}
+}

src/main/java/com/moabam/global/config/RedisConfig.java

@@ -0,0 +1,34 @@
+package com.moabam.global.config;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.data.redis.connection.RedisConnectionFactory;
+import org.springframework.data.redis.connection.lettuce.LettuceConnectionFactory;
+import org.springframework.data.redis.core.StringRedisTemplate;
+import org.springframework.data.redis.serializer.StringRedisSerializer;
+
+@Configuration
+public class RedisConfig {
+
+	@Value("${spring.data.redis.host}")
+	private String redisHost;
+
+	@Value("${spring.data.redis.port}")
+	private int redisPort;
+
+	@Bean
+	public RedisConnectionFactory redisConnectionFactory() {
+		return new LettuceConnectionFactory(redisHost, redisPort);
+	}
+
+	@Bean
+	public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
+		StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
+		stringRedisTemplate.setKeySerializer(new StringRedisSerializer());
+		stringRedisTemplate.setValueSerializer(new StringRedisSerializer());
+		stringRedisTemplate.setConnectionFactory(redisConnectionFactory);
+
+		return stringRedisTemplate;
+	}
+}

src/main/java/com/moabam/global/error/exception/FcmException.java

@@ -0,0 +1,10 @@
+package com.moabam.global.error.exception;
+
+import com.moabam.global.error.model.ErrorMessage;
+
+public class FcmException extends MoabamException {
+
+	public FcmException(ErrorMessage errorMessage) {
+		super(errorMessage);
+	}
+}