iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

京东云开发者
• 阅读 397

简介

之前在 《iOS16新特性:灵动岛适配开发与到家业务场景结合的探索实践》 里介绍了iOS16新的特性:实时更新(Live Activity)中灵动岛的适配流程,但其实除了灵动岛的展示样式,Live Activity还有一种非常实用的应用场景,那就是锁屏界面实时状态更新:

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

上图是部分已经做出适配的APP,锁屏实时活动的展示。可以看到,相比于灵动岛的样式,锁屏更新的展示区域更大,能够显示更多信息,并且是在锁屏界面上进行展示,结合苹果在iPhone14之后推出的“全天候显示”功能,能够让用户在不解锁手机,甚至不拿起手机的情况下就能够获取到APP内最新的消息更新,在某些应用场景下非常实用。

这篇文章主要就介绍Live Activity中锁屏实时活动样式的适配流程,再结合实际开发过程中的遇到的问题进行实际详解:

限制条件

在进行开发之前,需要先了解一下锁屏实时活动的一些限制条件:

1.实时活动显示在通知区域且有更自由的视图定制和刷新方法,但是跟Widget小组件一样,它也限制了视图上的动画开发,所有的动画效果仅能由系统处理。

2.锁屏通知区域内的实时活动在8小时之内可以刷新数据展示,超过8小时不再支持刷新,,超过12小时强制消失

3.实时活动视图本体不支持发起网络请求,所有的动态数据都要经由通知下发,或者后台活动数据刷新,且每次更新的数据不能超过4KB。

4.实时活动可以通过推送下发更新数据,但是推送的类型不同于传统“基于证书”的推送,而是“基于token”的推送类型。

实际开发

1.建立锁屏实时活动扩展项目

这部分建立的过程与灵动岛的适配流程完全一致,请参见 iOS16新特性:灵动岛适配开发与到家业务场景结合的探索实践 中相关的流程描述,如果之前建立过灵动岛项目,则可以直接开始开发:

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

2.UI开发

Live Activity的全部样式开发均完全采用SwiftUI,锁屏实时活动也不例外,以下是我开发的UI部分代码,大家可以一参考一下:

struct LockScreenLiveActivityView: View {
    let context: ActivityViewContext<DJDynamicIslandAttributes>

    var body: some View {
        VStack {
            Spacer(minLength: 10)
            LockScreenLiveActivityStoreHeaderView(imageURL: context.state.logo, title: context.state.title, subTitle: context.state.subTitle)
            Spacer(minLength: 0)
            LockScreenLiveActivityProgressView(progress: context.state.progress)
            Spacer(minLength: 10)
        }
    }
}

struct LockScreenLiveActivityStoreHeaderView: View {
    let imageURL: String
    let title: String
    let subTitle: String

    var body: some View {
        HStack(spacing: 10) {
            NetworkImage(imageUrl: imageURL)
                .frame(width: 50, height: 50)

            VStack(alignment: .leading, spacing: 4) {
                HStack {
                    Text(title)
                        .font(.system(size: 16, weight: .bold))
                        .foregroundColor(Color(hex: 0x333333, alpha: 1))
                }

                Text(subTitle)
                    .font(.system(size: 13))
                    .foregroundColor(Color(hex: 0x666666, alpha: 1))
                    .padding(EdgeInsets(top: 5, leading: 0, bottom: 0, trailing: 0))
            }

            Spacer()  // 填充剩余空间
        }
        .padding(8)
    }
}

struct LockScreenLiveActivityProgressView: View {
    var progress: CGFloat
    let borderOffset = 20.0

    var body: some View {
        VStack {
            ZStack(alignment: .bottom) {
                HStack(alignment: .bottom) {
                    Spacer()
                    NetworkImage(imageUrl: "", placeholdImage: "store")
                        .frame(width: 50, height: 50)
                    Spacer()
                }

                HStack(alignment: .bottom) {
                    NetworkImage(imageUrl: "", placeholdImage: "knight")
                        .frame(width: 40, height: 40)
                        .offset(x: progress * UIScreen.main.bounds.width - 25)
                    Spacer()
                }

                HStack(alignment: .bottom) {
                    Spacer()
                    NetworkImage(imageUrl: "", placeholdImage: "pin")
                        .frame(width: 18, height: 25)
                        .offset(x: -borderOffset)
                }
            }
            .frame(height: 50)
            Spacer(minLength: 0)
            ZStack(alignment: .leading) {
                RoundedRectangle(cornerRadius: 5)
                    .foregroundColor(Color.gray)
                    .frame(height: 10)

                RoundedRectangle(cornerRadius: 5)
                    .foregroundColor(Color.yellow)
                    .frame(width: (UIScreen.main.bounds.width - borderOffset * 3) * progress, height: 10)
            }
            .frame(height: 15)
            .padding(.horizontal, borderOffset)
        }
    }
}


运行起来以后大概长这个样子:

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

坑1:

由于实时活动不允许加载网络请求,所以网络图片的URL也无法加载,可以通过:

1.直接通推送通知过下发图片的Data,再转成img,但是要注意数据大小,不要超过4Kb

2.本地图片

来解决

3.Live Activity的生命周期

Live Activity的生命周期由ActivityKit管理,其中,数据部分的模型类为ActivityAttributes,自定义数据模型需要继承自ActivityAttributes,静态数据变量直接生命在结构体内,动态数据变量需要声明在ActivityAttributes的ContentState中,这部分变量在接收到推送更新数据时,会自动根据json数据的key值进行解析并更新:

struct DJDynamicIslandAttributes: ActivityAttributes {

    public typealias DJDynamicIslandStatus = ContentState

    public struct ContentState: Codable, Hashable {
        // 动态数据
        var logo: String = ""
        var title: String = ""
        var subTitle: String = ""
        var progress: Double = 0
    }

    // 静态数据
    var totalAmount: String
    var orderId: String
}


Live Activity的生命周期分为:

创建(start)

利用Activity的request方法创建

func startActivity() throws {

        let attributes = DJDynamicIslandAttributes(
            // 静态数据
        )
        let initialContentState = DJDynamicIslandAttributes.ContentState(
            // 动态数据
        )
        let activity = try Activity.request(
            attributes: attributes,
            content: .init(state: initialContentState, staleDate: nil),
            pushType: .token)
    }


更新(update)

利用Activity的update方法更新,传入的参数即为ActivityAttributes的ContentState,也就是动态数据部分

func updateActivity(){
        Task{
            let updatedStatus = DJDynamicIslandAttributes.ContentState(
                // 动态数据
            )
            for activity in Activity<DJDynamicIslandAttributes>.activities{
                await activity.update(using: updatedStatus)
                print("已更新灵动岛显示 Value值已更新 请展开灵动岛查看")
            }
        }
    }


结束(end)

利用Activity的end方法结束,并从锁屏通知界面上移除

func endActivity(){
        Task{
            for activity in Activity<DJDynamicIslandAttributes>.activities{
                await activity.end(dismissalPolicy: .immediate)
                print("已关闭灵动岛显示")
            }
        }
    }


4.数据同步

通过

ActivityConfiguration(for: DJDynamicIslandAttributes.self) { context in 
}


方法创建实时活动视图的时候,回调的参数context类型是ActivityViewContext,可以通过context.state取到动态化数据的属性:

struct LockScreenLiveActivityView: View {
    let context: ActivityViewContext<DJDynamicIslandAttributes>

    var body: some View {
        VStack {
            Spacer(minLength: 10)
            LockScreenLiveActivityStoreHeaderView(imageURL: context.state.logo, title: context.state.title, subTitle: context.state.subTitle)
            Spacer(minLength: 0)
            LockScreenLiveActivityProgressView(progress: context.state.progress)
            Spacer(minLength: 10)
        }
    }
}


利用这些属性刷新视图

使用推送通知更新实时活动

前面已经介绍过,实时活动可以通过推送通知来更新数据展示,下面来介绍具体做法以及开发过程中遇到的坑

ActivityKit 提供了从应用程序启动、更新和结束实时活动的功能。我们可以使用Token通过从服务器发送到 Apple 推送通知服务 (APNs) 的 ActivityKit 推送通知来更新实时活动, 苹果WWDC:《Update Live Activities with push notifications》教程视频

要使用 ActivityKit 推送通知更新实时活动:

1.获取APP的推送Token

使用 ActivityKit ,在启动实时活动时获取实时活动的唯一推送Token。

func startActivity(orderId:String) throws {   
        let attributes = DJDynamicIslandAttributes(
            // 静态数据
        )
        let initialContentState = DJDynamicIslandAttributes.ContentState(
            // 动态数据
        )
        let activity = try Activity.request(
            attributes: attributes,
            content: .init(state: initialContentState, staleDate: nil),
            pushType: .token)

        Task {
        // 获取实时活动的唯一推送Token
            for await data in activity.pushTokenUpdates {
                let token = data.map { String(format: "%02x", $0) }.joined()
            }
        }
    }


使用Activity.request方法时注意传入pushType参数为.token,指定实时活动更新方式为“基于token”的推送更新,这个token就标识了是哪部手机的哪个实时活动来接受推送通知。拿到token后,前端要把它发送给后端服务器,由后端处理发给苹果进行推送

坑2:

Activity.request方法后,token不会立刻生成,而是会异步生成,过一段时间才能取到,所以要建一个Task使用for await方式来获取

坑3:

只有真机调试才能获取token,模拟器无法生成token(苹果APNs不会为模拟器下发推送通知)

2.为APP开启推送通知能力

在苹果开发者中心developer.apple.com 申请一个用于通知的key

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

之后可以获得:

一个10个字符的Key ID,后续的推送中会用到

一个authentication token signing key,是一个.p8类型的文件,后续的推送中需要传入它的存储路径。

3.将要推送的数据进行封装,准备进行通知推送

"aps": {
    "timestamp":'$(date +%s)',
    "event":"update",
    "content-state":{
        "logo": "https://img.duoziwang.com/2016/12/17/16485364877.jpg",
        "title": "订单已经开始配送",
        "subTitle": "快递员正在加急配送",
        "progress": 0.6
        }
}


aps内的数据就是推送通知内容,timestamp是时间戳;event是通知类型,分为update和end两种;content-state就是上文中定义的ActivityAttributes动态数据属性部分,这里的key要与属性名对应,接到通知后就可以自动解析并更新数据

坑4:

所有的属性,在content-state里都要有对应的key-value,就算是空的也要写上,不然会解析失败

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

4.编写服务器脚本

上面封装好的数据,要由后端服务器负责发送给苹果推送服务器(APNs),这个过程就要用到之前几步拿到的信息。这里我把推送脚本的模版提供给大家,大家可以在这个基础上进行修改:

#!/bin/bash

# Set and export your shell variables
export TEAM_ID="苹果开发者账号的teamID"
export TOKEN_KEY_FILE_NAME="第二步拿到的.p8文件存储路径"
export AUTH_KEY_ID="第二步拿到的Key ID"
export TOPIC="app的BundleIdentifier.push-type.liveactivity"
export ACTIVITY_PUSH_TOKEN="第一步拿到的token"
export APNS_HOST_NAME="api.sandbox.push.apple.com"

# Calculate JWT components
export JWT_ISSUE_TIME=$(date +%s)
export JWT_HEADER=$(printf '{ "alg": "ES256", "kid": "%s" }' "${AUTH_KEY_ID}" | openssl base64 -e -A | tr -- '+/' '-_' | tr -d =)
export JWT_CLAIMS=$(printf '{ "iss": "%s", "iat": %d }' "${TEAM_ID}" "${JWT_ISSUE_TIME}" | openssl base64 -e -A | tr -- '+/' '-_' | tr -d =)
export JWT_HEADER_CLAIMS="${JWT_HEADER}.${JWT_CLAIMS}"
export JWT_SIGNED_HEADER_CLAIMS=$(printf "${JWT_HEADER_CLAIMS}" | openssl dgst -binary -sha256 -sign "${TOKEN_KEY_FILE_NAME}" | openssl base64 -e -A | tr -- '+/' '-_' | tr -d =)
export AUTHENTICATION_TOKEN="${JWT_HEADER}.${JWT_CLAIMS}.${JWT_SIGNED_HEADER_CLAIMS}"

# Send APNs request
curl -v --header "apns-topic: $TOPIC" \
 --header "apns-push-type: liveactivity" \
 --header "apns-priority: 10" \
 --header "authorization: bearer $AUTHENTICATION_TOKEN" \
 --data '{
     "aps": {
         "timestamp":'$(date +%s)',
         "event":"update",
         "content-state":{
             #动态数据
         }
     }
 }' \
 --http2 "https://${APNS_HOST_NAME}/3/device/${ACTIVITY_PUSH_TOKEN}"


此部分请求头部信息格式来源:

Establishing a token-based connection to APNs

Sending push notifications using command-line tools

Updating Live Activities with ActivityKit push notifications

运行成功后控制台显示“HTTP/2 200”代表成功了!

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

更新视图:

iOS16新特性:实时活动-在锁屏界面实时更新APP消息 | 京东云技术团队

作者:京东零售 姜海

来源:京东云开发者社区 转载请注明来源

点赞
收藏
评论区
推荐文章
iOS16新特性:灵动岛适配开发与到家业务场景结合的探索实践
苹果在iOS16.1系统对第三方开放了灵动岛的API,并允许开发者基于灵动岛开发相应软件,越来越多的APP开始基于灵动岛的交互进行设计和开发,本文将简单介绍灵动岛开发的流程和将其与业务场景相结合的思考。
Stella981 Stella981
2年前
Hologres+Flink流批一体首次落地4982亿背后的营销分析大屏
简介: 本篇将重点介绍Hologres在阿里巴巴淘宝营销活动分析场景的最佳实践,揭秘FlinkHologres流批一体首次落地阿里双11营销分析大屏背后的技术考验。_概要:刚刚结束的2020天猫双11中,MaxCompute交互式分析(下称Hologres)实时计算Flink搭建的云原生实时数仓首次在核心数据场景落地,为大数据平台创下一项新纪
Stella981 Stella981
2年前
HTTPDNS开源 Android SDK,赋能更多开发者参与共建
为赋能更多开发者参与共建,阿里云HTTPDNS开源AndroidSDK,iOSSDK也在做开源准备,不久也将开放给开发者。HTTPDNS是阿里云移动研发平台面向多端应用(移动端APP,PC客户端应用)提供的域名解析服务,具有域名防劫持、精准调度、实时解析生效的特性。开源介绍HTTPDNSAndroidSDK在原有的HTTP接
Wesley13 Wesley13
2年前
Unity横屏
Android下发现Unity里面的Player设置,并不能完全有效,比如打开了自动旋转,启动的时候还是会横屏,修改XML添加以下代码<applicationandroid:icon"@drawable/ic\_launcher"                    android:label"@string/app\_name"
Wesley13 Wesley13
2年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
京东云开发者 京东云开发者
10个月前
带你走进灵动岛 | 京东云技术团队
苹果在iPhone14Pro及iPhone14ProMAX上推出了灵动岛,是一次交互玩法的革新。本文从灵动岛的展现形式、场景限制、适配情况和远程通知更新数据几个方面全面带你走进灵动岛
linbojue linbojue
6个月前
微软向 Win10 推送 3 月可选更新:锁屏扩展体育、交通等小部件
微软今天面向Windows1022H2功能更新,发布了KB5035941可选更新,主要在锁屏界面上引入了更丰富的小部件、在桌面端引入WindowsSpotlight,以及修复21项错误。IT之家附上KB5035941可选更新主要内容如下:新增功能:在桌面引
京东云开发者 京东云开发者
3个月前
供应链大屏设计实践
概述在物流系统相关的大屏中,供应链大屏复杂度较高,数据链路较长,稳定性要求较高,当前大屏已经经过2年时间的打磨,整体表现已经相对比较成熟稳定。本文描述了物流供应链业务较复杂的业务场景下,结合了大数据计算相关技术,总结了实时监控大屏指标建设和服务构建的框架和