FCM 푸시 알림 요청 오픈 소스 개발 및 공개

Jason은 React Native 모바일 앱을 개발하는 중 푸시 알림 기능이 필요했다.

그래서 처음에는 예전에 만들어 보았던 GCM, APNS과 직접 소통하는 푸시 전송 시스템을 개량하여 도입하려 했었다. 그러한 가운데 이미 Firebase를 사용하고 있다는 점을 상기하여 Firebase의 Cloud Messaging을 활용하는 방향으로 생각을 바꾸게 되었다.

Firebase은 취미 단계에서는 매우 유용한데 무엇보다 무료 정책이 다른 클라우드 서비스에 비해 관대한 편이기 때문이다.

푸시 알림 시스템을 직접 구축해본 엔지니어들은 익히 알고 있겠지만 GCM, APNS 스펙이 다르고 대량 발송을 지원해야 한다는 점을 포함하면 직접 개발을 하는데는 많은 노력이 든다.

Firebase Cloud Messaging, 축약하여 FCM은 iOS, Android, Chrome 플랫폼에 공통적으로 푸시 알림을 보낼 수 있는 Google의 서버이다. GCM의 새로운 버전으로 플랫폼 구별, 대량 전송에 대한 특별한 구현없이 필요한 값만 실어서 FCM으로 전송하면 지정한 모바일 앱에서 푸시 알림을 받을 수 있다.

FCM에 푸시 알림 요청하는 방식은 여기에 나와있듯이 HTTP POST 요청을 하면 된다. Jason은 모두가 쉽게 이용할 수 있도록 이 HTTP POST 요청을 별도의 구현없이 메소드 실행 하나로 발송할 수 있도록 Java Client Library를 만들었다. 모든 구현의 네이밍, 속성들은 여기에 나와있는 것을 맞추었다.

GitHub: fcm-sender-java

사용법은 다음과 같다.

DownstreamHttpNotification downstreamHttpNotificationAndroid =
  DownstreamHttpNotificationAndroid.builder()
    .setTitle("Hello")
    .setBody("This is test notification.")
    .build();

DownstreamHttpMessages downstreamHttpMessages =
  new DownstreamHttpMessages(registrationIdForTest, null)
    .setContentAvailable(true)
    .setNotification(downstreamHttpNotificationAndroid)
    .setData(this.getDownstreamHttpData())
    .setDryRun(false);

FcmSender fcmSender = new FcmSender("Your Server Key");
DownstreamHttpResponse downstreamHttpResponse = fcmSender.sendNotification(downstreamHttpMessages);

FCM에 전송하는 JSON Payload를 오브젝트로 만든 것이 DownstreamHttpMessages 이다. DownstreamHttpMessages은 적어도 하나의 registrationId를 요구하는데(소위말해 고유 푸시 아이디) 하나만 보낼 때에는 다음과 같이 하면 되고.

new DownstreamHttpMessages("{Specific Registration Id}", null)

여러개를 보내야 한다면

new DownstreamHttpMessages(null, List.of({Registration Id 1}, {Registration Id 2}, {Registration Id 3}))

와 같이 보낼 수 있다. 보다시피 적어도 하나의 registrationId를 보내야 한다.

JSON Payload는 크게 notification, data로 나눌 수 있다.

notification은 Android, iOS 필수, 선택 속성이 다른 부분이 있다. 그래서 DownsteamHttpNotification이라는 인터페이스로 묶고 이를 구현한 DownstreamHttpNotificationImpl에 플랫폼 공통 속성을 정의하고 DownstreamHttpNotificationAndroid, DownstreamHttpNotificationIos를 별도로 만들어 상속을 받고 각자 다른 속성을 정의하도록 하였다.

data는 사용자 정의 공간이다. 따라서 deep-link, user infor. 등 앱에 전달하고자 하는 데이터를 만들어 넣으면 된다. 하지만 메소드에서는 공통 타입으로 받아야 하기 때문에 DownstreamHttpData는 인터페이스로 존재한다.

public class DownstreamHttpDataImpl implements DownstreamHttpData { 
  private String deepLink;
  private String uid;

  public DownstreamHttpDataImpl(String deepLink, String uid) {    
    this.deepLink = deepLink;    
    this.uid = uid;  
  }

...

위와 같은 구현체에 원하는 정보를 담아서 실어주면 된다.

FcmSender는 실제 발송을 담당하는 클래스로서 인스턴스 생성 시 Server Key를 요구한다. 해당 키는 다음과 같이 Firebase의 Project Setting에서 찾을 수 있다.

Jason은 이 라이브러리를 사용하는 대상이 스프링 프레임워크였기 때문에 FcmSender를 Bean으로 등록할 생각을 하고 싱글톤으로 구현하지 않았다. 계속 인스턴스를 생성할 필요가 없기 때문에 DI를 이용하지 않는 다른 상황에서는 필요 시 싱글톤으로 만들어 사용하면 된다.

모든 조건을 맞추어 전송을 하면 DownstreamHttpResponse에 맞게 응답을 얻을 수 있다. 전송이 성공했는지, Registration Id가 갱신되어 있는지 등 정보를 알 수 있다.

Jfrog의 Bintray를 이용하여 jCenter 저장소에 올렸기 때문에 maven, gradle로 추가하여 사용할 수 있다.

<dependency>
  <groupId>com.illicis</groupId>
  <artifactId>fcm-sender-java</artifactId>
  <version>0.0.1</version>
</dependency>

compile 'com.illicis:fcm-sender-java:0.0.1'

그동안은 혼자 만들어 혼자 썼는데 공개 단계까지 진입하려니 피곤한 일이 많았다. 아무쪼록 오픈 소스 생태계에 작은 도움이 되기를 바란다.