极光推送通知 iOS SDK 集成指南

本文来自前面大部分来自“极光开发者服务的极光文档”  后面小部分是小编自己加的监听

适用版本

本文匹配的 SDK版本:r2.1.5 以后。 查看最近更新了解最新的SDK更新情况。 使用Xcode 6及以上版本可以使用新版Push SDK,Xcode 5环境下需要运行旧版本SDK(1.7.4)

资源文件

包名为JPush-iOS-SDK-{版本号}

lib文件夹:包含头文件 JPUSHService.h,静态库文件jpush-ios-x.x.x.a,jcore-ios-x.x.x.a,支持的iOS版本为 6.0 及以上版本。(请注意:模拟器不支持APNs)

README文件:SDK相关说明

demo文件夹:示例

创建应用

在 JPush的管理Portal 上创建应用并上传APNs证书。如果对APNs证书不太了解 请参考: iOS 证书设置指南

极光推送通知 iOS SDK 集成指南_第1张图片

创建成功后自动生成 AppKey 用以标识该应用。

极光推送通知 iOS SDK 集成指南_第2张图片

配置工程

导入SDK

选择1:Cocoapods导入

通过Cocoapods下载地址:

pod 'JPush'

如果需要安装指定版本则使用以下方式(以3.0.2版本为例):

pod 'JPush', '3.0.2'

选择2:手动导入

在极光官网下载最新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及以上版本, 且同时集成极光其他SDK(如:JMessage 3.0.0及以上版本) 

1. Cocoapods导入,建议都更新为线上最新版本,来避免Jcore版本不一致导致的冲突。 

2. 手动导入,在工程中只需保留一个最新版本的jcore-ios-x.x.x.a静态库文件。

Build Settings

如果你的工程需要支持小于7.0的iOS系统,请到Build Settings 关闭 bitCode 选项,否则将无法正常编译通过。

设置 Search Paths 下的 User Header Search Paths 和 Library Search Paths,比如SDK文件夹(默认为lib)与工程文件在同一级目录下,则都设置为"$(SRCROOT)/{静态库所在文件夹名称}"即可。

Capabilities

如使用Xcode8及以上环境开发,请开启Application Target的Capabilities->Push Notifications选项,如图: 

极光推送通知 iOS SDK 集成指南_第3张图片

允许Xcode7支持Http传输方法

如果您使用的是2.1.9及以上的版本则不需要配置此步骤 如果用的是Xcode7或更新版本,需要在App项目的plist手动配置下key和值以支持http传输:

选择1:根据域名配置

在项目的info.plist中添加一个Key:NSAppTransportSecurity,类型为字典类型。

然后给它添加一个NSExceptionDomains,类型为字典类型;

把需要的支持的域添加給NSExceptionDomains。其中jpush.cn作为Key,类型为字典类型。

每个域下面需要设置2个属性:NSIncludesSubdomains、NSExceptionAllowsInsecureHTTPLoads。 两个属性均为Boolean类型,值分别为YES、YES。

如图:

极光推送通知 iOS SDK 集成指南_第4张图片

选择2:全局配置

  NSAppTransportSecurity


    NSAllowsArbitraryLoads



添加头文件

请将以下代码添加到 AppDelegate.m 引用头文件的位置。

// 引入JPush功能所需头文件

#import "JPUSHService.h"

// iOS10注册APNs所需头文件

#ifdef NSFoundationVersionNumber_iOS_9_x_Max

#import

#endif

// 如果需要使用idfa功能所需要引入的头文件(可选)

#import

添加Delegate

为AppDelegate添加Delegate。

参考代码:

@interface AppDelegate ()

@end

添加初始化代码

2.1.0版本开始,API类名为JPUSHService,不再使用原先的APService。

添加初始化APNs代码

请将以下代码添加到 -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

  //Required

  //notice: 3.0.0及以后版本注册可以这样写,也可以继续用之前的注册方式

  JPUSHRegisterEntity * entity = [[JPUSHRegisterEntity alloc] init];

  entity.types = JPAuthorizationOptionAlert|JPAuthorizationOptionBadge|JPAuthorizationOptionSound;

  if ([[UIDevice currentDevice].systemVersion floatValue] >= 8.0) {

    // 可以添加自定义categories

    // NSSet *categories for iOS10 or later

    // NSSet *categories for iOS8 and iOS9

  }

  [JPUSHService registerForRemoteNotificationConfig:entity delegate:self];

添加初始化JPush代码

请将以下代码添加到 -(BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

  // Optional

  // 获取IDFA

  // 如需使用IDFA功能请添加此代码并在初始化方法的advertisingIdentifier参数中填写对应值

  NSString *advertisingId = [[[ASIdentifierManager sharedManager] advertisingIdentifier] UUIDString];

  // Required

  // init Push

  // notice: 2.1.5版本的SDK新增的注册方法,改成可上报IDFA,如果没有使用IDFA直接传nil

  // 如需继续使用pushConfig.plist文件声明appKey等配置内容,请依旧使用[JPUSHService setupWithOption:launchOptions]方式初始化。

  [JPUSHService setupWithOption:launchOptions appKey:appKey

                        channel:channel

              apsForProduction:isProduction

          advertisingIdentifier:advertisingId];

部分参数说明:

appKey

选择 Web Portal上 的应用 ,点击“设置” 获取其 appkey 值。请确保应用内配置的 appkey 与 Portal 上创建应用后生成的 appkey 一致。

channel

指明应用程序包的下载渠道,为方便分渠道统计,具体值由你自行定义,如:App Store。

apsForProduction

1.3.1版本新增,用于标识当前应用所使用的APNs证书环境。

0 (默认值)表示采用的是开发证书,1 表示采用生产证书发布应用。

注:此字段的值要与Build Settings的Code Signing配置的证书环境一致。

advertisingIdentifier

详见关于IDFA。

注册APNs成功并上报DeviceToken

温馨提示: 

JPush 3.0.9 之前的版本,必须调用此接口,注册 token 之后才可以登录极光,使用通知和自定义消息功能。 

从 JPush 3.0.9 版本开始,不调用此方法也可以登录极光。但是不能使用APNs通知功能,只可以使用JPush自定义消息。

请在AppDelegate.m实现该回调方法并添加回调方法中的代码

- (void)application:(UIApplication *)application

didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {

  /// Required - 注册 DeviceToken

  [JPUSHService registerDeviceToken:deviceToken];

}

实现注册APNs失败接口(可选)

- (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(NSError *)error {

  //Optional

  NSLog(@"did Fail To Register For Remote Notifications With Error: %@", error);

}

添加处理APNs通知回调方法

请在AppDelegate.m实现该回调方法并添加回调方法中的代码

#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); // 需要执行这个方法,选择是否提醒用户,有Badge、Sound、Alert三种类型可以选择设置

}

// 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();  // 系统要求执行这个方法

}

- (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];

}

添加处理JPush自定义消息回调方法

如需使用JPush的自定义消息功能,请参考文档来实现自定义消息的处理回调方法。

成功运行

真机调试该项目,如果控制台输出以下日志则代表您已经集成成功。

2016-08-19 17:12:12.745823 219b28[1443:286814]  | JPUSH | I - [JPUSHLogin]

----- login result -----

uid:5460310207

registrationID:171976fa8a8620a14a4

如果调试运行中遇到问题请参考:iOS SDK 调试指南

高级功能

关于IDFA

r2.1.5版本增加一个上传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;

JPush SDK 相关事件监听

建议开发者加上API里面提供的以下类型的通知:

extern NSString *const kJPFNetworkIsConnectingNotification; // 正在连接中

extern NSString * const kJPFNetworkDidSetupNotification; // 建立连接

extern NSString * const kJPFNetworkDidCloseNotification; // 关闭连接

extern NSString * const kJPFNetworkDidRegisterNotification; // 注册成功

extern NSString *const kJPFNetworkFailedRegisterNotification; //注册失败

extern NSString * const kJPFNetworkDidLoginNotification; // 登录成功

温馨提示: 

Registration id 需要添加注册kJPFNetworkDidLoginNotification通知的方法里获取,也可以调用[registrationIDCompletionHandler:]方法,通过completionHandler获取

extern NSString * const kJPFNetworkDidReceiveMessageNotification; // 收到自定义消息(非APNs)

其中,kJPFNetworkDidReceiveMessageNotification传递的数据可以通过NSNotification中的userInfo方法获取,包括标题、内容、extras信息等

请参考文档:iOS SDK API

通知送达统计

温馨提示: 

iOS 10 新增的 Notification Service Extension 功能,用 mutable-content 字段来控制。 

若使用 Web 控制台,需勾选 “可选设置”中 mutable-content 选项;若使用 RESTFul API 需设置 mutable-content 字段为 true。

从 iOS JPush SDK 3.0.7 版本,开发者可使用 Notification Service Extension SDK 上报每条 APNs 信息的送达状态。

使用方法:

将 jpush-extension-ios-xxx.a 和 JPushNotificationExtensionService.h 两个文件引入到您的 Service Extentsion 工程中。

添加Framework : libz.tbd 和 libresolv.tbd。

调用 [jpushSetAppkey:] 方法设置您的 appkey,请注意这里的 appkey 应该和您极光应用的 appkey 相同。

调用 [jpushReceiveNotificationRequest:] 方法上报您的 apns 消息,完成送达统计;在该方法的block回调中进行apns 的显示。

更具体的使用示例请参考版本压缩包中附带的 Demo 代码。

参考文档:iOS SDK API


小编自己写的监听


极光推送通知 iOS SDK 集成指南_第5张图片

然后再viewcontroller.m里面写


极光推送通知 iOS SDK 集成指南_第6张图片

其他的在本文里面都有写,很详细

这是一个我的iOS交流群:728929018,不管你是小白还是大牛欢迎入驻 ,分享BAT,阿里面试题、面试经验,讨论技术, 大家一起交流学习成长!


代码:https://github.com/15626036029/Pushnotice

你可能感兴趣的:(极光推送通知 iOS SDK 集成指南)