¶ MPush for 모피어스 MADP
모피어스 MADP에 Push 플러그인을 적용하는 방법
¶ 1. plugin 다운로드
Note MADP용 플러그인은 IDE의 M-SDK Manager를 통해 다운로드 및 프로젝트에 적용
샘플 프로젝트는 아래 링크를 통해, 다운로드 받을 수 있습니다.
¶ 2. 라이브러리 및 설정 파일
¶ 2.1. 라이브러리
¶ * M-SDK Manager > Plugin 라이브러리
- 플러그인 Push.r4 라이브러리 – 5.1 버전의 UPNS/FCM Push 를 활용할 수 있는 MADP용 라이브러리
- 플러그인 Push.r5 라이브러리 – 5.2 버전의 UPNS/FCM Push 를 활용할 수 있는 MADP용 라이브러리
¶ 2.2. API 테스트 샘플 UI
- madp_plugin/www/push.html – Push API 정보가 담긴 Push 테스트용 샘플 파일
¶ 3. 적용 순서
¶ 3.1 Android
¶ 3.1.1. MADP 프로젝트에 IDE에서 push.r4 또는 push.r5 라이브러리를 다운로드 및 적용합니다.
¶ 3.1.2. [FCM 사용 시] 프로젝트를 Android Studio로 열어 설정파일을 적용합니다.
- [프로젝트]/android/app/google-services.json
¶ 3.1.3. [FCM 사용 시] app 레벨의 build.gradle에서 아래 내용을 추가합니다.
buildscript{
...
dependencies {
classpath 'com.google.gms:google-services:4.3.15' //추가
}
}
...
apply plugin: 'com.google.gms.google-services' //반드시, script 맨 하단에 작성
Duplicate class com.google.gson.. 이슈로 build 실패 시 implementation fileTree를 아래와 같이 수정(excludes로 해당 라이브러리 참조 제거) implementation fileTree(dir: 'mcoreLibs', excludes: ['android-support-v4.jar','gson.jar', 'androidx.exifinterface-exifinterface-1.3.2.jar'], include: ['.jar','.aar'])
¶ 3.1.4. API 샘플로 push.html파일을 참고하여 테스트를 진행해보실수 있습니다.
¶ 3.1.5. 라이브러리 내에서 제공하는 Notification을 커스텀하여 사용하실 수 있습니다.
- basic notification을 custom 하는 경우 : FcmCustomNoti.java 적용 후 NotificationBuilder 참고하여 FcmCustomNoti.java에서 추가 옵션을 설정하실 수 있습니다.
- Launcher 액티비티(Startup.java)에서 아래와 같이 항목 적용
¶ Java 프로젝트 (Default)
@Override
public void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
PushManager.getInstance().setCustomInstance(this, FcmCustomNoti.class);
commLibHandle.processAppInit(this);
}
¶ kotlin 프로젝트
override fun onPostCreate(savedInstanceState: Bundle?) {
super.onPostCreate(savedInstanceState)
PushManager.getInstance().setCustomInstance(this, FcmCustomNoti::class.java)
commLibHandle.processAppInit(this)
}
예시로 제공한 FcmCustomNoti.java 파일을 적용했을 경우를 기반으로 작성되었으며 해당 파일명은 변경이 가능하며, 변경된 클래스로 설정을 변경할 수 있습니다.
Notification 옵션 항목 및 옵션 적용방법 예시
- NotificationBuilder class
- basic notification을 사용하는 경우 알림 아이콘은 Application 아이콘으로 지정되어 있으며, icon을 변경해야하는 경우 NotificationBuilder를 참고하여 style을 수정해서 전달하는 방법으로 사용하실 수 있습니다.
¶ 3.1.6. 라이브러리 내에서 제공하는 Notification을 이용하지 않고 수신 후의 전체 Notification 처리를 커스텀 하는 경우
발송한 메시지의 페이로드 데이터를 수신 한 이후에 별도로 처리해야 하는 영역으로, 아래 첨부파일을 참고하여 적용하실 수 있습니다.
압축 파일 내의 android 폴더 > FcmNotifyHelper, MessageArrivedReceiver, PushMessageManager 파일 참고
- AndroidManifest.xml에서 아래와 같이 receiver 적용 (BroadCastReceiver 클래스를 상속받는 receiver클래스)
<application>
<receiver
android:name="[fulepath].MessageArrivedReceiver"
android:exported="false">
<intent-filter>
<!--FCM 사용시 intent-filter-->
<action android:name="${applicationId}.GCM_MESSAGE_ARRIVED" />
<!--------------->
<!--UPNS 사용시 intent-filter -->
<action android:name="${applicationId}.UPNS_MESSAGE_ARRIVED" />
<!--------------->
<!--UPNS+FCM 사용시 (아래 intent-filter 모두적용)-->
<action android:name="${applicationId}.GCM_MESSAGE_ARRIVED" />
<action android:name="${applicationId}.UPNS_MESSAGE_ARRIVED" />
<!--------------->
</intent-filter>
</receiver>
</application>
- mpush 이외의 FCM을 별도로 사용하는 프로젝트의 경우 아래 주소를 참고하시어 CustomMessagingService를 적용하실 수 있습니다. https://developer.uracle.co.kr/faq/?mod=document&pageid=1&keyword=CustomMessagingService&uid=2704
¶ 3.2 iOS
¶ 3.2.1. MADP 프로젝트에 IDE에서 push.r4 또는 push.r5 플러그인을 다운로드 및 적용합니다.
¶ 3.2.2. XCode에서 APNS 사용을 위해 Capability를 설정합니다.
¶ 3.2.3. MPAppDelegate를 활용한 적용 방법 ( MCore.2.1.8.44 이상)
-
AppDelegate가 MPAppDelegate를 상속 받았을 경우에 메서드 Swizzling을 사용하여 Push 라이브러리 초기화가 이루어집니다.
-
Push 라이브러리 초기화시 라이브러리내에 MPushReceiver가 PushManagerDelegate로 지정이 됩니다.
-
MPushReceiver에서 메시지 수신 처리시 스크립트 function oniOSReceiveNotification(ns) 로 메시지가 전달됩니다.
-> 수동으로 라이브러리 초기화를 진행하거나 수신처리를 변경하고자 할 경우에는 아래 코드를 참고하세요
// AppDelegate.m 파일
- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
//수동으로 초기화를 할 경우
//모피어스 라이브러리 초기화
window = [[UIWindow alloc] initWithFrame:[[UIScreen mainScreen] bounds]];
navigationController = [MAppDelegate initialViewControllerWithLaunchOptions:launchOptions];
[window setBackgroundColor:[UIColor blackColor]];
[window setRootViewController:navigationController];
[window makeKeyAndVisible];
//Push 라이브러리 초기화
[[PushManager defaultManager] application:application didFinishLaunchingWithOptions:launchOptions];
//PushManagerDelegate 지정 ( PushReceiver )
[[PushManager defaultManager] initilaizeWithDelegate:[[PushReceiver alloc] init]];
//Swizzling을 사용하여 초기화 경우
//return [super application:application didFinishLaunchingWithOptions:launchOptions];
}
- 메시지 수신 이벤트 처리 변경시 PushReceiver 샘플 파일 : PushReceiver.zip
¶ 3.2.4. API 테스트 샘플을 위한 push.html 파일을 참고하여 테스트를 진행해보실수 있습니다.
¶ 3.2.5. iOS 메시지 수신 흐름도
flowchart TD
AppDelegate --수신된 메시지를 PushManager로 전달--> PushManager
PushManager --수신확인 전문을 서버로 전송--> PushManager
PushManager --PushManagerDeleage로 이벤트 전달-->PushReceiver
PushReceiver -- oniOSReceiveNotification script 콜백 호출 -->화면_Script
¶ 3.2.6. iOS10 이상 버전에서 수신확인, 이미지 Push처리
- iOS10 이상 버전에서는 Notification Service Extension을 사용하여 앱이 종료된 상태에서도 수신확인 처리를 할수 있습니다.
- Notification Service Extension는 iOS에서 notification을 처리하기 전에 알림 내용을 변경 처리 할 수 있도록 제공되는 서비스 앱 확장 기능입니다.
- MPush는 Notification Service Extension을 처리할수 있도록 기본적으로 Mutable-contents를 1로 설정하여 발송됩니다.
¶ 3.2.7. iOS 메시지 payload 샘플
{
"aps": {
"alert": {
"body":"body"
"title":"title"
},
"badge": 1,
"mutable-content": 1,
"sound": "alert.aif"
},
"mps": {
"cuid":"testCUID"
"ext": "8||https://umsapi.morpheus.kr/data/nas/image.png|",
"appid": "com.uracle.push.test",
"psid": "eddf0fb943b8b13e4ee9b3268e7854b59a43f2c63d99f1a405b0a2383cf55718"
"pushkey": "fa0ef0f129cb4cd1addbdb2984fb655d042eb74d"
"seqno": "1247292",
"sender": "admin",
"senddate": "2024022309",
"db_in": "Y"
}
}
¶ 4. MPush API
푸쉬 관련 API는 아래 링크를 참고 바랍니다.