🔔 Android FCM 적용기 2탄 : FCM + Retrofit

들어가기 전에

안녕하세요!

1탄에 이어 본격적인 FCM과 Retrofit 과 함께 돌아온 Mandy입니다 😀

지난 1탄에서는 Android의 Notification에 대해서 알아보았는데요!

오늘은 더 나아가 FCM과 Retrofit을 이용하여 세탁 완료 알림 기능을 마무리 해보려고 해요. 지난 1탄보다 조금 더 많은 내용을 다룰 예정이라서 차근차근 따라와주세요 ㅎㅎ

 

결과 미리보기

본격적인 개발에 앞서서 구현한 결과를 먼저 보도록 할게요!

[ 영상 첨부하기] 

 

이제 시작해봅시다 !! 

FCM 이해하기

FCM은 모바일 앱 및 웹 앱에서 실시간 메시지를 전송할 수 있는 기능이에요. 서버에서 클라이언트 디바이스로 푸시 알림을 보낼 수 있으며 다양한 알림 유형을 구현할 수 있어요!

 

FCM 흐름 정리

1️⃣ FCM에서 메시지를 수신하도록 기기 등록

• 클라이언트 앱이 메시지를 수신하도록 등록하여 우리의 휴대전화 기기을 고유하게 식별하는 등록 토큰을 받아요.

2️⃣ 메시지 전송 및 수신

• 메시지는 FCM console 환경이나 신뢰할 수 있는 환경(HTTP 등)에서 작성되며 메시지 요청이 FCM 백엔드로 전송되어요
• FCM 백엔드(서버)는 메시지 요청을 수신하고 메시지 ID와 기타 메타 데이터를 생성하여 안드로이드 전송 계층 (Android transport layer)로 보내요.
• 기기에서 클라이언트앱이 메시지 또는 알림을 수신해요.

 FCM 백엔드는 서버와 동일한 것인가요?

네 ! FCM 서버란 firebase cloud messaging을 지원하고 메시지를 처리하는 서버 시스템을 말해요! 이 서버를 통해 클라이언트앱과 상호작용하여 메시지를 전송하고 받을 수 있어요.

 

FCM 서버의 역할

1️⃣메시지 전송 :

클라이언트앱에 푸시 알림 및 데이터 메시지를 전송해요. 이를 통해 서버에서 클라이언트 디바이스로 메시지를 효과적으로 전달할 수 있어요,

2️⃣디바이스 관리

FCM 서버는 각 디바이스에 고유한 식별자인 FCM 토큰을 하는데요. 이 토큰을 사용해 서버는 특정 디바이스에 메시지를 전송할 수 있어요!

우리 플젝에서는 Retrofit 라이브러리를 사용하여 FCM 서버에 HTTP 요청을 보내는 방식을 이용했어요!

이를 위해 FCM 서버에 푸시알림을 보내기 위한 Retrofit 인터페이스인 NotiAPI를 정의해주었어요.

 

목표

• 유저의 토큰 정보를 받아와서
• Firebase 서버로 보내라고 명령하고
• Firebase 서버에서 앱으로 메시지를 보내주고
• 앱에서는 메시지를 받아서 → 메시지 수신 부분
• 앱에서는 알람을 띄워줌 → 메시지 수신 부분에서 notification 처리

우리의 목표는 위와 같아요💪이를 위해 기본 설정을 해줄게요.

 

앱 매니페스트 수정

FirebaseMessagingService 란 

FCM을 사용하여 디바이스로 메시지를 수신하고 처리하는 서비스 를 말해요.

이 서비스를 확장하여 FCM 메시지를 처리하고 포그라운드 및 백그라운드에서 알림을 수신할 수 있어요.

이를 위해 FirebaseMessagingService를 확장하는 서비스를 매니페스트 파일에 추가해줘요.

 

서비스란?

안드로이드에서 Service는 백그라운드에서 실행되는 작업을 수행하는 컴포넌트를 말해요!

• 백그라운드 작업
  • 예를 들어 음악앱이 화면에 표시되지 않아도 음악 재생이 계속 되는 것을 생각하면 되어요!
• 계속된 실행
  • 예를 들어 위치 추적 서비스는 사용자가 어떤 앱을 사용하든 백그라운드에서 계속해서 위치를 추적해요!
• 다른 컴포넌트와 통신
  • 서비스는 액티비티, 브로드캐스트 수신자 등과 통신할 수 있어요. 이를 통해 앱의 여러 부분과 데이터를 주고 받을 수 있답니다. 예를 들어 앱에서 음악을 재생하는 서비스는 사용자가 앱의 액티비티에서 음악을 일시정지하거나 스킬할 때 이를 처리할 수 있어요.
• 생명 주기 관리
  • 서비스는 액티비티와는 다른 자체 생명 주기를 가지고 있어요.

<service
            android:name=".fcm.FirebaseCloudMessagingService"
            android:exported="false"
            android:permission="TODO">
            <intent-filter>
                <action android:name="com.google.firebase.MESSAGING_EVENT" />
            </intent-filter>
        </service>

 

🚨주의사항

android:name에는 **FirebaseMessagingService** 를 상속받은 클래스명을 적어주어야해요.

다른 액티비티 클래스나 다른 클래스명을 적을 경우 제대로 작동하지 않으니 주의해주세요!

이것때문에 고생한 기억이.. 😁

 

유저의 토큰 정보 가져오기

이제 앞선 언급했던 토큰 정보를 가져올게요!

토큰은 디바이스를 고유하게 식별해주고, 서버에서 메시지를 특정 디바이스로 전송될 때 사용돼요.

FirebaseMessaging.getInstance().token.addOnCompleteListener { task ->
                if (!task.isSuccessful) {
                    Log.w(TAG, "Fetching FCM registration token failed", task.exception)
                    return@addOnCompleteListener
                }

                // Get new FCM registration token
                val token = task.result

                // Log
                Log.d("token보기", token)
         }

 

유저의 토큰 정보를 가져오기 위해서 MainActivity에서 위 코드를 추가해주었어요!

이를 통해 로그로서 현재의 token을 알 수 있어요

하지만 추후 스플래시 화면을 추가하고, 스플래시 화면이 떠있는 동안 token 정보를 가져오도록 로직을 이동할 예정이에요!

 

아래의 로그를 보면 토큰이 잘 가져와진 것을 확인할 수 있어요!

 

💌Firebase Console에서 테스트 메시지 보내기

 

FCM 시작을 위해 앱이 백그라운드 상태일 때 콘솔 환경에서 개발 기기로 테스트 알림 메시지를 전송해보는 실습은 아래 링크를 참고해주세요!

백그라운드 앱에 테스트 메시지 보내기  |  Firebase 클라우드 메시징

백그라운드 앱에 테스트 메시지 보내기  |  Firebase 클라우드 메시징

 

기본 설정

• 프로젝트 수준의 Gradle 파일에서 dependencies 내부에 아래 코드를 추가해줍니다.

classpath 'com.google.gms:google-services:4.3.15'

• 모듈(앱 수준) Gradle 파일에 아래의 코드를 추가해주세요

dependencies {
    // Import the BoM for the Firebase platform
    implementation platform('com.google.firebase:firebase-bom:32.1.0')

    // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries
    // When using the BoM, you don't specify versions in Firebase library dependencies
    implementation 'com.google.firebase:firebase-messaging-ktx'
    implementation 'com.google.firebase:firebase-analytics-ktx'
}

 

 

등록 토큰

특정 기기로 메시지를 보내기 위해서는 토큰이라는 것을 알아야한다고 했었죠?

콘솔환경에서 이 때 가져온 토큰을 입력하여 테스트를 진행할 수 있어요.

 

앞서 매니페스트 파일에서 서비스로 등록해준 클래스 파일을 열어주세요.

class FirebaseCloudMessagingService :FirebaseMessagingService()

처럼 FirebaseMessagingService를 확장하고 onNewToken 메서드를 재정의해줄거예요.

 

override fun onNewToken(token: String) {
        super.onNewToken(token)
    }

 

 

➕ 등록 토큰이 변경되는 경우

• 앱이 새 기기에 복원되는 경우
• 사용자가 앱을 제거 / 재설치하는 경우
• 사용자가 앱 데이터를 지우는 경우

---

💌메시지 받기

메시지를 받으려면 FirebaseMessagingService클래스를 상속받아 onMessageReceived 메소드를 재정의하여 처리할 수 있어요.

Firebase 서버에서 수신된 RemoteMessage 객체를 기준으로 작업을 수행하고 메시지 데이터를 가져올 수 있어요

 

아래와 같이 파이어베이스 서버에서 보내오는 RemoteMessage를 받아 Log로 찍어보면 확인해보았어요!

 

// message.data를 사용한 코드
val title= message.data["title"].toString()
        val body = message.data["content"].toString()

        Log.d("Cloud",message.data.toString())

 

//message.notification를 사용한 코드 
if (message.notification != null) {
            Log.e("CloudMessage", "Notification ${message.notification}")
            Log.e("CloudMessage", "Notification Title  ${message.notification!!.title}")
            Log.e("CloudMessage", "Notification Body ${message.notification!!.body}")

 

위 코드의 결과로 아래처럼 로그를 통해 확인해볼 수 있어요.

     첫 번째 코드의 결과는 Cloud 태그로 확인할 수 있어요.

     두 번째 코드의 결과는 CloudMessage 태그로 확인할 수 있어요.

 

여기서 왜 CloudMessage태그에는 null이 뜨고 있을까요?

 

message.notification과 message.data는 무슨 차이가 있을까요?

FCM에서 메시지를 전달할 때 사용되는 두 가지 주요 유형의 페이로드를 말해요.

• message.notification

message.notification는 notification만 보내는 메시지로 우리가 firebase console에서 Cloud Message를 보내는 경우에 해당해요

위처럼 콘솔환경에서 토큰을 이용해 제 기기로 테스트 메시지를 전송해보았는데요. 아래의 로그를 보면 알 수 있듯이 message.notification을 통해 전달되고 있음을 알 수 있어요.

 

message.data

message.data 페이로드는 개발자가 정의한 데이터를 전송할 때 사용해요.

클라이언트 앱에서 수동으로 처리해주어야해요.

다시 말해  포그라운드 또는 백그라운드에서 메시지를 수신하고 데이터를 처리할 때 onMessageReceived 메서드를 사용하여 직접 구현해주어야해요.

 

제가 구현한 message.data의 형태는 아래의 데이터클래스를 따르고 있어요,

data class NotiModel(
    val title:String="",
    val content:String=""
)

 

그래서 로그를 살펴보면 정의해준 title과 content 형태를 따르고 있음을 확인할 수 있어요.

 

저는 onMessageReceived 메서드 안에서

1️⃣ 콘솔에서 보내온 메시지를 확인하기 위해 message.notification를 Log로 확인하는 코드

2️⃣제가 정의한 데이터를 전송하기 위한 message.data 코드

3️⃣이전 챕터에서 이야기했던 알림 채널과 notification을 생성하는 코드를 구현해주었어요.

 

🌊전체 흐름 정리

FCM 기능을 구현하는 목적에 대해 기억하시나요? 세탁이 완료되었을 때 사용자의 기기에 알림을 주기 위함이었어요.

따라서 저는 세탁이 완료되었을 때 푸시 알림을 보내기 위해 세탁이 완료되면 아래의 순서로 코드를 구성했어요.

 

 

1️⃣NotiModel 클래스 객체 생성

2️⃣PushNotification 클래스 객체 생성

3️⃣ testPush 함수 실행

4️⃣ RetrofitInstance를 통해 FCM 서버와 통신

 

코드를 자세히 살펴볼게요!

 

0️⃣ WasherScreen

val notiModel = NotiModel("${washer.washerId}번 세탁이 완료되었어요!","\uD83D\uDE0A 세탁물을 찾으러와주세요 ")
// TODO: 토큰 저장 후 해당 토큰을 넣어주는 로직 추가 필요
                
val pushModel = PushNotification(notiModel)
               
testPush(pushModel)

 

• NotiModel 객체인 notiModel을 만들어줘요.
• PushNotification 메소드의 파라미터로 이 notiModel 을 넘겨줘요.

1️⃣NotiModel

data class NotiModel(
    val title:String="",
    val content:String=""
)

 

NotiModel은 위에서 살펴면 message.data 형태의 페이로드, 즉 데이터 페이로드를 구성하기 위한 데이터 클래스예요.

• title은 알림의 제목을, content는 알림의 내용을 나타내요.

2️⃣PushNotification

class PushNotification(
    val data : NotiModel,
    val to: String
)

 

PushNotification는 FCM 메시지를 보내기 위한 전체 메시지 구조를 정의하는 클래스예요.

• data는 NotiModel 객체
• to는 FCM에서 사용자 기기를 식별하는 token값을 넘겨줘요

3️⃣testPush 함수

private fun testPush(notification:PushNotification)= CoroutineScope(Dispatchers.IO).launch {

    try {
        val response = RetrofitInstance.api.postNotification(notification)
        if(response.isSuccessful) {
            Log.d("testPush성공","레트로핏")

        }
        else {
            Log.e("실패","${response.errorBody()?.string()}")
            Log.e("실패","${response.code()}")
            Log.e("실패","${response.headers()}")


        }
    }
    catch (e:Exception){
        e.printStackTrace()
    }

}

 

testPush 함수는 RetrofitInstance 생성하여 retrofit을 통해 FCM 메시지를 서버로 보내는 비동기 함수예요.

여기서 Retrofit은 안드로이드에서 서버와 통신하기 위한 라이브러리를 말해요. 아래 코드 설명은 전체 흐름을 이해한 후에 보는 것을 추천드려요!

 

코드 설명

CoroutineScope(Dispatchers.IO).launch { ... }

• CoroutineScope를 사용하여 비동기작업을 처리해요.
• Dispatchers.IO 는 I/O작업을 수행하기 적합한 디스패처로 네트워크 작업과 같은 I/O중심의 작업에 사용되어요.
  • Dispatchers란 ?
  코루틴에서 어떤 스레드나 스레드풀에서 코드 블록을 실행하는 역할을 해요.
• 코루틴에 대해서는 다음 포스팅에서 더 자세히 알려드릴게요!
• launch는 비동기 코드 블록을 실행하며, 작업이 완료되기 전에 다음 코드로 진행되지 않아요.
• val response = RetrofitInstance.api.postNotification(notification)
  • postNotification은 Retrofit에 정의된 API 인터페이스 메서드로 서버에 POST요청을 수행해요.
  • 서버의 응답은 response에 저장돼요.

4️⃣RetrofitInstance

class RetrofitInstance {
    companion object {
        private val retrofit by lazy {

            Retrofit.Builder()
                .baseUrl(BASE_URL)
                .addConverterFactory(GsonConverterFactory.create())
                .build()
        }
        val api = retrofit.create(NotiAPI::class.java)
    }
}

 

이 클래스는 Retrofit을 이용하여 서버 통신을 위한 인스턴스를 제공하는 클래스예요.

• 코드 설명

1️⃣ companion object 를 사용하여 싱글톤 패턴으로 Retrofit 인스턴스를 관리해요. 이는 통해 앱 전체에서 하나의 Retrofit 인스턴스만을 사용할 수 있어요.

 

💗 lazy란?

해당 변수가 처음으로 사용될 때까지 초기화를 지연시킬 수 있어요

필요한 시점에 변수를 초기화할 수 있어 자원을효율적으로 관리할 수 있답니다.

 

2️⃣retrofit 변수

Retrofit 빌더 패턴을 사용하여 생성된 Retrofit 인스턴스를 저장하는 변수예요.

addConverterFactory 를 통해 Gson 변환기를 추가하여 JSON 데이터를 Kotlin 객체로 변환했어요.

build( ) 를 통해 설정이 완료된 Retrofit 인스턴스를 생성해주었어요.

 

3️⃣ api 변수

api 변수에는 생성된 retrofit 인터페이스를 저장했어요

retrofit.create(NotiAPI::class.java) 를 호출하여 Retrofit에서 생성된 인스턴스로부터 NotiAPI 구현체를 생성해요.

retrofit.create()를 통해 Retrofit에 정의된 인터페이스를 구현하는 객체를 생성했어요.

이 때 넘겨주는 NotiAPI는 Retrofit을 사용하여 FCM 서버와 통신하기 위한 API 인터페이스를 정의한 것이예요.

FCM 서버와 통신할 때 사용되는 엔드포인트 및 메서드를 명시해줘요

 

5️⃣ NotiAPI 인터페이스

interface NotiAPI {
// 1 
	   @Headers("Authorization: key=$SERVER_KEY", "Content-Type:$CONTENT_TYPE")
// 2    
		 @POST("/fcm/send")
// 3     
		suspend fun postNotification(@Body notification: PushNotification): Response<ResponseBody>


}

 

이제 마지막으로 NotiAPI 인터페이스에 대해 알아볼게요.

이 인터페이스는 FCM 서버에 푸시 알림을 전송하기 위한 HTTP 요청을 정의하는 인터페이스입니다.

 

코드 설명

1️⃣@Header어노테이션

• HTTP 요청 헤더 설정
• "Authorization: key=$SERVER_KEY"
  • FCM 서버와 통신하기 위한 서버키를 헤더에 추가
• "Content-Type:$CONTENT_TYPE"
  • HTTP 요청의 컨텐츠 타입 설정

2️⃣@POST("/fcm/send")

• POST 메서드를 사용하여 fcm/send 엔드포인트에 요청을 전송해요
  • FCM에서는 푸시알림을 전송합니다.

❗ 그냥 fcm/send 라고 해도 동일하게 동작해요.

3️⃣postNotification 메소드

• 푸시 알림을 전송하기 위한 비동기함수예요
  • suspend 키워드는 코루틴에서 호출될 수 있음을 의미해요.

suspend fun postNotification(@Body notification: PushNotification): Response<ResponseBody>

• @Body notification : HTTP 요청의 본문에 해당하며, PushNotification 객체를 전송해요.
  • 이 객체는 푸시 알림을 담고 있어요
• Response<ResponseBody>
  • Response는 서버에서 받은 HTTP 응답을 나타내는 클래스예요
    • Responces<T>에서 T는 서버가 응답 본문으로 전송한 데이터의 형태를 말해요.
    • Response에는 HTTP 상태 코드, 응답 헤더, 본문 등이 포함되어있어요.
  • ResponseBody는 서버로부터 받은 응답의 본문전체를 나타내는 클래스예요.
    • Response 클래스의 body( ) 메서드를 호출하면 ResponseBody 객체를 얻을 수 있어요.

정리하기

마무리하며

이렇게 세탁 완료 알림 기능을 FCM으로 구현하는 여정에 대한 이야기를 해보았어요.

 

저도 FCM을 실제로 구현하기 전에는 서버를 직접 구현해야하는건지 어떻게 통신을 하고 어떤 데이터를 보내야하는 건인지 이해하기가 어려웠어요. 이렇게 실제로 구현해보며 감을 잡을 수 있었답니다 😊

조금이나마 글을 읽는 여러분들이 FCM을 이해하는데 도움이 되었으면 좋겠네요 ㅎㅎ

 

질문은 언제든  댓글을 통해 남겨주세요.

FCM 개발 여정은 여기서 마무리하고 다음 포스팅으로 찾아올게요! 🙇

 

그럼 이만 총총 🐾

 

 

 

 

함께 보면 좋을 사이트

https://firebase.google.com/docs/cloud-messaging/android/client?hl=ko

Android에서 Firebase 클라우드 메시징 클라이언트 앱 설정