StoreKit 2 的新增功能和 Xcode 中的 StoreKit 测试

了解 Xcode 中 StoreKit 2 和 StoreKit 测试的最新增强功能。发现用于推广 App 内购买项目的 API 更新、StoreKit 消息、Transaction 模型、RenewalInfo 模型以及用于管理订阅的 App Store sheet 的 API 更新。了解如何升级到 SHA-256 以进行设备上收据验证以及如何使用 API 创建 SwiftUI 视图。此外，我们还将帮助你开始在 Xcode 中进行 StoreKit 测试，以便你可以调试和测试你的 App 内购买项目和订阅。认识事务检查器，探索 StoreKit 配置编辑器的最新更新，并了解如何模拟 StoreKit 错误来测试你的 App 的错误处理能力。

资源

相关视频

WWDC23

WWDC22

WWDC21

认识 StoreKit 2

下载

♪ ♪

Ricky：大家好我叫 Ricky 欢迎收看 “Xcode 中的 StoreKit 2 和 StoreKit 测试的新功能” 在本次讲座中我将介绍今年为 StoreKit 带来的新功能以及 Xcode 中测试体验的改进在 2021 年的 WWDC 上首次介绍了 StoreKit 2 并且引入了使用 Swift 新的更灵活的 API 今年我很高兴向大家展示让 StoreKit 2 更为出色的新功能首先我将回顾新的 StoreKit 框架功能然后我将分享一些使用 StoreKit 构建 SwiftUI App 的更新内容最后我将介绍 Xcode 中 StoreKit 测试的新功能我很高兴介绍一种全新的 Swift API 它自 iOS 16.4 启用用于管理推广的 App 内购买项目推广的 App 内购买项目是一种允许你在 App Store 产品页面上展示你的产品的功能每个产品都有一个专用的推广图片推广你的 App 内购买项目是增加产品可见性的一种很好的方式你可以在 App Store Connect 中轻松设置推广购买想进一步了解有关配置推广的 App 内购买项目的更多信息请查看 “App Store Connect 的新功能” 由于推广的 App 内购买项目在 App Store 上列出当客户购买推广产品时他们的交互从点击购买按钮开始然后 App Store 将购买数据发送到你的 App 你可以监听此信息并提示他们完成购买要监听推广购买请使用 Swift async sequence 每当客户在 App Store 为推广产品发起购买时该序列都会接收到一个新的购买意图首先创建一个监听器使用 PurchaseIntent.intents 来接收购买意图每次序列接收到一个新的对象时它都包含与购买相关的 StoreKit 产品你可以像往常一样通过调用 purchase() 来提示你的客户购买这些产品这将显示熟悉的付款表单让他们在那里完成交互如果你的 App 还没有准备好完成购买你也可以将购买意图保存在本地并推迟稍后可以随时处理

推广 App 内购买项目的另一个功能是能够自定义当前设备上的产品显示方式例如假设客户购买了其中一种产品你可以将其隐藏这样当客户浏览或搜索时 App Store 就不再显示你还能根据 App 的当前状态更改产品顺序或显示的产品子集例如游戏中的等级提升为了涵盖所有这些情况我很高兴向你展示一些新的 Swift API 你可以使用这些 API 来自定义推广的 App 内购买项目的顺序和可见性让我们来看一个快速演示导入 StoreKit 后你可以使用 Product.PromotionInfo.currentOrder 检查当前的推广顺序它返回一个按照当前设置顺序排列的 PromotionInfo 对象的序列如果此列表为空意味着没有为该设备设置本地覆盖 App Store 中显示的产品顺序与你在 App Store Connect 中配置的顺序相同这个序列中的每个对象都包含了关于 App 中推广的产品的信息要设置自定义推广顺序你可以使用 Product.PromotionInfo.updateProductOrder API 并按照在此设备上的 App Store 中你希望它们出现的顺序传递一个产品标识符列表你还可以隐藏或显示产品且无需设置全新的顺序通过更改与 App 内购买项目相关的可见性属性就可以做到可见性状态可以是可见的、隐藏的或默认的它遵循你在 App Store Connect 中配置的设置并适用于所有没有被你的 App 设置本地覆盖的设备让我们看看如何在代码中更改这些设置

可见性值可以通过几种不同的方式进行更改你的 App 可以调用 Product.PromotionInfo.updateProductVisibility API 并通过传递新的可见性状态和该 App 内购买项目的标识符来更改单个产品的值或者你还可以通过设置每个 PromotionInfo 对象上的成员属性来更改可见性值然后要保存更改请在刚刚修改过的对象上调用 update() 这就是你开始使用 StoreKit 2 进行推广的 App 内购买项目所需的全部内容现在我想向你展示 StoreKit 2 中对核心数据模型的一些改进

这些模型对于管理 App 内购买项目和相关信息非常有用例如购买日期和订阅状态我们深入了解下我们正添加到 Transaction 和 RenewalInfo 数据模型中的新字段这些字段带来了许多用户所请求的重要改进

第一个新字段是 storefront 它与 storefrontCountryCode 一起出现在 Transaction 模型中下个新字段称为 reason 它告诉你是客户发起的购买还是自动订阅续订的交易在 Product.SubscriptionInfo 下的 RenewalInfo 模型中有一个名为 nextRenewalDate 的新成员它告诉你何时处理此订阅续订所有这些新字段都适用于使用 Xcode 15 构建的 App 尽管最初是与 iOS 17 一起发布的但它们中的大多数也适用于之前的 iOS 版本前提是你使用的是 StoreKit 2 接下来我想谈谈 StoreKit Messages 以及我们刚刚添加的出色新功能我们在去年的 WWDC 2022 引入了 Message API 这是 App Store 向你的客户发送重要信息的一种方式 Messages 具有一个称为 reason 的值告诉你消息的目的你的 App 可以选择延迟或抑制消息例如如果显示消息会打断客户在交互过程中的操作你可能会希望延迟消息除此之外你的 App 启动时 StoreKit 会自动显示所有活动消息今年我们添加了一个名为 billingIssue 的新消息原因此消息自 iOS 16.4 启用当订阅由于计费问题无法续订时 App Store 会发送此消息 StoreKit 会显示一个计费问题对话框客户可以在不离开你的 App 的情况下解决问题这个新属性已在沙盒中启用以便给你时间进行测试请稍后在 Apple Developer 网站上查看有关何时为所有客户启用此功能的更新当 App Store 无法更新订阅时订阅进入计费重试状态有关如何在沙盒中测试此功能的详细信息请观看有关测试 App 内购买项目的 WWDC 讲座现在让我们回顾一些与安全相关的更新为了使 StoreKit 与现代安全实践保持同步我们正在将我们的收据签名证书从 SHA-1 迁移到 SHA-256 用于原始 StoreKit 收据现代的加密库如 OpenSSL 已经支持 SHA-256 如果你的 App 在设备上执行收据验证操作那么你需要确保它能正确处理新的证书新的 SHA-256 签名证书从 6 月 20 日开始将用于在沙盒中签署收据你将能够在运行 iOS 16.6 及 macOS 13.5 或更高版本的设备上进行测试 8 月 14 日后新的证书将用于为所有提交到 App Store 的新的 App 和 App 更新签署收据欲了解更多此时间表的详细信息可查看 Apple Developer 网站若你的 App 使用 StoreKit 2 你无需做任何操作 StoreKit 2 的签名交易、续订信息和 App 交易已在今天使用 SHA-256 如果你使用 App Store 服务器 API 进行收据验证你也无需进行任何更改因为我们会自动处理新的格式接下来我很高兴向你展示一整套 StoreKit 的全新功能该功能通过使用 SwiftUI 让营销 App 内购买项目变得非常简单快捷有些新的 API 可以为单个 App 内购买项目、整个产品商店甚至包括一些针对订阅的特定自定义商品创建 SwiftUI 视图这些视图类似于普通的 SwiftUI 视图实现起来所需的代码很少这让你能尽快启动和运行 App 让我们来看看这些新视图通过这个产品视图你可以展示一个单独的 App 内购买项目包括本地化的标题、描述文件甚至是可选的促销图片你可以通过将产品标识符传递给 ProductView 来创建它无需加载 StoreKit 产品你只需使用产品 ID 字符串即可 StoreKit 和 SwiftUI 会处理剩下的事情还有一个新的视图可以显示整个产品专题就像一个商店在你的 App 中与传递一个单个的产品标识符不同你可以使用产品 ID 专题与 StoreView 结合使用创建一个商品列表然后使用 SwiftUI 组件进一步自定义 StoreView 是一个很好的方式来启动你的 App 或游戏并支持 App 内购买项目因为它只需要几行代码来设置就像这里所示的一样最后同样重要的还有一个新视图可以展示订阅及其所有可用的服务级别使用 SubscriptionStoreView 快速创建自定义页面用于订阅组就像这个你只需要订阅组 ID 通常可以在 App Store Connect 中找到但现在也可以在 Xcode 的 StoreKit 配置中找到可以轻松将许多可能的自定义添加到这些新视图类型中例如看看如何通过改变几行代码来创建自定义背景如此就可以显著改变 SubscriptionStoreView 的外观随着这些新订阅变化我们还添加了一个额外的管理订阅的弹窗改善用户在 StoreKit App 中的订阅选择和互动方式我们来看看它

在这里你可以看到管理订阅的熟悉流程向用户展示一个带有当前活跃层级的弹窗并提供轻点每个层级的选项以查看该订阅组中其他可用的选项列表为了加快这个过程并提供更多的定制功能现在有另一种视图能让你跳过步骤直接进入你想展示的订阅群组你可以在你的 App 环境中选择相关的订阅群组例如若你有多个订阅群组并展示用户可选择的其他服务级别这个表格可以使用与常规表格相同的 API： .manageSubscriptionsSheet 同时需要在传递参数时额外添加 subscriptionGroupID 参数关于创建 SwiftUI App 的 StoreKit 还有更多要展示给你的内容包括其他视图和自定义选项你可以加以调整让其适应你的 App 的美学风格如果你想进一步了解更多信息 Greg 将在讲座 “认识 SwiftUI 的 StoreKit”中详细讲解在了解 StoreKit 中 App 内购买项目的新功能之后让我们看看如何使用 Xcode 中的新工具 StoreKit 测试来检验它们从 Xcode 15 开始使用 Xcode 中的 StoreKit 测试你能确保 App 使用 StoreKit 时无论是在你开始构建它之前还是之后都提供出色的体验甚至是你在 App Store Connect 设置任何内容之前这使得你可以在 Mac 上进行测试、管理、编辑甚至创建与 StoreKit 相关的操作同时在模拟器和设备上都支持首先是交易管理器它提供了用于调试和测试 App 的新功能现在它会组织所有你的测试 App 在导航器中你可以通过使用 StoreKit 配置进行测试查看所有当前连接的设备和模拟器这些设备和模拟器上安装了你当前的 StoreKit App 这样你就可以更轻松、更快速地在多个设备上同时进行测试而且不需要运行你的 App 来查看购买历史记录让我们来深入了解它的工作原理我将一台 iPhone 连接到我的 Mac 同时让模拟器保持运行我正在使用新的开发中的游戏 Backyard Birds 当你打开 Xcode 无论你是否打开了一个项目你都可以转到调试、 StoreKit、管理交易然后会出现交易管理器视图你已经熟悉了在导航器中你可以看到所有当前连接到你的 Mac 上的设备以我操作的情况为例这是实体 iPhone 和模拟器注意它们都在这个列表中显示了几个 App 包括 Backyard Birds 这些都是在 Xcode 中使用 StoreKit 测试的 App 你可以在调试会话之外检查它们在任一设备上点击一个 App 你可以看到该 App 的 StoreKit 交易列表并且通过去年介绍的 StoreKit 调试日志你可以选择查看特定交易的详细信息这也适用于我打开 Backyard Birds 的 Xcode 项目并在模拟器上运行它

在这种情况下我还可以看到哪个 App 正在进行调试因为 App 的名称旁边会有这个小指示器交易管理器的更新不止如此我很兴奋向你展示你现在可以通过使用 Xcode 从 Mac 直接为你的 App 进行 App 内购买项目此外在创建新的购买项目时你还可以自定义各种购买参数例如可消耗产品的数量或者你可以为订阅选择优惠码

让我们看看如何在实践中运作以使用 Backyard Birds 为例首先你要选择要测试的 App 然后点击筛选栏左侧的加号按钮创建一个新的购买项目弹出窗口中列出了所有适用于此 App 的可用的 App 内购买项目这些是我们在 StoreKit 配置中配置的相同产品首先我要购买一个可消耗品因此我可以选择 “营养饲料”并点击“下一步”

现在我有机会配置这个新的购买项目但如果我想跳过使用默认选项也是有效的我对这些设置感到满意因此让我们点击完成以使用这些参数完成购买

虽然 App 没有在模拟器运行但 StoreKit 已接收并处理了新的购买项目如果我查看交易列表顶部现在有一个新项目点击它我可以查看此新交易的详细信息然而订阅有所不同让我们进行另一个购买项目我将再次点击加号按钮创建一个新的购买项目然后这次我将搜索此 App 中的一个订阅名称然后选择我要找的那个并点击下一步

购买配置选项已经发生了变化因为这是一种不同类型的 App 内购买项目有些选项与以前相同如购买日期但也有一些新的选项我们来看看它们是如何使用的顺带一提默认属性在这里也适用

如果在 StoreKit 配置中进行了设置的话我可以为此订阅选择一个优惠码顾客需要输入优惠码和促销码但为了方便测试我们提供了可用优惠的列表供 productID 选择在这种情况下我想要修改购买日期将其设置为一年前的日期就像是去年的 WWDC 期间我首次订阅了此服务接下来我可以选择订阅是否该自动续订或者只保持订阅一个订阅周期对于这个产品来说一个订阅周期是一个月我想要保持自动续订功能开启这样我可以测试在我开始使用前 App 如何处理主动订阅让我们点击完成购买然后通过筛选交易列表来查看结果

正如预期的那样自去年以来每个月都有一次续订这些当前都标记为未完成因为 App 没有运行并且没有机会接收它们所以我将在模拟器中运行它并查看我现在是否可以访问 Backyard Birds Pass

交易管理器中的新功能适用于支持 Xcode 中的 StoreKit 测试的所有设备和平台从 iOS 17 和 macOS 14 开始它们也支持其他平台包括 iPadOS、watchOS 和 Apple tvOS 如果你正运行较旧版本的操作系统这对你来说没有任何变化当你在 Xcode 中进行激活调试会话时交易管理器仍兼容以前的所有功能接下来我想介绍 StoreKit 配置中的一个新功能它允许更深入地测试你的 StoreKit App 在不同情况下的行为为了演示这一点我将打开 Backyard Birds 的 Xcode 项目并转到 StoreKit 配置

现在在配置的 App 内购买项目上方有一个名为 Configuration Settings 的新项目这是我们添加的一个新菜单用于为你的 App 的测试环境提供可配置的选项其中包括一些你可能熟悉的选项以及从 Xcode 15 开始的一些新选项第一和第二部分涵盖所有现有选项例如用于设置价格与销售范围的 App 使用的默认商店和默认区域当使用活动的调试会话时交易管理器仍与之前的所有相同功能兼容在 Xcode 的较早版本中你可以在编辑菜单中找到这些选项当你打开 StoreKit 配置时它们仍然存在并且可以互换使用当我们谈论 StoreKit 测试选项时在 iOS 16.4 中我们新增了新的订阅续订率这些续订率被设计用于在每次续订时更改订阅的到期时间帮助你更快地生成一致的续订而不需要等待实际订阅期限这对于快速而可靠地测试订阅的长期状态非常有用你可以在编辑菜单和 Xcode 15 的 StoreKit 配置设置中找到这些新的可配置续订率 StoreKit 配置设置中的第三部分涵盖了你可以在 App 中模拟 StoreKit 错误的选项这是许多人强烈要求的功能它扩展了以前在编辑菜单中的 Fail Transactions 子菜单并支持更多的 StoreKit API 和错误类型每个选项代表着你的 App 可能正在使用的 StoreKit 2 API 它允许你选择 API 应该抛出的错误每次你的 App 调用该 API 时都会出现这个错误此功能支持许多 API 你可以通过它测试产品加载问题、购买失败、收据和交易验证问题、退款请求等等现在让我们看看在实际操作中是怎样的

我在左侧打开了 Backyard Birds 的 Xcode 项目右侧运行着模拟器中的 App 在 StoreKit 配置中我可以使用复选框启用购买错误它就在购买 API 名称旁然后选择应该抛出的错误

我想测试当用户更改商店时 App 如何处理购买因此我将选择产品不可用

该文件在编辑时会自动保存并在 App 运行时同步到你的设备上因此你可以立即测试更改无需重新运行 App 让我们尝试购买一个产品看看会发生什么

果不其然它失败了它告诉我无法购买此产品并建议我联系开发人员获取更多信息

现在让我们禁用购买错误再次尝试确保这次可以成功完成

通过这些步骤我已经有效地测试了这个 App 的代码可以处理在进行购买时可能发生的各种错误这种方法可以应用于 StoreKit 配置设置中的任何 API 和错误选项以覆盖多种情况还能确保你的 App 稳健可靠这些错误都是 StoreKit 的一部分你可能已经遇到过它们每一个都代表了你的 App 中的一个明确的失败案例这就是 Xcode 中 StoreKit 测试的所有新功能今天我展示了如何在调试会话之外的多个设备上检查和管理交易如何使用事务管理器购买产品以测试你的 App 处理现有购买的能力以及如何模拟 StoreKit 错误以覆盖多种可能的失败场景

所有这些 Xcode 中的新功能也可以在代码中使用 StoreKit Test 框架为你的 App 编写单元测试这样你可以编写自动化脚本来执行所有相同的任务让我们来看看创建离线购买并在 XCTest 会话中设置模拟错误的新 API 要创建新的 App 内购买项目 StoreKitTest 中有个新的 Swift API 它的使用方式与 StoreKit 的 purchase(_:) API 相同并且具有相同的购买选项为了支持新的购买功能如更改购买日期我们还为测试添加了仅限购买的新选项让我们看一个示例设置 SKTestSession 后我正在进行离线购买购买的是一个订阅并将购买日期设置为一年前的今天这与我在事务管理器中所做的购买完全相同操作也完全相同使你能够创建可重复的结果并自动化测试你的 App 这里是关于 StoreKitTest 中的一些新的 API 用于模拟 SKTestSession 中的 StoreKit 错误它们的工作方式与模拟错误的 StoreKit 配置设置相同创建测试会话后你可以调用 setSimulatedError 方法并传入你想要测试的错误类型以及应该模拟的 StoreKit API 在此示例中我选择模拟 loadProducts API 的网络错误在这个测试中每次调用 loadProducts API 时都会抛出相同的错误要禁用模拟的故障使用相同的 setter API 并将错误类型替换为 nil 此外还有用于新的订阅续订率的 API 可以通过 SKTestSession 中的 timeRate 成员以相同的方式访问它们在这个示例测试中为了进行订阅购买我添加了一行额外的代码来设置更快的续订率并快速生成多个续订今天介绍了很多 Xcode 中新的 StoreKit 和 StoreKit 测试功能在 StoreKit 中有新的 API 来支持推广 App 内购买项目 Transaction 和 RenewalInfo 的数据模型得到一些强化以便为你提供更有价值的信息还有一种新的消息类型你可以侦听以处理计费问题 SwiftUI 中的新的 StoreKit 视图是一个很好的工具它可以快速构建支持产品推广的 App 并且无需额外的代码即可在所有设备上运行最后你可以使用 Xcode 中提供的 StoreKit 测试工具验证你 App 中的所有 StoreKit 功能 StoreKit 2 具有许多出色的功能让你能够构建令人赞叹的 App 并发展业务我们添加了许多充分利用 Swift 的工具并且通过简单强大的全新 API 让你有机会更加专注于为客户打造的体验任何想要推广产品和订阅的 App 现在都可以使用 StoreKit 2 来构建如果你尚未使用 StoreKit 2 不妨试试看如果已经使用请告诉我们你对我今天展示的新功能的看法在现有 App 中使用新的 App 内购买项目推广视图以进一步定制体验或者完全使用这些新的 API 来创建一个全新的 App 而且通过 Xcode 中的 StoreKit 测试你可以对代码进行测试并确保一切正常并符合预期以便在各种条件下为客户提供最佳体验有关其他 StoreKit 功能的更多信息请查看以下链接的讲座我们期待着看到你使用 StoreKit 2 创造作品感谢观看

1:42 - Create a listener for promoted in-app purchases

// Create a listener for promoted in-app purchases
import StoreKit

let promotedPurchasesListener = Task {
    for await promotion in PurchaseIntent.intents {
        // Process promotion
        let product = promotion.product

        // Purchase promoted product
        do {
            let result = try await product.purchase()
            // Process result
        }
        catch {
            // Handle error
        }
    }
}

2:57 - Check promotion order

// Check promotion order
import StoreKit

do {
    let promotions = try await Product.PromotionInfo.currentOrder

    if promotions.isEmpty {
        // No local promotion order set
    }

    for promotion in promotions {
        let productID = promotion.productID
        let productVisibility = promotion.visibility
        // Check promoted products
    }
}
catch {
    // Handle error
}

3:26 - Set a promotion order

// Set a promotion order
import StoreKit

let newPromotionOrder: [String] = [
    "acorns.individual",
    "nectar.cup",
    "sunflowerseeds.pile"
]

do {
    try await Product.PromotionInfo.updateProductOrder(byID: newPromotionOrder)
}
catch {
    // Handle error
}

4:02 - Update promotion visibility

// Update promotion visibility
import StoreKit

// Hide “acorns.individual”
do {
    try await Product.PromotionInfo.updateProductVisibility(.hidden, for: "acorns.individual")
}
catch {
    // Handle error
}

4:17 - Update promotion visibility (alternative method)

// Update promotion visibility
import StoreKit

do {
  let promotions = try await Product.PromotionInfo.currentOrder

  // Hide the first product
  if var firstPromotion = promotions.first {
    firstPromotion.visibility = .hidden
    try await firstPromotion.update()
  }
}
catch {
  // Handle error
}

8:32 - Product view

// Product view
import SwiftUI
import StoreKit

struct BirdFoodShop: View {
    let productID: String
    let productImage: String

    var body: some View {
        ProductView(id: productID) {
            BirdFoodProductIcon(for: productID)
        }
        .productViewStyle(.large)
    }
}

8:52 - Store view

// Store view
import SwiftUI
import StoreKit

struct BirdFoodShop: View {
    let productIDs: [String]

    var body: some View {
        StoreView(ids: productIDs) { product in
            BirdFoodIcon(productID: product.id)
        }
    }
}

9:19 - Subscription view

// Subscription view
import SwiftUI
import StoreKit

struct BackyardBirdsPassShop: View {
    let groupID: String

    var body: some View {
        SubscriptionStoreView(groupID: groupID)
    }
}

21:09 - Simulated off-device purchase using StoreKitTest

// Simulated off-device purchase using StoreKitTest
import StoreKit
import StoreKitTest

func testSubscriptionRenewal() async throws {
    let session = try SKTestSession(configurationFileNamed: "Store")

    let oneYearInterval: TimeInterval = (365 * 24 * 60 * 60)
    let transaction = try await session.buyProduct(
        identifier: "birdpass.individual",
        options: [
            .purchaseDate(Date.now - oneYearInterval)
        ]
    )

    // Inspect transaction
}

21:48 - Set a simulated purchase error when loading products

// Set a simulated purchase error when loading products
import StoreKit
import StoreKitTest

func testLoadProducts() async throws {
    let session = try SKTestSession(configurationFileNamed: "Store")
    let productIDs = [
        "acorns.individual",
        "nectar.cup"
    ]

    // Set a simulated error, then load products, expecting an error
    session.setSimulatedError(.generic(.networkError), forAPI: .loadProducts)
    do {
        _ = try await Product.products(for: productIDs)
        XCTFail("Expected a network error")
    }
    catch StoreKitError.networkError(_) {
        // Expected error thrown, continue...
    }
    // Disable simulated error
    session.setSimulatedError(nil, forAPI: .loadProducts)
}

22:24 - Set a faster subscription renewal rate in a test session

// Set a faster subscription renewal rate in a test session
import StoreKit
import StoreKitTest

func testSubscriptionRenewal() async throws {
    let session = try SKTestSession(configurationFileNamed: "Store")

    // Set renewals to expire every minute
    session.timeRate = .oneRenewalEveryMinute

    let transaction = try await session.buyProduct(identifier: "birdpass.individual")

    // Wait for renewals and inspect transactions
}

正在查找特定内容？在上方输入一个主题，就能直接跳转到相应的精彩内容。