实现iOS消息推送

以你之姓@ 2022-08-18 10:55 425阅读 0赞

## 消息推送过程 ##

![APNS][]

1.  应用启动时，调用`registerUserNotificationSettings:`方法与Apple的`APNS`服务器通信，并注册推送服务。注册成功后，系统会调用应用的`didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken`方法。其中，`deviceToken`参数是`APNS`返回的`deviceToken`（用来唯一标识一个设备，每个设备上的每个应用的`deviceToken`都不相同）。在这里，我们需要将这个`deviceToken`上传到我们自己的服务器中，用来向指定设备发送push消息。
2.  服务端拿到这个`deviceToken`后，使用我们申请好的证书和这个`deviceToken`，向Apple的`APNS`服务器发送一个JSON串，这个JSON串中包含我们要向iOS设备发送的内容。
3.  `APNS`服务器收到这个JSON串，并向`deviceToken`指定的设备发送消息，iOS应用收到消息后，会调用`- (void)application:(UIApplication *)application didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo`方法。
4.  `APNS`发送完消息后，将消息是否推送成功的状态反馈给我们的服务端。

## 开发前的准备 ##

这里的准备主要是需要从Apple开发者中心注册好应用ID并申请相应的证书。

### 注册应用ID ###

1.  打开[Apple developer member center][],如下图所示，点击红框里面的那一项。  
    ![member center][]
2.  点击左侧的**Identifiers**下的**App IDs**项，如下图所示，然后点击右上角的加号。  
    ![App IDs][]
3.  在下图的**Name**一栏里填入应用名字（可以跟你的iOS应用名字不同）。  
    ![App Name][]
4.  继续往下拉，选中**App ID Suffix**项的**Explicit App ID**，在**Bundle ID**栏里填入你的应用的**Bundle ID**（需要跟你的应用的**Bundle Identifier**相同）。  
    ![Bundle ID][]
5.  不要忘记在下面的**App Services**里面勾选上**Push Notification**（不勾选不能使用推送服务）。  
    ![Push Notification][]
6.  继续点击**Continue**，在新页面中点击**submit**，最终出现下面的页面，点击**Done**完成创建应用。  
    ![App Done][]

### 生成推送证书 ###

1.  打开Mac上的钥匙串访问应用，在左上角的状态栏中的**钥匙串访问**项中选择**证书助理**，再选择**从证书颁发机构请求证书**。  
    ![Key Acess][]
2.  打开如下图界面后，在**用户电子邮件地址**栏中填入Apple开发者账号的电子邮件地址，**常用名称**中填入一个名字，这里起**Push**。  
    ![Register CSR][]
3.  选择保存到磁盘。
4.  然后点击继续，将证书保存到桌面的**push文件夹**中。
5.  现在，**push文件夹**中有了一个`CertificateSigningRequest.certSigningRequest`的文件。
6.  继续回到**member center**中，在左侧选择**Certificates**下的**All**，点击右上角的加号。  
    ![Cert Select][]
7.  在证书类型选择那里像下图那样选择（这里申请的是开发测试证书，正式发布产品的话选择下面Product栏里的证书）。  
    ![Cert SandBox][]
8.  在下面的**App ID**项里选择刚才创建的App ID。  
    ![Cert App ID][]
9.  在**Upload CSR file**那里选择选择刚才保存在桌面的push文件夹中的`CertificateSigningRequest.certSigningRequest`文件。  
    ![Cert CSR][]
10. 点击**Generate**，出现如下页面，点击**Download**，把证书保存到刚才的**push文件**夹中。  
    ![Cert Done][]
11. 此时**push文件夹**有`aps_development.cer`和`` `CertificateSigningRequest.certSigningRequest``两个文件。
12. 点击`aps_development.cer`证书，在钥匙串访问中会出现一个**Apple Development IOS push services证书**，一个公用密钥和一个专用秘钥，秘钥的名称与证书助理中填写的名称一致。
13. 选中证书，导出为 **apns-dev-cert.p12 文件**，保存到**push文件夹**。
14. 选中专有秘钥，导出为**apns-dev-key.p12文件**，保存到**push文件夹**。
15. 如果服务端使用`PHP`开发，则需要在终端中执行以下命令生成`PHP`需要的`pem`证书
    
        openssl pkcs12 -clcerts -nokeys -out apns-dev-cert.pem -in apns-dev-cert.p12
        openssl pkcs12 -nocerts -out apns-dev-key.pem -in apns-dev-key.p12
    
    生成pem证书时需要输入导出证书时设置的密码。  
    然后执行下面的命令，将两个证书合成为一个：
    
        cat apns-dev-cert.pem apns-dev-key.pem > apns-dev.pem
    
    最终的`apns-dev.pem`就是服务端所需要的证书。
16. 如果服务端使用`C#`或`JAVA`开发，则需要生成`p12`格式的证书：
    
        openssl pkcs12 -clcerts -nokeys -out apns-dev-cert.pem -in apns-dev-cert.p12
        openssl pkcs12 -nocerts -out apns-dev-key.pem -in apns-dev-key.p12
        openssl pkcs12 -export -in apns-dev-cert.pem -inkey apns-dev-key.pem  -certfile CertificateSigningRequest.certSigningRequest -name "push" -out push.p12
    
    生成`.p12`证书的过程同样需要输入导出证书时设置的密码。  
    最终生成的`push.p12`证书就是服务端要使用的证书。

### 生成Provisioning Profiles ###

1.  在**Member Center**左侧选择**Provisioning Profiles**栏下的**All**,然后点击右上角的加号。
2.  出现下面的页面后，选择**iOS App Devleopment**项（这里也是开发测试配置文件，实际产品可以选择**Distribution**栏下的项目），点击**Continue**。  
    ![Profile select][]
3.  在选择APP ID 页面中选择刚才创建的APP ID，点击**Continue**。  
    ![Profile app id][]
4.  在选择证书页面中选择**Select ALl**，点击**Continue**。  
    ![Profile cert][]
5.  在选择设备页面中选择**Select All**,(如果你的设备不在列表中，需要先在Member Center中添加你的设备)，点击**Continue**。  
    ![Profile device][]
6.  在下面的页面中的**Name**栏中填入这个**Provisioning Profiles**的名字，这里填的是**Blog**。  
    ![Profile name][]
7.  在Xcode的偏好设置中的**Account**标签中点击右下角的**View Details**按钮。  
    ![Xcode Details][]
8.  在出现界面的**Provisioning Profiles**栏中找到刚才创建的**Provisioni Profiles**名字，点击后面的**Download**按钮下载到本机。  
    ![Xcode Download][]

## 客户端开发 ##

首先，需要在客户端申请推送权限并获取`Device Token`，在`AppDelegate.m`中加入如下代码:

//应用启动完毕
    - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
    {
        UIUserNotificationSettings *notiSetting = [UIUserNotificationSettings
                                                   settingsForTypes:(UIUserNotificationTypeBadge | UIUserNotificationTypeAlert | UIUserNotificationTypeSound)
                                                   categories:nil];
        //申请远程推送权限
        [application registerUserNotificationSettings:notiSetting];
    
        return YES;
    }
    
    - (void)application:(UIApplication *)application didRegisterUserNotificationSettings:(nonnull UIUserNotificationSettings *)notificationSettings
    {
        //注册远程推送
        [application registerForRemoteNotifications];
    }
    
    //成功申请到远程推送权限后将会调用这个方法
    //早这个方法中需要将获取到的device token上传到自己的服务器端
    - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
    {
        //upload this device token to your service for send message to this device
        NSLog(@"Device Token : %@",deviceToken);
    }
    
    //注册远程推送失败后会执行这个方法
    - (void)application:(UIApplication *)application didFailToRegisterForRemoteNotificationsWithError:(nonnull NSError *)error
    {
        NSLog(@"Error : %@", [error userInfo]);
    }
    
    //收到远程推送时会执行下面的方法
    - (void)application:(UIApplication *)application didReceiveRemoteNotification:(nonnull NSDictionary *)userInfo
    {
        NSString *serinfo = [NSString stringWithFormat:@"%@",userInfo];
        NSLog(@"User info : %@", serinfo);
    }

当应用第一次运行时就会弹出下面的提示框询问用户是否同意应用推送消息给他。  
![apply push][]

用户选择“好”后，`didRegisterForRemoteNotificationsWithDeviceToken:`就会被调用，从而获得`device token`。  
需要注意的是，当应用正在执行时收到推送通知时会直接调用`didReceiveRemoteNotification:`方法。  
当应用不在执行时，收到通知后点击通知消息冷启动后会首先调用`didFinishLaunchingWithOptions:`再调用`didReceiveRemoteNotification:`方法。  
当冷启动时，在`didFinishLaunchingWithOptions:`方法中也可以直接使用下面的代码获取推送过来的消息（与`didReceiveRemoteNotification:`中传入的`userInfo`相同）

NSDictionary* userInfo = [launchOptions objectForKey:UIApplicationLaunchOptionsRemoteNotificationKey];

## 服务端开发 ##

为了省事，我这里使用了[javapns][]库，代码如下：

public class Puser
    {
        
        public static void main(String[] args)
        {
            //device token
            String token = "d8e5c7668df7c9572ae575afb23c0cec03c0921ab5547a3df6dbb15fdde3541e";
            //证书路径
            String certPath = "cert/push.p12";
            //证书密码
            String passWord = "5555555";
            try
            {
                PushNotificationPayload payLoad = PushNotificationPayload.complex();
                //要推送的消息
                payLoad.addCustomAlertBody("Hello");
                //应用图标显示的角标
                payLoad.addBadge(1);
                //收到推送到达时的声音
                payLoad.addSound("default");
    
                PushedNotifications notifications =  Push.payload(payLoad, certPath, passWord, false, token);
                System.out.println(notifications);
            }catch(Exception e)
            {
                e.printStackTrace();
            }
        }
    
    }

执行后收到通知：

![push noti][]

## Payload简介 ##

上面我们曾说到我们要给用户推送消息，要向Apple的服务器发送一个JSON串，这个JSON串就叫做`Payload`。

`Payload`是一个指定格式的JSON串，Apple规定`Payload`中必须包含一个名为`aps`的`Dictionary`属性，并且`Payload`的大小不能超过**2k**，否则，`APNs`将拒绝转发这个`Payload`。下面的表格列出了`aps`中的各个属性。

> `APNs`只是“尽最大努力”将`Payload`交付给用户而不能够保证一定会将`Payload`交付给用户

`aps`的属性列表：

<table> 
 <thead> 
  <tr> 
   <th>键</th> 
   <th>值类型</th> 
   <th>备注</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>alert</td> 
   <td>String 或 Dictionary</td> 
   <td>要显示的消息</td> 
  </tr> 
  <tr> 
   <td>bage</td> 
   <td>Number</td> 
   <td>应用图标角标的数字</td> 
  </tr> 
  <tr> 
   <td>sound</td> 
   <td>String</td> 
   <td>通知声音</td> 
  </tr> 
 </tbody> 
</table>

> `alert`属性值的类型为`String`时，消息到达时显示默认样式的提示框（带关闭和查看按钮），类型为`Dictionary`时，各属性参考Apple[消息推送服务开发指南][Link 1]。

例如，下面就是一个标准的`Payload`:

{
        "aps" : {
            "alert" : "You got your emails.",
            "badge" : 1,
            "sound" : "default"
        }
    }

当然，我们也可以在`Payload`中加入自定义的属性，方便客户端根据服务器的推送做出相应的响应。

例如，下面就是一个添加了自定义属性的`Payload`:

{
        "aps" : {
            "alert" : "You got your emails.",
            "badge" : 1,
            "sound" : "default"
        },
        "acme1" : "bar",
        "acme2" : 42
    }

其中，`acme1`和`acme2`都是自己定义的属性。

> 自定义的属性必须为JSON的原生属性，例如`String`、`Array`、`Dictionary`等

当然，为了方便实现应用的国际化，`Payload`中也添加了一些实现应用国际化的字段，这些都可以去查阅Apple的Apple[消息推送服务开发指南][Link 1],这里只是对`Payload`的一个简介。

[APNS]: /images/20220731/611a26c7617048c9a988b30533f19bb7.png
[Apple developer member center]: https://developer.apple.com/membercenter/index.action
[member center]: /images/20220731/49442770332d418f8ae28ff90936303f.png
[App IDs]: /images/20220731/d6715b9b4075432db0bc1a0c2b84070e.png
[App Name]: /images/20220731/6557d79fa53b4be395323f64e7f273ac.png
[Bundle ID]: /images/20220731/cdac7a2dc9be46fdac1d522af572b05b.png
[Push Notification]: /images/20220731/681b46ac66ba4880b0cc22f17989f7bc.png
[App Done]: /images/20220731/7f358b7057284f36b9fb19adeda38653.png
[Key Acess]: /images/20220731/c60d9e220f264ed88d96b9e351ddc3d1.png
[Register CSR]: /images/20220731/9996e8cccc6f4bbd92da291212026f40.png
[Cert Select]: /images/20220731/7cb08bd8b2d24545ade3ebf5299b62de.png
[Cert SandBox]: /images/20220731/7b09597453324988b05e57288ff1ad25.png
[Cert App ID]: /images/20220731/2f15fb4c55514d61928f6311c5ea370c.png
[Cert CSR]: /images/20220731/3a8aac6f77bb4e43afb9d98e1b2ea09d.png
[Cert Done]: /images/20220731/283032a823214cd89b8fc49611ef17bc.png
[Profile select]: /images/20220731/f26cfb00de5d4d8081ed732bda5ff866.png
[Profile app id]: /images/20220731/23d75f3f12b64169862a6dd754b68c00.png
[Profile cert]: /images/20220731/65f22f881ed94f3aac9269826782fc46.png
[Profile device]: /images/20220731/35d619bb388645389e059280a43d1752.png
[Profile name]: /images/20220731/8e20da1f129c4c72b8b764feb9e7abcd.png
[Xcode Details]: /images/20220731/ed048636390543a69dca267ec9ceb899.png
[Xcode Download]: /images/20220731/c45c3185f5104857a31c387db3e505ff.png
[apply push]: /images/20220731/66055ab7d72749e79b31ab39ad0c0183.png
[javapns]: https://github.com/liu83582243xin/javapns
[push noti]: /images/20220731/96dbc8a35fe24b8e82f706f47f7deeb8.png
[Link 1]: https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/ApplePushService.html#//apple_ref/doc/uid/TP40008194-CH100-SW1