[Spring Boot] FCM(Firebase Cloud Messaging) 설정부터 푸시 알림 메시지 전송하기

 

 

 

1. Firebase Cloud Messaging(FCM)이란?

• Firebase Cloud Messaging(FCM)은 구글이 제공하는 클라우드 기반의 메시징 솔루션
• 앱 개발자들이 사용자의 Android, iOS, 웹 애플리케이션에 무료로 알림을 보낼 수 있게 해줌
• FCM은 푸시 알림 뿐만 아니라 앱 내 메시지 기능도 지원하며, 간단한 설정과 코드 몇 줄만으로 대규모의 메시지를 신속하게 전송 가능

 

2. FCM 설정하기

• Firebase 콘솔 (https://console.firebase.google.com/) 접속
• Step 1 - Firebase 프로젝트 만들기
  • 프로젝트 생성

 

• Step 2 -  앱에 Firebase 추가하기
  • 앱의 패키지 이름을 작성 > google-services.json을 다운로드 받아 앱 모듈 루트 디렉토리에 넣는다.

 

• Step 3 - 비공개 키 생성
  • Firebase 콘솔 → 프로젝트 개요 → 프로젝트 설정 버튼을 누릅니다. 
  • 프로젝트 설정 → 서비스 계정 → 자바 선택 → ‘새 비공개 키 생성’ 버튼을 누릅니다.

 

 

 

3. FCM 메시지 전송 방법

1. Firebase Admin SDK
2. HTTP v1 API
3. 기존 FCM 서버 프로토콜(HTTP 및 XMPP)

	Firebase Admin SDK	HTTP v1 API	기존 FCM 서버 프로토콜 (HTTP)	기 FCM 서버 프로토콜 (XMPP)
개별 디바이스	O	O	O	O
주제(토픽) 구독	O	O	O	O
멀티캐스트	O	X (배치 요청 사용 권장)	X	X

 

 

4. Spring Boot에서 Firebase Admin SDK를 이용하여 푸시 알림 구현하기

• 클라이언트 단에서 앱에 로그인한 유저의 FirebaseToken을 발급하여 등록하는 과정이 수행됩니다.
• 이때 유저의 FirebaseToken을 등록은 별도의 백엔드 API를 필요합니다.
• 아래 과정은 FirebaseToken이 발급되어 저장되어 있는 상태를 가정하여 시작하며 위 과정을 생략하여 진행하도록 하겠습니다.
  
  

1. 의존성 추가
   

   dependencies {
       // Firebase Admin SDK
       implementation 'com.google.firebase:firebase-admin:7.3.0'
   }

   
   
   • Firebase Admin SDK 의존 Library 추가
   
   
2. Firebase 설정 초기화
   • src/main/resources 디렉토리에 'Step 3 - 비공개 키 생성'에서 생성한 Firebase 서비스 계정 키 파일(firebase-service-account.json)을 추가
   • Firebase를 초기화하는 설정 클래스를 생성
     

     import com.google.auth.oauth2.GoogleCredentials;
     import com.google.firebase.FirebaseApp;
     import com.google.firebase.FirebaseOptions;
     import org.springframework.stereotype.Service;
     
     import javax.annotation.PostConstruct;
     import java.io.FileInputStream;
     import java.io.IOException;
     
     @Service
     public class FirebaseInitialization {
     
         @PostConstruct
         public void initialize() {
             try {
                 FileInputStream serviceAccount =
                         new FileInputStream("./src/main/resources/firebase-service-account.json");
     
                 FirebaseOptions options = new FirebaseOptions.Builder()
                         .setCredentials(GoogleCredentials.fromStream(serviceAccount))
                         .build();
     
                 FirebaseApp.initializeApp(options);
             } catch (IOException e) {
                 e.printStackTrace();
             }
         }
     }​

     
     
     
3. FCM 메시지 보내기
   
   

💡 구현 순서
1. FcmMessageRequestDto
- 푸시 알림을 보낼 때 필요한 정보를 담을 DTO를 정의합니다.

2. FirebaseController
- [POST] '/api/v1/fcm/sendMessage'로 푸시 메시지 제목, 내용(FcmMessageRequestDto)을 파라미터로 전달합니다.

2. FirebaseCloudMessageService
- 전달받은 파라미터에 따라 푸시 알림 메시지를 전송합니다.
- [GET] userService.findByUserFcm(userId) 로 알림 발송할 유저의 firebasetoken정보를 조회하여 해당 디바이스로 전달받은 파라미터를 푸시 알림 메시지로 전송합니다.

 

 

 

1) FcmMessageRequestDto 정의

• 푸시 알림을 보낼 때 필요한 정보(제목, 내용)를 담을 DTO 정의
• 웹에서 발송 대상을 선택하고, 알림 제목과 내용을 작성

@Getter
@NoArgsConstructor
@AllArgsConstructor
public class FcmMessageRequestDto {

    @Schema(description = "유저ID")
    private String userId;

    @Schema(description = "메시지 제목")
    private String title;

    @Schema(description = "메시지 내용")
    private String body;
}

 

 

2) FirebaseController  구현

• 클라이언트로부터 푸시 알림 전송 요청을 받아 FirebaseCloudMessageService로 전달하는 역할

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class FirebaseController {
    
    private final FirebaseMessageService firebaseMessageService;
    
    @Autowired
    public FirebaseController(FirebaseMessageService firebaseMessageService) {
        this.firebaseMessageService = firebaseMessageService;
    }

    @PostMapping("/api/v1/fcm/sendMessage")
    public ResponseEntity<String> sendMessage(@RequestBody FcmMessageRequestDto requestDto) {
        String response = firebaseCloudMessageService.sendMessage(requestDto);
        return ResponseEntity.ok(response);
    }
}

 

 

 

3) FirebaseCloudMessageService 구현

• Firebase Admin SDK를 사용하여 실제로 Firebase 서버에 푸시 알림을 보내는 역할
• DB에 저장되어 있는 사용자의 Firebase 토큰 값을 조회하여 해당 디바이스로 푸시 알림을 전송

@Service
public class FirebaseCloudMessageService {

    private final UserService userService;

    public String sendMessage(FcmMessageRequestDto requestDto) {
        // 사용자의 Firebase 토큰 값을 조회
        String userFirebaseToken = userService.findFirebaseTokenByUserId(requestDto.userId);

        // 메시지 구성
        Message message = Message.builder()
            .putData("title", requestDto.getTitle())
            .putData("content", requestDto.getContent())
            .setToken(userFirebaseToken) // 조회한 토큰 값을 사용
            .build();

        try {
            // 메시지 전송
            String response = FirebaseMessaging.getInstance().send(message);
            return "Message sent successfully: " + response;
        } catch (FirebaseMessagingException e) {
            e.printStackTrace();
            return "Failed to send message";
        }
    }
}

 

 

4. 테스트

• Postman 등을 사용하여 /api/v1/fcm/sendMessage에 요청을 보내 푸시 알림 전송 테스트를 진행합니다.

 

 

이렇게 서버단에서 Firebase Admin SDK를 사용하여 푸시 알림을 전송해 보았습니다.  감사합니다.

 

 

 

참고

- Firebase 문서(특정 기기에 메시지 전송) : https://firebase.google.com/docs/cloud-messaging/send-message?hl=ko#send-messages-to-specific-devices