안녕하세요
오랜만에 글을 작성하네요
구글 Firebase Admin sdk 를 사용한 FCM 발송에 대해 간단하게 다루려고합니다.
개발 환경 : java 11 , Spring Boot 2.7.x
소스 내부에 주석으로 참고 라고 남겨둔 부분은 참고하시면 아마 도움이 되실 것 같습니다
소스 파일 우선 첨부합니다
package fcm.firebase;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.firebase.FirebaseApp;
import com.google.firebase.FirebaseOptions;
import com.google.firebase.messaging.*;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;
import static org.springframework.util.StringUtils.hasText;
/*
@Author : 전남혁 ( all_step@naver.com )
@Description : FCM 푸시 알림
@Created : 2023.05.24
@Version : 1.0.0
*/
@Slf4j
@Configuration
@RequiredArgsConstructor
public class Fcm {
/* ========================================= GOOGLE FCM =================================================
사용 라이브러리 : implementation 'com.google.firebase:firebase-admin:9.1.1' // Firebase Admin SDK
* 1. firebase console 접속
* 2. 프로젝트 생성
* 3. 프로젝트 설정 -> 서비스 계정 -> 새 비공개 키 생성 -> json 파일 다운로드 ( fcm.key.location 에 경로 저장 )
* 4. 프로젝트 설정 -> 클라우드 메시징 -> 서버 키 복사 ( 현재 미사용 )
* 참고 : MulticastMessage 는 한번에 최대 500명에게 전송 가능
* 참고 : 다중 전송의 BatchResponse 는 아래와 같이 사용
int getFailureCount() : 실패한 메세지 수
List<SendResponse> getResponses() : 전송 결과
int getSuccessCount() : 성공한 메세지 수
* 참고 : 링크 관련
앱은 링크를 별첨 할수 없음 (https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=ko#Message.FIELDS.data)
네이티브 앱에선 deep link 관련 컨트롤이 가능.. 하이브리드 앱에선 불가
( 네이티브 앱 추가 참고 : https://firebase.google.com/docs/dynamic-links?hl=ko )
Chrome 에서 발송되는 web push 알림은 링크를 별첨 할수 있음
Message.builder()
.setNotification(Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(imageUrl)
.build())
.setToken(targetToken)
.setWebpushConfig(WebpushConfig.builder().putData("link","https://www.naver.com").build())
.build()
* 참고 : 이미지 관련
장치에 다운로드되어 알림에 표시될 이미지의 URL을 포함합니다.
JPEG, PNG, BMP는 모든 플랫폼에서 완벽하게 지원됩니다.
애니메이션 GIF 및 비디오는 iOS에서만 작동합니다.
WebP 및 HEIF는 플랫폼 및 플랫폼 버전에 따라 다양한 수준의 지원을 제공합니다.
Android는 1MB 이미지 크기 제한이 있습니다.
Firebase 저장소에서 이미지 호스팅에 대한 할당량 사용 및 영향/비용: https://firebase.google.com/pricing
*/
@Value("${fcm.key.location}")
private String fcmKeyLocation;
private final String fireBaseScope = "https://www.googleapis.com/auth/cloud-platform";
// ============================================ FIREBASE INIT =============================================
/* FCM 초기화 ( 필수 )
application.properties 에서 fcm.key.location 의 경로에 있는 json 파일을 읽어서 초기화
json 파일이 없으면 초기화 하지 않음
이미 초기화 되었을 경우 하지 않음
*/
public void init() {
Path path = Paths.get(fcmKeyLocation);
if (!Files.exists(path)) {
log.info("NOT FOUND FCM KEY FILE");
return;
}
Resource resource;
InputStream stringInputStream;
try {
resource = new InputStreamResource(Files.newInputStream(path));
stringInputStream = new ByteArrayInputStream(resource.getInputStream().readAllBytes());
} catch (IOException e) {
throw new RuntimeException("FCM KEY FILE IOException ",e);
}
if(resource == null || stringInputStream == null) {
log.info("NOT FOUND FCM KEY FILE");
throw new RuntimeException("FCM KEY FILE NOT FOUND");
}
try {
FirebaseOptions options = FirebaseOptions.builder()
.setCredentials(GoogleCredentials.fromStream(stringInputStream)
.createScoped(List.of(fireBaseScope))
)
.build();
log.info("Firebase initializeApp start : " + FirebaseApp.getApps().isEmpty());
if (FirebaseApp.getApps().isEmpty()) {
FirebaseApp.initializeApp(options);
log.info("Firebase application has been initialized");
}
} catch (Exception e) {
throw new RuntimeException("Firebase initializeApp error", e);
}
}
// ================================================================================================
// ================================== getAccessToken (현재 사용 X) ==================================
public String getAccessToken() {
GoogleCredentials googleCredentials;
try {
googleCredentials = GoogleCredentials
.fromStream(new ClassPathResource(fcmKeyLocation).getInputStream())
.createScoped(List.of(fireBaseScope));
} catch (IOException e) {
throw new RuntimeException("FCM KEY FILE IOException ",e);
}
if (googleCredentials == null) {
throw new RuntimeException("FCM KEY FILE NOT FOUND");
}
return googleCredentials.getAccessToken().getTokenValue();
}
// =================================================================================================
// =================================== FCM 단일건 메세지 객체 생성 ========================================
/* 단일건 메세지 객체 생성
@param targetToken : FCM 토큰
@param title : 제목
@param body : 내용
@param imageUrl : 이미지 URL
@return : Firebase Cloud Messaging 메세지 객체
*/
public Message setSingleMessage(String title, String body, String imageUrl, String targetToken) {
Message message;
if (hasText(imageUrl)) {
message = Message.builder()
.setNotification(Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(imageUrl)
.build())
.setToken(targetToken)
.build();
} else {
message = Message.builder()
.setNotification(Notification.builder()
.setTitle(title)
.setBody(body)
.build())
.setToken(targetToken)
.build();
}
return message;
}
// ===================================================================================================
// ================================= FCM 단일건 다중 전송 메세지 객체 생성 =====================================
/* 한번에 여러명에게 FCM 메세지 전송을 위한 객체 생성
@param targetToken : FCM 토큰 리스트
@param title : 제목
@param body : 내용
@param imageUrl : 이미지 URL
@return : 다중 FCM 메세지 객체
*/
public MulticastMessage setMulticastMessage(String title, String body, String imageUrl, List<String> registrationTokens) {
MulticastMessage multicastMessage;
if (hasText(imageUrl)) {
multicastMessage = MulticastMessage.builder()
.setNotification(Notification.builder()
.setTitle(title)
.setBody(body)
.setImage(imageUrl)
.build())
.addAllTokens(registrationTokens)
.build();
} else {
multicastMessage = MulticastMessage.builder()
.setNotification(Notification.builder()
.setTitle(title)
.setBody(body)
.build())
.addAllTokens(registrationTokens)
.build();
}
return multicastMessage;
}
// ===================================================================================================
// ====================================== FCM 단일건 메세지 전송 ==========================================
/* FCM 토큰으로 메시지 보내기
@param Message : FCM 메세지 객체
@return : FCM 응답
*/
public String sendSingleMessage(Message message) {
String response;
try {
response = FirebaseMessaging.getInstance().send(message);
} catch (Exception e) {
throw new RuntimeException("Firebase sendSingleMessage error", e);
}
return response;
}
// ===================================================================================================
// ====================================== FCM 여러종류의 메세지 전송 ==========================================
/* 메세지 여러번 보내기
@param List<Message> : FCM 메세지 객체
@return : FCM 응답 ( 객체 타입 )
*/
public BatchResponse sendListMessage(List<Message> messageList) {
BatchResponse response;
try {
response = FirebaseMessaging.getInstance().sendAll(messageList);
} catch (Exception e) {
throw new RuntimeException("Firebase sendListMessage error", e);
}
return response;
}
// ===================================================================================================
// ====================================== FCM 단일 메세지 다중 전송 ==========================================
/* 여러명에게 한번에 메세지 보내기
@param MulticastMessage : FCM 다중 메세지 객체
@return : FCM 응답 ( 객체 타입 )
*/
public BatchResponse sendMultiMessage(MulticastMessage multicastMessage) {
BatchResponse response;
try {
response = FirebaseMessaging.getInstance().sendMulticast(multicastMessage);
} catch (Exception e) {
throw new RuntimeException("Firebase sendMultiMessage error", e);
}
return response;
}
// ===================================================================================================
}
한명에게만 전송할땐 Message 타입을, 여러명에게 전송할떈 MulticastMessage 타입을 사용하여
메세지객체를 List로 담아 발송하면 여러번의 Http 전송이 일어나지만
MulticastMessage로 여러명에 발송하면, 한번의 Http 전송으로 대량 발송이 가능한점이 좋아 같이 쓰게 되었습니다
Fcm 전송시 List<Message> 타입으로 전송할땐 다른메세지를 한번에 만들어 전송할때 사용하기 좋아 보였습니다
예시 컨트롤러도 아래 첨부합니다
package fcm.push.controller;
import fcm.common.JSONResponse;
import fcm.member.dto.MemberCondition;
import fcm.member.dto.MemberListDto;
import fcm.member.service.MemberService;
import fcm.push.dto.AdminPushDetailDto;
import fcm.push.dto.AdminPushListDto;
import fcm.push.dto.PushCondition;
import fcm.push.dto.PushWriteDto;
import fcm.push.service.PushService;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.PageRequest;
import org.springframework.data.domain.Pageable;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.List;
import static org.springframework.util.StringUtils.hasText;
@Slf4j
@Controller
@RequiredArgsConstructor
public class PushController {
private final PushService pushService;
private final MemberService memberService;
@GetMapping("/admin/push/list")
public String pushList(@ModelAttribute("condition") PushCondition condition,
Model model) {
if(condition.getPage() < 1)
condition.setPage(1);
if(condition.getRowPerPage() == null)
condition.setRowPerPage(20);
Pageable pageable = PageRequest.of(condition.getPage() - 1, condition.getRowPerPage());
Page<AdminPushListDto> pushList = pushService.getAdminPushPage(condition, pageable);
model.addAttribute("pushList", pushList);
return "admin/member/push_list";
}
@GetMapping("/admin/push/write")
public String pushWrite(Model model) {
return "admin/member/push_write";
}
@GetMapping("/admin/push/member/list")
public String pushMemberList(@ModelAttribute("condition") MemberCondition condition,
Model model) {
List<MemberListDto> memberList = new ArrayList<>();
if(hasText(condition.getName())) {
memberList = memberService.getMemberPopupList(condition);
}
model.addAttribute("memberList", memberList);
return "admin/popup/member_search";
}
@PostMapping("/admin/push/save")
@ResponseBody
public JSONResponse<?> pushSave(@RequestBody PushWriteDto pushWriteDto) {
try {
pushService.savePush(pushWriteDto);
} catch (Exception e) {
log.error("푸시 발송에 실패하였습니다.", e);
return new JSONResponse<>(500, "푸시 발송에 실패하였습니다.", null);
}
return new JSONResponse<>(200, "푸시 발송에 성공하였습니다.", null);
}
@GetMapping("/admin/push/detail/{id}")
public String pushDetail(@PathVariable("id") Long id,
Model model) {
AdminPushDetailDto push = pushService.getAdminPushDetail(id);
model.addAttribute("dto", push);
return "admin/member/push_view";
}
@PostMapping("/admin/push/update")
@ResponseBody
public JSONResponse<?> pushUpdate(@RequestBody PushWriteDto pushWriteDto) {
try {
pushService.updatePush(pushWriteDto);
} catch (Exception e) {
log.error("푸시 발송에 실패하였습니다.", e);
return new JSONResponse<>(500, "푸시 발송에 실패하였습니다.", null);
}
return new JSONResponse<>(200, "푸시 발송에 성공하였습니다.", null);
}
}
사용시 참고하실 부분은 application.properties에 json 파일 경로 ( Fcm.java 참고 주석 ) 를 명확히 써주셔야 작동합니다.
질문이나 피드백 댓글로 남겨주시면 확인하고 답변 남기겠습니다.
https://github.com/wjsskagur/fcm_only
GitHub - wjsskagur/fcm_only: Google Firebase Admin SDK를 사용한 Spring Boot 백엔드에서 앱 푸쉬 알림 발송
Google Firebase Admin SDK를 사용한 Spring Boot 백엔드에서 앱 푸쉬 알림 발송 - GitHub - wjsskagur/fcm_only: Google Firebase Admin SDK를 사용한 Spring Boot 백엔드에서 앱 푸쉬 알림 발송
github.com
'Java > Java' 카테고리의 다른 글
| [ Java ] 파일 여러개를 zip으로 압축하여 다운로드 (0) | 2023.02.15 |
|---|---|
| [ Java ] HTML 페이지를 PDF로 변환하기 ( itextpdf 사용 ) (0) | 2023.02.13 |
