AST.NET Core 服务器端对接苹果推送通知 APNs
本文主要介绍三个问题:
- 如何建立基于 Token 的连接到 APNs?
- 生成 token
- 如何发送通知到 APNs?
一、建立基于 Token 的连接到 APNs
要和 APNs 通信,连接就要认证。目前苹果提供的认证方式有两种,一种是基于 Token,一种是基于证书。本文只介绍基于 Token 的认证。基于 Token 的认证主要有以下优点:
- 无状态的通信要比基于证书的认证要快,因为不需要查询证书
- 你可以使用来自不同提供服务器的同一种类型的 token
- 你可以使用一种 token 为你公司的所有 APP 发布通知
我们要生成 token,首先要从苹果获取一个加密密钥和一个密钥 ID。
登录开发者账号,找到 keys,点击新增:
输入名称,勾选通知服务
点击注册
点击下载,下载的文件存储的是以 p8 格式文件的密钥,我们需要的有两个信息,一个是 Key ID(下载的文件名及下图都有),一个是文件中的密钥。
下一步就是用这个密钥生成 token。
二、生成 token
这里生成的 token 为 JWT Token,目前 APNs 只支持 ES256 算法加密,也就是我们需要使用 ES256 来加密生成 JWT Token。生成的 token 中需要包含的信息如下,必须要按照以下格式指定。
其中分为两部分,header 和 payload 部分,其中 header 指定了加密算法和上一步我们获取到的 Key Id,格式如下:
{
"alg": "ES256", // 固定的
"kid": "你自己的 Key Id"
}
payload 部分要包含以下信息:
{
"iss": "DEF123GHIJ", // 签发者,是你的开发者账号的 Id,Team Id
"iat": 1437179036 // 签发时间,1970 至今的秒数,这里苹果要求 token 的刷新时间不能超过一小时,最小不能低于 20 分钟
}
我们要做到就是对以上信息加密生成 JWT Token。
这里主要注意的是
- 读取密钥
- 使用密钥生成 JWT Token
这里密钥我这里是把密钥从 p8 文件里面复制出来,放到了 appsettings.json 文件里,通过配置获取。注意,文件中的-----BEGIN PRIVATE KEY-----和 -----END PRIVATE KEY----- 中间部分就是密钥,需要删除中间的换行符。p8 文件的固定格式。代码如下:
var securityKey = _configuration["apple:securityKey"].Replace("\n", "");
当然,这里读取密钥也可以用其他方法直接从 p8 文件读取,这里没做研究,也就不做介绍了。
获取到密钥后,我们需要生成 JWT Token,具体代码如下,完整代码在最后:
var eCDsa = ECDsa.Create(); eCDsa.ImportPkcs8PrivateKey(Convert.FromBase64String(securityKey), out _); var key = new ECDsaSecurityKey(eCDsa); key.KeyId = kid; var signingCredentials = new SigningCredentials(key, SecurityAlgorithms.EcdsaSha256); var jwtHeader = new JwtHeader(signingCredentials); var jwtPayload = new JwtPayload(claims); var jwtSecurityToken = new JwtSecurityToken(jwtHeader, jwtPayload); APNsService.token = tokenHandler.WriteToken(jwtSecurityToken);
这样我们就生成了 JWT Token。发送请求的时候放入头部就可以,格式为 authorization = bearer token(注意,bearer 和 token 之间使用空格分割)
三、发送通知
发送通知,也就是往 APNs 发送一个 POST 请求。具体就是使用 C# 发送一个 Request 请求,具体不做过多介绍,详见后面完整代码。
需要注意的是
- APNs Uri 这里参见下面代码,官方的文档错误,其中 :path 不能添加
- 请求头部除了 Authorization 之外,apns-topic 也必须添加,也就是 app bundle id,其他的可以参照官方文档
完整代码:
IAPNsService
namespace Hzg.Services; public interface IAPNsService { /// <summary> /// 生成 APNs JWT token /// </summary> /// <returns></returns> string GetnerateAPNsJWTToken(); /// <summary> /// 发送推送通知 /// </summary> /// <param name="apnsTopic">APP Id</param> /// <param name="deviceToken">设备标识</param> /// <param name="type">通知类型</param> /// <param name="title">标题</param> /// <param name="subtitle">子标题</param> /// <param name="body">通知内容</param> /// <returns></returns> Task<string> PushNotification(string apnsTopic, string deviceToken, NotificationType type, string title, string subtitle, string body); }
APNsService
using System.Security.Claims; using System.Security.Cryptography; using Microsoft.IdentityModel.Tokens; using System.IdentityModel.Tokens.Jwt; using static System.Net.Mime.MediaTypeNames; using Microsoft.Net.Http.Headers; using Microsoft.Extensions.Configuration; using Hzg.Tool; using Hzg.Const; namespace Hzg.Services; public enum NotificationType: int { Alert = 0, Sound = 1, Badge = 2, Silent = 3 } /// <summary> /// APNs 生成 JWT token,添加服务的时候,使用单利 /// </summary> public class APNsService : IAPNsService { static string token = null; static string baseUrl = null; private readonly IConfiguration _configuration; private readonly IHttpClientFactory _httpClientFactory; public APNsService(IConfiguration configuration, IHttpClientFactory httpClientFactory) { this._configuration = configuration; this._httpClientFactory = httpClientFactory; APNsService.baseUrl = this._configuration["apple:pushNotificationServer"]; } /// <summary> /// 生成 APNs JWT token /// </summary> /// <returns></returns> public string GetnerateAPNsJWTToken() { return this.GetnerateAPNsJWTToken(APNsService.token); } /// <summary> /// 生成 APNs JWT token /// </summary> /// <returns></returns> private string GetnerateAPNsJWTToken(string oldToken) { var tokenHandler = new JwtSecurityTokenHandler(); var iat = ((DateTime.UtcNow.Ticks - new DateTime(1970, 1, 1).Ticks) / TimeSpan.TicksPerSecond); // 判断原 token 是否超过 50 分钟,如果未超过,直接返回 if (string.IsNullOrWhiteSpace(oldToken) == false) { JwtPayload oldPayload = tokenHandler.ReadJwtToken(oldToken).Payload; var oldIat = oldPayload.Claims.FirstOrDefault(c => c.Type == "iat"); if (oldIat != null) { if (long.TryParse(oldIat.Value, out long oldIatValue) == true) { // 两次间隔小于 50 分钟,使用原 token if ((iat - oldIatValue) < (50 * 60)) { return oldToken; } } } } var kid = _configuration["apple:kid"]; var securityKey = _configuration["apple:securityKey"].Replace("\n", ""); var iss = _configuration["apple:iss"]; var claims = new Claim[] { new Claim("iss", iss), new Claim("iat", iat.ToString()) }; var eCDsa = ECDsa.Create(); eCDsa.ImportPkcs8PrivateKey(Convert.FromBase64String(securityKey), out _); var key = new ECDsaSecurityKey(eCDsa); key.KeyId = kid; var signingCredentials = new SigningCredentials(key, SecurityAlgorithms.EcdsaSha256); var jwtHeader = new JwtHeader(signingCredentials); var jwtPayload = new JwtPayload(claims); var jwtSecurityToken = new JwtSecurityToken(jwtHeader, jwtPayload); APNsService.token = tokenHandler.WriteToken(jwtSecurityToken); return APNsService.token; } /// <summary> /// 发送推送通知 /// </summary> /// <param name="apnsTopic">APP Id</param> /// <param name="deviceToken">设备标识</param> /// <param name="type">通知类型</param> /// <param name="title">标题</param> /// <param name="subtitle">子标题</param> /// <param name="body">通知内容</param> /// <returns></returns> public async Task<string> PushNotification(string apnsTopic, string deviceToken, NotificationType type, string title, string subtitle, string body) { var responseData = ResponseTool.FailedResponseData(); var token = this.GetnerateAPNsJWTToken(); var httpRequestMessage = new HttpRequestMessage(HttpMethod.Post, APNsService.baseUrl + deviceToken) { Headers = { { HeaderNames.Authorization, "bearer " + token }, { "apns-topic", apnsTopic }, { "apns-expiration", "0" } }, Version = new Version(2, 0) }; var notContent = new { aps = new { alert = new { title = title, subtitle = subtitle, body = body } } }; var content = new StringContent(JsonSerializerTool.SerializeDefault(notContent), System.Text.Encoding.UTF8, Application.Json); httpRequestMessage.Content = content; var httpClient = _httpClientFactory.CreateClient(); try { var httpResponseMessage = await httpClient.SendAsync(httpRequestMessage); if (httpResponseMessage.IsSuccessStatusCode) { responseData.Code = ErrorCode.Success; return JsonSerializerTool.SerializeDefault(responseData); } else { responseData.Data = httpResponseMessage.StatusCode; return JsonSerializerTool.SerializeDefault(responseData); } } catch (Exception e) { responseData.Data = e.Message; return JsonSerializerTool.SerializeDefault(responseData); } } }