版本記錄
版本號 | 時(shí)間 |
---|---|
V1.0 | 2017.05.14 |
前言
前一篇已經(jīng)對極光推送產(chǎn)品架構(gòu)和服務(wù)進(jìn)行了介紹,這一篇?jiǎng)t只對ios客戶端的集成和使用等狀況進(jìn)行了說明舱禽。
1. 極光推送集成(一)
2. 極光推送集成(二)
iOS SDK 集成指南
一、SDK說明
適用版本
本文匹配的 SDK版本:r2.1.5 以后裸诽。
查看最近更新了解最新的SDK更新情況炮赦。
使用Xcode 6及以上版本可以使用新版Push SDK板驳,Xcode 5環(huán)境下需要運(yùn)行舊版本SDK(1.7.4)色瘩。
資源文件
包名為JPush-iOS-SDK-{版本號}
- lib文件夾:包含頭文件 JPUSHService.h伪窖,靜態(tài)庫文件jpush-ios-x.x.x.a,jcore-ios-x.x.x.a居兆,支持的iOS版本為 6.0 及以上版本覆山。(請注意:模擬器不支持APNs)
- pdf文件:集成指南
- demo文件夾:示例
二、創(chuàng)建應(yīng)用
- 在 JPush的管理Portal 上創(chuàng)建應(yīng)用并上傳APNs證書泥栖。如果對APNs證書不太了解 請參考: iOS 證書設(shè)置指南
- 創(chuàng)建成功后自動(dòng)生成 AppKey 用以標(biāo)識該應(yīng)用簇宽。
三、工程配置
導(dǎo)入SDK
選擇1:Cocoapods導(dǎo)入
通過Cocoapods下載地址:
pod 'JPush'
如果需要安裝指定版本則使用以下方式(以3.0.2版本為例):
pod 'JPush', '3.0.2'
選擇2:手動(dòng)導(dǎo)入
- 在極光官網(wǎng)下載最新SDK
- 將SDK包解壓吧享,在Xcode中選擇“Add files to 'Your project name'...”魏割,將解壓后的lib子文件夾(包含JPUSHService.h、jpush-ios-x.x.x.a钢颂、jcore-ios-x.x.x.a)添加到你的工程目錄中钞它。
- 添加Framework
- CFNetwork.framework
- CoreFoundation.framework
- CoreTelephony.framework
- SystemConfiguration.framework
- CoreGraphics.framework
- Foundation.framework
- UIKit.framework
- Security.framework
- libz.tbd (Xcode7以下版本是libz.dylib)
- AdSupport.framework (獲取IDFA需要;如果不使用IDFA殊鞭,請不要添加)
- UserNotifications.framework (Xcode8及以上)
- libresolv.tbd (JPush 2.2.0及以上版本需要, Xcode7以下版本是libresolv.dylib)
注意: 如果集成JPush 3.0.1及以上版本遭垛, 且同時(shí)集成極光其他SDK(如:JMessage 3.0.0及以上版本)
- Cocoapods導(dǎo)入,建議都更新為線上最新版本操灿,來避免Jcore版本不一致導(dǎo)致的沖突锯仪。
- 手動(dòng)導(dǎo)入,在工程中只需保留一個(gè)最新版本的jcore-ios-x.x.x.a靜態(tài)庫文件趾盐。
Build Settings
如果你的工程需要支持小于7.0的iOS系統(tǒng)庶喜,請到Build Settings 關(guān)閉 bitCode 選項(xiàng),否則將無法正常編譯通過救鲤。
- 設(shè)置 Search Paths 下的 User Header Search Paths 和 Library Search Paths溃卡,比如SDK文件夾(默認(rèn)為lib)與工程文件在同一級目錄下,則都設(shè)置為"$(SRCROOT)/{靜態(tài)庫所在文件夾名稱}"即可蜒简。
Capabilities
如使用Xcode8及以上環(huán)境開發(fā),請開啟Application Target的Capabilities->Push Notifications選項(xiàng)漩仙,如圖:
允許Xcode7支持Http傳輸方法
如果您使用的是2.1.9及以上的版本則不需要配置此步驟
如果用的是Xcode7或更新版本搓茬,需要在App項(xiàng)目的plist手動(dòng)配置下key和值以支持http傳輸:
選擇1:根據(jù)域名配置
- 在項(xiàng)目的info.plist中添加一個(gè)Key:NSAppTransportSecurity,類型為字典類型队他。
- 然后給它添加一個(gè)NSExceptionDomains卷仑,類型為字典類型;
- 把需要的支持的域添加給NSExceptionDomains麸折。其中jpush.cn作為Key锡凝,類型為字典類型。
- 每個(gè)域下面需要設(shè)置2個(gè)屬性:NSIncludesSubdomains垢啼、NSExceptionAllowsInsecureHTTPLoads窜锯。 兩個(gè)屬性均為Boolean類型张肾,值分別為YES、YES锚扎。如下圖所示吞瞪。
選擇2:全局配置
<key>NSAppTransportSecurity</key>
<dict>
<key>NSAllowsArbitraryLoads</key>
<true/>
</dict>
四、添加頭文件
請將以下代碼添加到 AppDelegate.m 引用頭文件的位置驾孔。
// 引入JPush功能所需頭文件
#import "JPUSHService.h"
// iOS10注冊APNs所需頭文件
#ifdef NSFoundationVersionNumber_iOS_9_x_Max
#import <UserNotifications/UserNotifications.h>
#endif
// 如果需要使用idfa功能所需要引入的頭文件(可選)
#import <AdSupport/AdSupport.h>
五芍秆、添加Delegate
為AppDelegate添加Delegate。
參考代碼:
@interface AppDelegate ()<JPUSHRegisterDelegate>
@end
六翠勉、添加初始化代碼
2.1.0版本開始,API類名為JPUSHService妖啥,不再使用原先的APService。
1.添加初始化APNs代碼
請將以下代碼添加到
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
//Required
//notice: 3.0.0及以后版本注冊可以這樣寫对碌,也可以繼續(xù)用之前的注冊方式
JPUSHRegisterEntity * entity = [[JPUSHRegisterEntity alloc] init];
entity.types = JPAuthorizationOptionAlert|JPAuthorizationOptionBadge|JPAuthorizationOptionSound;
if ([[UIDevice currentDevice].systemVersion floatValue] >= 8.0) {
// 可以添加自定義categories
// NSSet<UNNotificationCategory *> *categories for iOS10 or later
// NSSet<UIUserNotificationCategory *> *categories for iOS8 and iOS9
}
[JPUSHService registerForRemoteNotificationConfig:entity delegate:self];
2.添加初始化JPush代碼
請將以下代碼添加到
-(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
// Optional
// 獲取IDFA
// 如需使用IDFA功能請?zhí)砑哟舜a并在初始化方法的advertisingIdentifier參數(shù)中填寫對應(yīng)值
NSString *advertisingId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];
// Required
// init Push
// notice: 2.1.5版本的SDK新增的注冊方法荆虱,改成可上報(bào)IDFA,如果沒有使用IDFA直接傳nil
// 如需繼續(xù)使用pushConfig.plist文件聲明appKey等配置內(nèi)容俭缓,請依舊使用[JPUSHService setupWithOption:launchOptions]方式初始化克伊。
[JPUSHService setupWithOption:launchOptions appKey:appKey
channel:channel
apsForProduction:isProduction
advertisingIdentifier:advertisingId];
部分參數(shù)說明:
- appKey
- 填寫管理Portal上創(chuàng)建應(yīng)用后自動(dòng)生成的AppKey值。請確保應(yīng)用內(nèi)配置的 AppKey 與 Portal 上創(chuàng)建應(yīng)用后生成的 AppKey 一致华坦。
- channel
- 指明應(yīng)用程序包的下載渠道愿吹,為方便分渠道統(tǒng)計(jì),具體值由你自行定義惜姐,如:App Store犁跪。
- apsForProduction
- 1.3.1版本新增,用于標(biāo)識當(dāng)前應(yīng)用所使用的APNs證書環(huán)境歹袁。
- 0 (默認(rèn)值)表示采用的是開發(fā)證書坷衍,1 表示采用生產(chǎn)證書發(fā)布應(yīng)用。
- 注:此字段的值要與Build Settings的Code Signing配置的證書環(huán)境一致条舔。
- advertisingIdentifier
- 詳見關(guān)于IDFA枫耳。
3. 注冊APNs成功并上報(bào)DeviceToken
請?jiān)贏ppDelegate.m實(shí)現(xiàn)該回調(diào)方法并添加回調(diào)方法中的代碼
- (void)application:(UIApplication *)application
didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
/// Required - 注冊 DeviceToken
[JPUSHService registerDeviceToken:deviceToken];
}
4. 實(shí)現(xiàn)注冊APNs失敗接口(可選)
- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error
{
//Optional
NSLog(@"did Fail To Register For Remote Notifications With Error: %@", error);
}
5. 添加處理APNs通知回調(diào)方法
請?jiān)贏ppDelegate.m實(shí)現(xiàn)該回調(diào)方法并添加回調(diào)方法中的代碼。
#pragma mark- JPUSHRegisterDelegate
// iOS 10 Support
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center willPresentNotification:(UNNotification *)notification withCompletionHandler:(void (^)(NSInteger))completionHandler
{
// Required
NSDictionary * userInfo = notification.request.content.userInfo;
if([notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
[JPUSHService handleRemoteNotification:userInfo];
}
completionHandler(UNNotificationPresentationOptionAlert); // 需要執(zhí)行這個(gè)方法孟抗,選擇是否提醒用戶迁杨,有Badge、Sound凄硼、Alert三種類型可以選擇設(shè)置
}
// iOS 10 Support
- (void)jpushNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)())completionHandler
{
// Required
NSDictionary * userInfo = response.notification.request.content.userInfo;
if([response.notification.request.trigger isKindOfClass:[UNPushNotificationTrigger class]]) {
[JPUSHService handleRemoteNotification:userInfo];
}
completionHandler(); // 系統(tǒng)要求執(zhí)行這個(gè)方法
}
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo fetchCompletionHandler:(void (^)(UIBackgroundFetchResult))completionHandler
{
// Required, iOS 7 Support
[JPUSHService handleRemoteNotification:userInfo];
completionHandler(UIBackgroundFetchResultNewData);
}
- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo
{
// Required,For systems with less than or equal to iOS6
[JPUSHService handleRemoteNotification:userInfo];
}
6. 添加處理JPush自定義消息回調(diào)方法
如需使用JPush的自定義消息功能铅协,請參考文檔來實(shí)現(xiàn)自定義消息的處理回調(diào)方法。
七摊沉、成功運(yùn)行
真機(jī)調(diào)試該項(xiàng)目狐史,如果控制臺輸出以下日志則代表您已經(jīng)集成成功。
2016-08-19 17:12:12.745823 219b28[1443:286814] | JPUSH | I - [JPUSHLogin]
----- login result -----
uid:5460310207
registrationID:171976fa8a8620a14a4
如果調(diào)試運(yùn)行中遇到問題請參考:iOS SDK 調(diào)試指南
八、高級功能
1. 關(guān)于IDFA
r2.1.5版本增加一個(gè)上傳IDFA字符串的接口
+ (void)setupWithOption:(NSDictionary *)launchingOption
appKey:(NSString *)appKey
channel:(NSString *)channel
apsForProduction:(BOOL)isProduction
advertisingIdentifier:(NSString *)advertisingId;
如果不使用IDFA骏全,仍可使用接口
+ (void)setupWithOption:(NSDictionary *)launchingOption
appKey:(NSString *)appKey
channel:(NSString *)channel
apsForProduction:(BOOL)isProduction;
2. JPush SDK 相關(guān)事件監(jiān)聽
- 建議開發(fā)者加上API里面提供的以下類型的通知:
extern NSString *const kJPFNetworkIsConnectingNotification; // 正在連接中
extern NSString * const kJPFNetworkDidSetupNotification; // 建立連接
extern NSString * const kJPFNetworkDidCloseNotification; // 關(guān)閉連接
extern NSString * const kJPFNetworkDidRegisterNotification; // 注冊成功
extern NSString *const kJPFNetworkFailedRegisterNotification; //注冊失敗
extern NSString * const kJPFNetworkDidLoginNotification; // 登錄成功
//溫馨提示:
Registration id 需要添加注冊kJPFNetworkDidLoginNotification通知的方法里獲取苍柏,也可以調(diào)用[registrationIDCompletionHandler:]方法,通過completionHandler獲取
extern NSString * const kJPFNetworkDidReceiveMessageNotification; // 收到自定義消息(非APNs)
其中吟温,kJPFNetworkDidReceiveMessageNotification傳遞的數(shù)據(jù)可以通過NSNotification中的userInfo方法獲取序仙,包括標(biāo)題、內(nèi)容鲁豪、extras信息等
請參考文檔:iOS SDK API
后記
上面寫的是ios Jpush集成指南潘悼,后面會加入相關(guān)調(diào)試,待續(xù)~~