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);
        }
    }
}

AST.NET Core 服務器端對接蘋果推送通知 APNs

一、建立基於 Token 的連接到 APNs

二、生成 token

三、發送通知

關於遊戲付費的一點想法

我通過CKA和CKS啦！

MySQL 常用配置及備份腳本

前端上傳文件可能的問題

MAC 開不開機的問題

ASP.NET Core 問題

MAC 開不開機

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結