[구현] Spring에서 Firebase 푸시알림 구현하기

푸시 알람 깔깔

Firebase 프로젝트 세팅하기

https://firebase.google.com/?hl=ko 

Firebase | Google’s Mobile and Web App Development Platform

firebase 웹사이트에 들어가서 프로젝트를 생성해줍니다.

프로젝트 이름과 함께 플랫폼을 선택하라고 나옵니다.
필요한 client 플랫폼을 모두 생성해서 시키는 대로 해줍시다. 이 때 client 개발자들에게 이거 보고 이대로 해달라고 합시다!

iOS는 번들ID라는 것을 입력해야 해요
https://firebase.google.com/docs/ios/setup?hl=ko 

Apple 프로젝트에 Firebase 추가  |  Firebase for Apple platforms

그들도 firebase 알람을 받을 밑작업이 필요하니까 이것도 말해주기
저는 잘 오는지 확인하기 위해 Android Studio를 깔아서 직접 해봤답니다...ㅎ

 

Android 세팅하기

일단 Firebase 에 앱 추가할 때 google-services.json 파일 주면서 집어넣으라고 한다.
여기다 넣어주면 됩니다.

다음 코드들을 추가해줍시다
build.gradle

dependencies {
    classpath 'com.google.gms:google-services:4.3.5'
}

build.gradle(:app)

dependencies {
	...
    implementation 'com.google.firebase:firebase-messaging:21.1.0'
    implementation 'com.google.firebase:firebase-analytics-ktx:17.3.0'
}
apply plugin: 'com.google.gms.google-services'

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools">

    <uses-permission android:name="android.permission.INTERNET"/>

    <application
        ...>
        ...
        <service android:name=".MyFirebaseMessagingService"
            android:exported="true">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT"/>
            </intent-filter>
        </service>
    </application>
</manifest>

//MyFirebaseMessagingService.kt
class MyFirebaseMessagingService : FirebaseMessagingService() {
    override fun onNewToken(token: String) {
        Log.d("FCM Log", "Refreshed token: $token")
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        // TODO(developer): Handle FCM messages here.
    }
}

 

Spring Boot 세팅

build.gradle부터 수정해줍니다.

implementation 'com.google.firebase:firebase-admin:6.8.1'
implementation group: 'com.squareup.okhttp3', name: 'okhttp', version: '4.2.2'

그리고 Firebase 프로젝트에서 받을 수 있는 json파일 

아래 경로에 넣어줍니다.

 

구현

일단 회원가입, 로그인 시 DB에 device token을 저장하는 작업이 필요합니다.
Android 는 fcm token을 저장하면 되구요
iOS는 device token 저장하면 됩니다. 
그리고 메세지를 전송할 때, 전송할 기기들의 이 token을 List로 넘겨줘야 해요
 
FirebaseCloudMessageUtil라는 클래스를 만들어볼게요

• Firebase App을 초기화하는 initialFirebaseApp
• 메세지를 보내는 sendMessage <- 얘를 외부에서 사용함으로써 푸시알림을 보낼겁니다

크게 두 개의 메서드로 이루어질 예정입니다.
처음에는 sendMessage  메서드에서 Android와 iOS를 같은 방식으로 푸시알림을 보내고자 했습니다.

FcmMessage fcmMessage = FcmMessage.builder()
        .message(FcmMessage.Message.builder()
                .token(targetToken)
                .data(
                        new LinkedHashMap<>() {{
                            put("type", String.valueOf(type));
                        }}
                )
                .notification(FcmMessage.Notification.builder()
                        .title(title)
                        .body(body)
                        .build()
                ).build()).validateOnly(false).build();

return objectMapper.writeValueAsString(fcmMessage);

이 방식의 문제점은 안드로이드가 알람을 수신했을 때
화면이 켜지지 않았습니다…!
이를 해결하기 위해서는 notification으로 보내면 안됐어요
그렇다고 iOS도 같은 방식으로 보내면 정상적 수신이 되지 않더라구요

그래서 찾아낸 방법
setAndroidConfig, setApnsConfig을 이용하여 각자에 맞게 보내기

@Component
@RequiredArgsConstructor
public class FirebaseCloudMessageUtil {
    static FirebaseApp firebaseApp;
    static final String firebaseAppName = "[앱이름]";
    static final String firebaseConfigPath = "firebase/firebase_service_key.json";
	
    //의존성 주입 처음될 때 한 번 호출
    @PostConstruct
    private void initialFirebaseApp() throws IOException {
        FirebaseOptions options = FirebaseOptions.builder()
                .setCredentials(GoogleCredentials.fromStream(new ClassPathResource(firebaseConfigPath).getInputStream()))
                .build();

        firebaseApp = FirebaseApp.initializeApp(options, firebaseAppName);
    }

    public void sendMessage(List<String> deviceTokenToSendList, String title, String body, Map<String, String> data) {

        if (deviceTokenToSendList.size() > 0) {
            MulticastMessage message = MulticastMessage.builder()
                    .addAllTokens(deviceTokenToSendList)
                    .setAndroidConfig(AndroidConfig.builder()
                            .putAllData(creatDataForAOS(title, body, data))
                            .build())
                    .setApnsConfig(ApnsConfig.builder()
                            .putAllCustomData(createDataForiOS(data))
                            .setAps(Aps.builder()
                                    .setContentAvailable(true)
                                    .setAlert(ApsAlert.builder()
                                            .setTitle(title)
                                            .setBody(body)
                                            .build())
                                    .build())
                            .build())
                    .build();

            try {
                FirebaseMessaging.getInstance(firebaseApp).sendMulticast(message);
            } catch (FirebaseMessagingException e) {
                throw new CustomException(ResponseCode.SERVER_ERROR_FAILED_TO_SEND_FCM);
            }
        }
    }

    @NotNull
    private static LinkedHashMap<String, String> creatDataForAOS(String title, String body, Map<String, String> data) {
        LinkedHashMap<String, String> dataForAOS = new LinkedHashMap<>() {{
            put(FcmDataType.TITLE.getType(), title);
            put(FcmDataType.BODY.getType(), body);
        }};
        dataForAOS.putAll(data);
        return dataForAOS;
    }

    @NotNull
    private static LinkedHashMap<String, Object> createDataForiOS(Map<String, String> data) {
        LinkedHashMap<String, Object> dataForiOS = new LinkedHashMap<>();
        dataForiOS.putAll(data);
        return dataForiOS;
    }

}

deviceTokenToSendList는 전송할 디바이스 토큰들이 들어있는 List!
단체로 한 번에 보내기 위해 MulticastMessage를 사용했습니다.
https://firebase.google.com/docs/cloud-messaging/send-message?hl=ko 

앱 서버 전송 요청 작성  |  Firebase 클라우드 메시징

 
setAndroidConfig, setApnsConfig 설정하는 방법이 달라서 각자에 맞춰진 Data를 만들 수 있는 메서드 두 개 (creatDataForAOS, createDataForiOS)를 추가해줬습니다.
+) FcmDataType은 타입 명 enum 클래스입니다.
 
+) 혹시 잘 가는지 확인이 필요하다면 message를 로그 찍어 보세여
 
사용법!

firebaseCloudMessageUtil.sendMessage({메세지 받을 User들 device token list},
                    {푸시알림 제목},
                    {푸시알림 내용},
                    {보낼 데이터 타입, 데이터 HashMap});

푸시알림 제목은 말 그대로 제목 
푸시알림 내용은 말 그대로 내용
보낼 데이터는 payload, 푸시 알림에 보이지는 않지만 Client 측에서 푸시 알림을 수신했을 시 꺼내올 수 있는 데이터

제목과 내용

예시
 

LinkedHashMap<String, String> dataToSend = new LinkedHashMap<>() {{
    put(FcmDataType.TYPE.getType(), String.valueOf(FcmPushType.CPR_CALL.ordinal()));
    put(FcmDataType.CPR_CALL_ID.getType(), String.valueOf(cprCall.getId()));
}};

List<String> deviceTokenToSendPushList;
do {
    pageable = PageRequest.of(offset, maxSize);
    deviceTokenToSendPushList = deviceTokenRepository.findAllDeviceTokenByUserAddressExceptCaller(cprCall.getAddress().getId(), userId, pageable);
    firebaseCloudMessageUtil.sendMessage(
            deviceTokenToSendPushList,
            FcmMessage.CPR_CALL_TITLE.getMessage(),
            cprCall.getFullAddress(),
            dataToSend
    );
    offset += maxSize;
} while (deviceTokenToSendPushList.size() >= maxSize);

 

테스트 해보기

클라이언트 개발자를 직접 만나지 않고는 테스트 하기가 힘듭니다
혼자 테스트 하기 위해서 아까 만든 Android 프로젝트를 다시 켭시다

class MyFirebaseMessagingService : FirebaseMessagingService() {
    override fun onNewToken(token: String) {
        Log.d("FCM Log", "Refreshed token: $token")
    }

    override fun onMessageReceived(remoteMessage: RemoteMessage) {
        // TODO(developer): Handle FCM messages here.
        // Not getting messages here? See why this may be: https://goo.gl/39bRNJ
        Log.d("FCM LOG", "From: ${remoteMessage.from}")

        // Check if message contains a data payload.
        if (remoteMessage.data.isNotEmpty()) {
            Log.d("FCM LOG", "Message data payload: ${remoteMessage.data["type"]}")
        }

        // Check if message contains a notification payload.
        remoteMessage.notification?.let {
            Log.d("FCM LOG", "Message Notification Body: ${it.body}")
        }

        // Also if you intend on generating your own notifications as a result of a received FCM
        // message, here is where that should be initiated. See sendNotification method below.
    }
}

개인 공기계를 프로젝트에 등록하고, 이 앱을 설치해서 이런 식으로 로그를 찍으며 확인해봅시다
 
끝!