ios -- 极光推送《3》 pod 方法

时间 2019-11-11

标签 ios 极光推送 pod 方法栏目 iOS 繁體版

原文原文链接

iOS SDK 集成指南

SDK说明

适用版本

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

资源文件

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

lib文件夹：包含头文件 JPUSHService.h，静态库文件jpush-ios-x.x.x.a，jcore-ios-x.x.x.a，支持的iOS版本为 6.0 及以上版本。（请注意：模拟器不支持APNs）
pdf文件：集成指南
demo文件夹：示例

建立应用

在 JPush的管理Portal 上建立应用并上传APNs证书。若是对APNs证书不太了解请参考： iOS 证书设置指南

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

配置工程

导入SDK

选择1：Cocoapods导入xcode

经过Cocoapods下载地址：

pod 'JPush'

若是须要安装指定版本则使用如下方式（以3.0.2版本为例）：

pod 'JPush', '3.0.2'

选择2：手动导入app

在极光官网下载最新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静态库文件。less

Build Settings

若是你的工程须要支持小于7.0的iOS系统，请到Build Settings 关闭 bitCode 选项，不然将没法正常编译经过。dom

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

Capabilities

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

容许Xcode7支持Http传输方法

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

选择1：根据域名配置ui

在项目的info.plist中添加一个Key：NSAppTransportSecurity，类型为字典类型。
而后给它添加一个NSExceptionDomains，类型为字典类型；
把须要的支持的域添加給NSExceptionDomains。其中jpush.cn做为Key，类型为字典类型。
每一个域下面须要设置2个属性：NSIncludesSubdomains、NSExceptionAllowsInsecureHTTPLoads。两个属性均为Boolean类型，值分别为YES、YES。

如图：debug

选择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。

添加初始化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<UNNotificationCategory *> *categories for iOS10 or later
    // NSSet<UIUserNotificationCategory *> *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
- 填写管理Portal上建立应用后自动生成的AppKey值。请确保应用内配置的 AppKey 与 Portal 上建立应用后生成的 AppKey 一致。
channel
- 指明应用程序包的下载渠道，为方便分渠道统计，具体值由你自行定义，如：App Store。
apsForProduction
- 1.3.1版本新增，用于标识当前应用所使用的APNs证书环境。
- 0 (默认值)表示采用的是开发证书，1 表示采用生产证书发布应用。
- 注：此字段的值要与Build Settings的Code Signing配置的证书环境一致。
advertisingIdentifier
- 详见关于IDFA。

注册APNs成功并上报DeviceToken

请在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信息等