认识面向 Swift 的 MusicKit

MusicKit 可将 Apple 音乐轻松集成到您的 app 中。探索基于 Swift 的框架：我们将向您介绍使用 MusicKit 的基本流程，包括如何查找、请求和播放内容，并向您展示当用户尚未注册 Apple Music 时如何将音乐订阅工作流集成到您的 app 中。

资源

相关视频

WWDC22

借助 MusicKit 探索更多内容

WWDC21

下载

哈啰欢迎来到WWDC 我是乔尔我要告诉你如何用MusicKit为你的应用程序新增音乐 MusicKit是Apple平台的新架构它能让你的应用程序通过表达式API 在Swift内存取音乐它用新的Swift并发语句而且是从最基础开始就是基于SwiftUI的 MusicKit加速你的应用程序与Apple Music API整合的方式也就是服务器端API 用来从Apple Music存取宽排列的目录内容让你可以更轻松的构建引人入胜的应用程序，并且与Apple Music联系起来首先我们来聊聊如何用MusicKit 请求音乐内容接着我们来聊聊其他对你的应用程序与Apple Music整合方式重要的话题像是请求用户同意你的应用程序存取Apple Music相关资料管理存取Apple Music API 需要的密钥令牌存取订阅信息和相关性能从Apple Music目录播放音乐以及最后如何显示Apple Music的订阅方案提议万一你的用户还不是订阅者 MusicKit为取用音乐项目提供全新模型层用结构式请求让你能从Apple Music API 索取内容你也可以在Apple Music目录中搜寻内容或基于特定筛选器索取资源这些请求产生在集合中群组的项目的响应带有内建分页让你从初始回应取得下一批项目那么这些音乐项目长什么样子呢？我们用一张专辑来看看一个特定案例 “专辑”是一个值类型，并且分组成三组不同类别的属性第一个类别包含简易属性像是字符串属性如“title” 布尔属性如“isCompilation” 或更多架构式属性如“artwork” 让你存取作品的键接连同相关尺寸信息和有关的颜色专辑也提供多种关系像是相关的歌手或风格或指定专辑中歌曲的清单例如 “tracks”的关系结果是一系列“Track”类型的值就是音乐项目的另一个类型最后除了这些模型层级的强关系 “专辑”还提供几个相关内容较弱的关联关联和关系非常相似但它们通常比较短暂或是更受编辑上的驱使举例来说专辑上的 “appearsOn”关联回传一系列播放列表但不像关系集合这也有个标题使用MusicKit加载和存取关系非常简单举一张专辑为例你能轻松地索取同样这张专辑的另一个说明包含“歌手” 和“歌曲” 以及关联像“有关的专辑”在单一作业中 “with”方法需要用特别的Swift 关键词“await”被呼叫代表这会在背后执行异步作业这确实会通过网络从Apple Music API 索取这张专辑更完整的说明然后你就能取得这个包含细节的专辑的歌曲清单并迭代那些歌曲如同用一般数组的作法这是控制台给这段代码产出存取关联像是“相关专辑” 做法相同唯一差别在它们通常还包含一个标题在集合上能直接取用然后你就能用相同方式迭代集合印出一些相关专辑这是控制台给这段代码产出现在我们来看看向MusicKit请求音乐内容的展示我在建置让我能从Apple Music 找到并享受专辑的应用程序我可以用这个搜寻栏寻找专辑这已经与一些代码连结来配对搜寻结果使用音乐目录搜寻请求这个应用程序也能纪录我最近检视过的专辑我们能通过搜寻找到这张叫“抓住这氛围-单曲”专辑的更多信息而你可能有注意到这张专辑的歌曲清单在细节检视出现后变得有生气这是通过加载我们看到的这张专辑的 “歌曲”关系并为SwiftUI检视更新状态变量这接着用来填充清单我们能开始播放这张专辑的音乐按歌曲下方的播放按钮或通过选择特定歌曲这让使用Musickit的回放API 用这些歌曲的列表来设定队列和呼叫播放器上的播放方法变简单我们来试试！如果我选择卡伦和梦布鲁的歌曲名“抓住这氛围” 这首歌开始播放 ♪喔喔不♪ 我们的应用程序甚至在锁屏时自动在媒体控制中运作让我能刷到这首歌的中段

但我原先是希望用这个用应用程序帮我从我的CD库重新发现老音乐像是来自凤凰的这张专辑所以我想新增一个功能让我用iPhone相机对准老CD的条形码让这个应用程序浮现相同专辑的数字版我已经这个功能新增一些实验性代码当我启用它可以看到一个条形码按钮在底部这能展开相机检视如果我对准这张CD的条形码它会自动辨识条形码值并显示出来我还缺的就只有一些使用MusicKit 来找对应专辑的代码我们开始把那些加进应用程序中选择制作一个albumsRequest 使用MusicCatalogResourceRequest 我只要找专辑

我想确保我们找到的专辑是 UPC属性也就是通用产品代码这是条形码的技术术语是等于detectedBarcode 我可以异步地执行这个请求

albumsRequest.response

然后根据响应我可以在结果中寻找第一个专辑

我可以接着送这第一张专辑给handleDetectedAlbum 下方的helper方法

handleDetectedAlbum（firstAlbum）

这个方法忽略了条形码扫描检视并推送侦测到专辑的细节

它被标示在MainActor 来确保它在主线程会执行当我们呼叫时,需要确保加上await关键词

我们建置再次执行应用程序试试看

点条形码按钮拿我的专辑

成功了！

现在要在Apple Music享受我的旧音乐的数字版容易多了 MusicKit还提供通用目的数据请求这跟结构式请求不同里面让你从随意的 Apple Music API顶点使用键接加载内容

你会从这个请求得到的是从Apple Music API的 JSON响应原始数据你需要用JSON解码器解码这个原始数据但做这不用很困难因为你可以利用既有的音乐项目类型因为它们遵守Codable规则我们来看个范例如果你想要从Apple Music加载最高层风格的清单你可以通过加载这个特定键接的内容来做到这是对应的JSON回应如果你近一步看这个结果能看见中间有看起来像风格资源的东西你会如何在Swift中表现它？当然，MusicKit有风格类型回到这你会如何在Swift表现整个回应？你可以创造一个结构用数据成员这是一个简单的风格数组接着确保标记这个结构为可解码这甚至不需要写任何其他解码逻辑因为“风格”本身也遵照可解码所以要在应用程序加载这些数据你得放这个结构在你的档案最上方接着你得为你的用户用特定国家代码来建构键接用这个键接创造音乐数据请求并从那得到响应随之是我们已经看过的相同模式一旦你得到那个响应你可以用JSON解码器解码它的数据通过传MyGenresResponse类型进到解码方法就完成了！你现在可以存取个别风格在你的强烈类型区别的风格中如你所见你能用能在MusicKit 其他请求索取的同类音乐项目这就是你如何从Apple Music API 从随机键接加载内容的方式现在我们知道如何加载音乐内容我们来讨论一些整合Apple Music 和你的应用程序的重要前置步骤从隐私权开始我们希望用户能持有什么应用程序能存取他们的数据的控制权在你能从Apple Music API 请求任何数据前这可能包含用户的聆听历史纪录或他们的音乐库你需要取得用户被告知的许同意让你的应用程序存取Apple Music 询问该用户的内容是每个装置每个应用程序都需要执行的这是用户同意对话在一个叫Zova的应用程序中呈现的样子这是一个很棒的健身应用程序让你跟着它在Apple Music上的播放列表或你自己的播放列表运动当你第一次进入开始运动 Zova询问存取Apple Music的权限这个对话需要向用户传达为何你的应用程序需要存取Apple Music 为此应用程序的Apple Music 用途说明也是你需要定义在Info.plist的含在这个对话的子标题中这是一个你为Musickit请求用户同意方式的范例假如你的应用程序中有个功能需要MusicKit 你用isAuthorizedForMusicKit 状态变量控制这个功能的存取在你应用程序中合适的位置尝试用MusicKit之前你能用异步请求方法请求授权存取Apple Music 这只会向还没授权的用户提示这个请求方法回传一个状态值你可以设定你的 isAuthorizedForMusicKit变量为“真” 如果这个状态等于“已授权” 我们来简短聊聊Apple Music API 加载数据需要的令牌 Apple Music API需要开发者令牌这也就用API授权你的应用程序在之前要取得这个开发者令牌你得在开发者入口网站创建 MusicKit私钥放进你控制的服务器中来确保密钥是私密的并让应用程序从服务器请求新的开发者密钥而现在有了Swift的MusicKit 你不再需要担心这些因为它会自动为你的应用程序产生开发者密钥你只需要投过开发者入口网站登录来选择这个新的自动方式确切来说在注册应用程序ID的页面选择底部的应用程序服务分页并勾选起MusicKit 就完成了！此外 Apple Music API需要用户密钥来做任何个人化端点如同开发者密钥今年的新调整用户密钥会自动帮你产生另个你可能需要在应用程序用MusicKit使用的是确认你的用户是否有有效的Apple Music订阅在MusicKit的订阅信息揭露成三个特殊的能力能告诉你用户是否能从Apple Music 目录播放内容用户是否开启iCloud音乐库或他们是否能成为订阅者万一他们尚未有有效的订阅

记得要为你应用程序中特定Apple Music相关的功能检查相关能力譬如你有个播放按钮链接来播放音乐你可能要让它不能用万一你的用户不能从Apple Music播放目录内容你可以在检视中定义一个状态变量追踪音乐订阅接着你可以应用停用调节器在你的按钮来确保它维持停用假如音乐订阅属性 “无法播放目录内容”为“否” 最后在异步块中传给新任务调节器你可以用新的“订阅更新”串流在音乐订阅异动时被通知我们来谈用MusicKit回放 MusicKit提供两个特殊的播放器我们称作SystemMusicPlayer 和ApplicationMusicPlayer 我们用一个范例来看两者之间的差异虽然社群媒体应用程序可能希望用 SystemMusicPlayer改变系统音乐应用程序正在播放的内容健身应用程序可能倾向用 ApplicationMusicPlayer 维持它们的回放状态与系统音乐应用程序完全独立两个播放器自动回报正在播放的信息并控制远程指令这让我们能在锁屏时与系统媒体控制深度整合稍早的展示有说到然而正在播放的应用程序是用不同方式回报假如你用SystemMusicPlayer 音乐应用程序会回报为正在播放的应用程序但若用ApplicationMusicPlayer 你的应用程序会回报为正在播放的应用程序回放队列所有权也不同在SystemMusicPlayer 你的应用程序仅远程控制系统音乐应用程序而在ApplicationMusicPlayer 你的应用程序拥有完全分离的回放队列两个编辑器都让你用一个或更多项目设定队列新增一个项目下个播放或稍后播放但只有ApplicationMusicPlayer 让你控制回放队列让你在中间插入项目或移除先前已经加过的项目最后如果你的用户还不是 Apple Music订阅用户你可能要允许他们从你的应用程序开始Apple Music免费试用这样他们就能享受你在应用程序中用音乐加强的用户体验全面功能订阅优惠可以通过自定义显示给用户的主信息设定更加呼应你应用程序的功能像playMusic

它也能是语境上的强调特定歌曲、专辑或播放列表

通过使用你应用程序的订阅优惠表单你能因为带来新Apple Music 订阅用户受奖励通过我们的联盟计划我们称为Apple服务效能伙伴计划要在你的应用程序展示语境上的音乐订阅优惠你会需要追踪音乐订阅如我们稍早所见你会需要另个状态变量追踪这个优惠是否有显示出来传送专辑的ID 在你的订阅优惠选项作为itemID属性让优惠按钮维持停用每当canBecomeSubscriber 在音乐订阅上为“否” 接着用音乐订阅优惠调节器绑定isShowingOffer属性并包含你的选项最后设定isShowingOffer 变量为“真” 我们响应用程序看看给Apple Music的语境优惠长什么样子在稍早的展示中我们已经用有效的 Apple Music订阅登入因此要激活这个情境让它能正常显示Apple Music的订阅优惠你可以到设定注销你的账号

接着如果我回到应用程序你能看到播放按钮已经停用并移到左边让出空间给另个按钮来邀请用户加入Apple Music 如果我点这个按钮订阅优惠就会出现强调我们刚才在应用程序看过的专辑这就是你能如何让用户从你的应用程序开始Apple Music 免费试用的方法总结来说有多种类型的应用程序能通过加上一些音乐来增强它们的部分体验例如通过播放适合你的游戏风格的背景音乐你可以让游戏更沉浸式或你可以播放雀跃的音乐在运动应用程序中让用户持续被鼓舞在社群媒体应用程序你能用强调出内容的音乐来提升用户的互动性

想了解更多记得去看相关的会话你就能学习如何用ShazamKit掌握 Shazam的力量并深度了解SwiftUI的并发谢谢你的收看有个美好的WWDC 2021！ [音乐]

2:56 - Loading and accessing relationships

// Loading and accessing relationships

let detailedAlbum = try await album.with([.artists, .tracks, .relatedAlbums])
print("\(detailedAlbum)")

if let tracks = detailedAlbum.tracks {
    print("  Tracks:")
    tracks.prefix(2).forEach { track in
        print("    \(track)")
    }
}

3:31 - Loading and accessing associations

// Loading and accessing associations

let detailedAlbum = try await album.with([.artists, .tracks, .relatedAlbums])
print("\(detailedAlbum)")

if let relatedAlbums = detailedAlbum.relatedAlbums {
    print("  \(relatedAlbums.title ?? ""):")
    relatedAlbums.prefix(2).forEach { relatedAlbum in
        print("    \(relatedAlbum)")
    }
}

9:02 - Loading top level genres

// Loading top level genres

struct MyGenresResponse: Decodable {
    let data: [Genre]
}

let countryCode = try await MusicDataRequest.currentCountryCode
let url = URL(string: "https://api.music.apple.com/v1/catalog/\(countryCode)/genres")!

let dataRequest = MusicDataRequest(urlRequest: URLRequest(url: url))
let dataResponse = try await dataRequest.response()

let decoder = JSONDecoder()
let genresResponse = try decoder.decode(MyGenresResponse.self, from: dataResponse.data)
print("\(genresResponse.data[9])")

10:49 - Requesting user consent for MusicKit

// Requesting user consent for MusicKit

@State var isAuthorizedForMusicKit = false

func requestMusicAuthorization() {
    detach {
        let authorizationStatus = await MusicAuthorization.request()
        if authorizationStatus == .authorized {
            isAuthorizedForMusicKit = true
        } else {
            // User denied permission.
        }
    }
}

12:54 - Using music subscription to drive state of a play button

// Using music subscription to drive state of a play button

@State var musicSubscription: MusicSubscription?

var body: some View {
    Button(action: handlePlayButtonSelected) {
        Image(systemName: "play.fill")
    }
    .disabled(!(musicSubscription?.canPlayCatalogContent ?? false))
    .task {
        for await subscription in MusicSubscription.subscriptionUpdates {
            musicSubscription = subscription
        }
    }
}

15:34 - Showing contextual music subscription offer

// Showing contextual music subscription offer

@State var musicSubscription: MusicSubscription?
@State var isShowingOffer = false

var offerOptions: MusicSubscriptionOffer.Options {
    var offerOptions = MusicSubscriptionOffer.Options()
    offerOptions.itemID = album.id
    return offerOptions
}

var body: some View {
    Button("Show Subscription Offers", action: showSubscriptionOffer)
        .disabled(!(musicSubscription?.canBecomeSubscriber ?? false))
        .musicSubscriptionOffer(isPresented: $isShowingOffer, options: offerOptions)
}

func showSubscriptionOffer() {
    isShowingOffer = true
}

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