此页面由 Cloud Translation API 翻译。

AndroidX Media3 迁移指南

当前使用独立 com.google.android.exoplayer2 库和 androidx.media 的应用应迁移到 androidx.media3。使用迁移脚本将 Gradle build 文件、Java 和 Kotlin 源文件以及 XML 布局文件从 ExoPlayer 2.19.1 迁移到 AndroidX Media3 1.1.1。

概览

在迁移之前，请查看以下部分，详细了解新 API 的优势、要迁移的 API 以及应用的项目应满足的前提条件。

为什么要迁移到 Jetpack Media3

它是 ExoPlayer 的新家，而 com.google.android.exoplayer2 已停用。
使用 MediaBrowser/MediaController 跨组件/进程访问 Player API。
使用 MediaSession 和 MediaController API 的扩展功能。
通过精细的访问权限控制通告播放功能。
移除 MediaSessionConnector 和 PlayerNotificationManager，简化应用。
与 media-compat 客户端 API 向后兼容 (MediaBrowserCompat/MediaControllerCompat/MediaMetadataCompat)

用于迁移到 AndroidX Media3 的媒体 API

ExoPlayer 及其扩展程序
这包含旧版 ExoPlayer 项目的所有模块，但已停用的 mediasession 模块除外。依赖于 com.google.android.exoplayer2 中软件包的应用或模块可以使用迁移脚本进行迁移。
MediaSessionConnector（取决于 androidx.media:media:1.4.3+ 的 androidx.media.* 软件包）
移除 MediaSessionConnector 并改用 androidx.media3.session.MediaSession。
MediaBrowserServiceCompat（取决于 androidx.media:media:1.4.3+ 的 androidx.media.* 软件包）
将 androidx.media.MediaBrowserServiceCompat 的子类迁移到 androidx.media3.session.MediaLibraryService，将使用 MediaBrowserCompat.MediaItem 的代码迁移到 androidx.media3.common.MediaItem。
MediaBrowserCompat（取决于 androidx.media:media:1.4.3+ 的 android.support.v4.media.* 软件包）
使用 MediaBrowserCompat 或 MediaControllerCompat 迁移客户端代码，以将 androidx.media3.session.MediaBrowser 与 androidx.media3.common.MediaItem 一起使用。

前提条件

确保您的项目受源代码控制

确保您可以轻松还原通过脚本迁移工具应用的更改。如果您还没有将您的项目控制在源代码控制之下，现在就是开始使用它的绝佳时机。如果由于某种原因您不想这样做，请在开始迁移之前备份项目。
更新应用
- 我们建议您更新项目以使用最新版本的 ExoPlayer 库，并移除对已废弃方法的任何调用。如果您打算使用脚本进行迁移，则需要将要更新的版本与脚本处理的版本相匹配。
- 将 compileSdkVersion 提高到至少 32。
- 将 Gradle 和 Android Studio Gradle 插件升级到支持上述更新后的依赖项的最新版本。例如：
  - Android Gradle 插件版本：7.1.0
  - Gradle 版本：7.4
- 替换所有使用星号 (*) 的通配符 import 语句，并使用完全限定的 import 语句：删除通配符导入语句，然后使用 Android Studio 导入完全限定的语句（F2 - Alt/Enter、F2 - Alt/Enter 等）。
- 从 com.google.android.exoplayer2.PlayerView 迁移到 com.google.android.exoplayer2.StyledPlayerView。系统必须执行此操作，因为 AndroidX Media3 中没有与 com.google.android.exoplayer2.PlayerView 等效的功能。

迁移支持脚本的 ExoPlayer

该脚本有助于从 com.google.android.exoplayer2 迁移到 androidx.media3 下的新软件包和模块结构。该脚本会对您的项目进行一些验证检查，并在验证失败时输出警告。否则，它会在用 Java 或 Kotlin 编写的 Android Gradle 项目的资源中应用重命名的类和软件包的映射。

usage: ./media3-migration.sh [-p|-c|-d|-v]|[-m|-l [-x <path>] [-f] PROJECT_ROOT]
 PROJECT_ROOT: path to your project root (location of 'gradlew')
 -p: list package mappings and then exit
 -c: list class mappings (precedence over package mappings) and then exit
 -d: list dependency mappings and then exit
 -l: list files that will be considered for rewrite and then exit
 -x: exclude the path from the list of file to be changed: 'app/src/test'
 -m: migrate packages, classes and dependencies to AndroidX Media3
 -f: force the action even when validation fails
 -v: print the exoplayer2/media3 version strings of this script
 -h, --help: show this help text

使用迁移脚本

从 GitHub 上的 ExoPlayer 项目的标记下载迁移脚本，该标记与您将应用更新到的版本相对应：
```
curl -o media3-migration.sh \
  "https://raw.githubusercontent.com/google/ExoPlayer/r2.19.1/media3-migration.sh"
```
将脚本设为可执行：
```
chmod 744 media3-migration.sh
```
使用 --help 运行脚本以了解相关选项。
使用 -l 运行脚本以列出选择进行迁移的文件集（使用 -f 强制列出而不显示警告）：
```
./media3-migration.sh -l -f /path/to/gradle/project/root
```
使用 -m 运行脚本，以将软件包、类和模块映射到 Media3。使用 -m 选项运行脚本会将更改应用于所选文件。
- 在出现验证错误时停止，但不进行更改
```
./media3-migration.sh -m /path/to/gradle/project/root
```
- 强制执行
如果脚本发现违反前提条件的情况，可以使用 -f 标志强制迁移：
```
./media3-migration.sh -m -f /path/to/gradle/project/root
```

 # list files selected for migration when excluding paths
 ./media3-migration.sh -l -x "app/src/test/" -x "service/" /path/to/project/root
 # migrate the selected files
 ./media3-migration.sh -m -x "app/src/test/" -x "service/" /path/to/project/root

使用 -m 选项运行脚本后，完成以下手动步骤：

检查脚本对代码进行了怎样的更改：使用 diff 工具并修复潜在问题（如果您认为脚本存在没有传递 -f 选项而引入的一般性问题，请考虑提交错误）。
构建项目：使用 ./gradlew clean build 或在 Android Studio 中依次选择 File > Sync Project with Gradle Files，然后依次选择 Build > Clean project、Build > Rebuild project（在 Android Studio 的“Build - Build Output”标签页中监控 build）。

建议的后续步骤：

解决选择接受与使用不稳定 API 相关的错误的问题。
替换已弃用的 API 调用：使用建议的替代 API。将指针悬停在 Android Studio 中的警告上，并查看已废弃符号的 JavaDoc，以找到用于代替特定调用的内容。
对导入语句进行排序：在 Android Studio 中打开项目，然后右键点击项目查看器中的软件包文件夹节点，并在包含更改后的源文件的软件包上选择 Optimize imports。

将 `MediaSessionConnector` 替换为 `androidx.media3.session.MediaSession`

在旧版 MediaSessionCompat 环境中，MediaSessionConnector 负责将玩家状态与会话状态同步，并从需要委托给相应玩家方法的控制器接收命令。对于 AndroidX Media3，此操作由 MediaSession 直接完成，无需连接器。

移除 MediaSessionConnector 的所有引用和用法：如果您使用自动脚本迁移 ExoPlayer 类和软件包，则该脚本可能会使代码处于不可编译状态，导致 MediaSessionConnector 无法解析。当您尝试构建或启动应用时，Android Studio 会显示损坏的代码。
在用于维护依赖项的 build.gradle 文件中，将一个实现依赖项添加到 AndroidX Media3 会话模块并移除旧版依赖项：
```
implementation "androidx.media3:media3-session:1.3.1"
```
将 MediaSessionCompat 替换为 androidx.media3.session.MediaSession。
在创建旧版 MediaSessionCompat 的代码网站上，使用 androidx.media3.session.MediaSession.Builder 构建 MediaSession。传递玩家以构建会话构建器。

注意：如果您的应用使用的播放器与 ExoPlayer 不同，您需要一个自定义 Player 实现，您可以将其传递给封装播放器的 MediaSession。我们将围绕与媒体会话实现配合使用的最小 Player 实现提供更多指导。
```
val player = ExoPlayer.Builder(context).build()
mediaSession = MediaSession.Builder(context, player)
    .setSessionCallback(MySessionCallback())
    .build()
```
注意：您可以通过将 Player 封装在 ForwardingPlayer(player) 中来拦截其任何方法调用。
根据应用的要求实现 MySessionCallback。这是可选的。如果要允许控制器向播放器添加媒体项，请实现 MediaSession.Callback.onAddMediaItems()。它提供各种当前和旧版 API 方法，这些方法以向后兼容的方式将媒体项添加到播放器以进行播放。这包括 Media3 控制器的 MediaController.set/addMediaItems() 方法以及旧版 API 的 TransportControls.prepareFrom*/playFrom* 方法。您可以在会话演示应用的 PlaybackService 中找到 onAddMediaItems 的实现示例。
在迁移前销毁会话的代码站点上释放媒体会话：
```
mediaSession?.run {
  player.release()
  release()
  mediaSession = null
}
```
注意：请务必先释放媒体会话，然后再创建具有相同 ID 的新媒体会话。如果应用泄露会话实例，Media3 会抛出异常。

Media3 中的 `MediaSessionConnector` 功能

下表显示了用于处理先前在 MediaSessionConnector 中实现的功能的 Media3 API。

MediaSessionConnector	AndroidX 媒体 3
`CustomActionProvider`	`MediaSession.Callback.onCustomCommand()/ MediaSession.setCustomLayout()`
`PlaybackPreparer`	`MediaSession.Callback.onAddMediaItems()` （`prepare()` 在内部调用）
`QueueNavigator`	`ForwardingPlayer`
`QueueEditor`	`MediaSession.Callback.onAddMediaItems()`
`RatingCallback`	`MediaSession.Callback.onSetRating()`
`PlayerNotificationManager`	`DefaultMediaNotificationProvider/ MediaNotification.Provider`

将 `MediaBrowserService` 迁移到 `MediaLibraryService`

AndroidX Media3 引入了 MediaLibraryService 来取代 MediaBrowserServiceCompat。MediaLibraryService 及其超类 MediaSessionService 的 JavaDoc 提供了对该服务 API 及异步编程模型的介绍。

MediaLibraryService 向后兼容 MediaBrowserService。连接到 MediaLibraryService 时，使用 MediaBrowserCompat 或 MediaControllerCompat 的客户端应用可以在不更改代码的情况下继续运行。对于客户端，您的应用使用的是 MediaLibraryService 还是旧版 MediaBrowserServiceCompat，这一点是透明的。

包含服务、activity 和外部应用的应用组件示意图。 — **图 1**：媒体应用组件概览

为确保向后兼容性，您需要在 AndroidManifest.xml 中向您的服务注册这两个服务接口。通过这种方式，客户端会通过所需的服务接口找到您的服务：

<service android:name=".MusicService" android:exported="true">
    <intent-filter>
        <action android:name="androidx.media3.session.MediaLibraryService"/>
        <action android:name="android.media.browse.MediaBrowserService" />
    </intent-filter>
</service>

在用于维护依赖项的 build.gradle 文件中，将一个实现依赖项添加到 AndroidX Media3 会话模块并移除旧版依赖项：
```
implementation "androidx.media3:media3-session:1.3.1"
```
将您的服务更改为从 MediaLibraryService 继承，而不是从 MediaBrowserService 继承。如前所述，MediaLibraryService 与旧版 MediaBrowserService 兼容。因此，服务提供给客户端的更广泛的 API 仍然保持不变。因此，应用可能会保留实现 MediaBrowserService 所需的大部分逻辑，并针对新的 MediaLibraryService 对其进行调整。

与旧版 MediaBrowserServiceCompat 相比，主要区别如下：
- 实现服务生命周期方法：需要在服务本身上替换的方法是 onCreate/onDestroy，应用会在此方法中分配/释放库会话、播放器和其他资源。除了标准服务生命周期方法之外，应用还需要替换 onGetSession(MediaSession.ControllerInfo) 以返回在 onCreate 中构建的 MediaLibrarySession。
- 实现 MediaLibraryService.MediaLibrarySessionCallback：构建会话需要实现实际网域 API 方法的 MediaLibraryService.MediaLibrarySessionCallback。因此，您应该替换 MediaLibrarySession.Callback 的方法，而不是替换旧版服务的 API 方法。
  
  然后，该回调将用于构建 MediaLibrarySession：
```
mediaLibrarySession =
      MediaLibrarySession.Builder(this, player, MySessionCallback())
         .build()
```
  在 API 文档中查找 MediaLibrarySessionCallback 的完整 API。
- 实现 MediaSession.Callback.onAddMediaItems()：onAddMediaItems(MediaSession, ControllerInfo, List<MediaItem>) 回调提供各种当前和旧版 API 方法，这些方法可将媒体项添加到播放器，以便以向后兼容的方式播放。这包括 Media3 控制器的 MediaController.set/addMediaItems() 方法以及旧版 API 的 TransportControls.prepareFrom*/playFrom* 方法。您可以在会话演示应用的 PlaybackService 中找到回调的实现示例。
- AndroidX Media3 使用 androidx.media3.common.MediaItem，而不是 MediaBrowserCompat.MediaItem 和 MediaMetadataCompat。与旧版类相关联的部分代码需要相应地更改或映射到 Media3 MediaItem。
- 与 MediaBrowserServiceCompat 的可分离 Result 方法相比，常规的异步编程模型已更改为 Futures。您的服务实现可以返回异步 ListenableFuture，而不是分离结果或返回直接 Future 以直接返回值。

移除 PlayerNotificationManager

MediaLibraryService 自动支持媒体通知，在使用 MediaLibraryService 或 MediaSessionService 时，您可以移除 PlayerNotificationManager。

应用可以通过在 onCreate() 中设置用于替换 DefaultMediaNotificationProvider 的自定义 MediaNotification.Provider 来自定义通知。然后，MediaLibraryService 负责根据需要在前台启动服务。

通过替换 MediaLibraryService.updateNotification()，应用可以进一步全权负责发布通知以及根据需要在前台启动/停止服务。

使用 MediaBrowser 迁移客户端代码

在 AndroidX Media3 中，MediaBrowser 实现了 MediaController/Player 接口，并且除了浏览媒体库之外，还可用于控制媒体播放。如果您必须创建 MediaBrowserCompat 和 MediaControllerCompat，只需使用 Media3 中的 MediaBrowser 即可执行相同的操作。

可以构建 MediaBrowser 并等待与服务建立连接：

scope.launch {
    val sessionToken =
        SessionToken(context, ComponentName(context, MusicService::class.java)
    browser =
        MediaBrowser.Builder(context, sessionToken))
            .setListener(BrowserListener())
            .buildAsync()
            .await()
    // Get the library root to start browsing the library.
    root = browser.getLibraryRoot(/* params= */ null).await();
    // Add a MediaController.Listener to listen to player state events.
    browser.addListener(playerListener)
    playerView.setPlayer(browser)
}

请查看在媒体会话中控制播放，了解如何创建 MediaController 以在后台控制播放。

后续步骤和清理

不稳定的 API 错误

迁移到 Media3 后，您可能会看到有关不稳定 API 用法的 lint 错误。这些 API 可以安全使用，lint 错误是我们新的二进制文件兼容性保证的副产品。如果您不需要严格的二进制文件兼容性，则可以使用 @OptIn 注解安全地抑制这些错误。

背景

ExoPlayer v1 和 v2 均未严格保证库在后续版本之间的二进制文件兼容性。ExoPlayer API Surface 在设计上非常大，可让应用自定义播放功能的几乎每个方面。后续版本的 ExoPlayer 偶尔会引入符号重命名或其他破坏性更改（例如，接口上所需的新方法）。在大多数情况下，通过在几个版本中引入新符号和弃用旧符号来缓解这些破坏问题，以便为开发者留出时间来迁移其用例，但这并非总能实现。

这些破坏性更改给 ExoPlayer v1 和 v2 库的用户带来了两个问题：

升级到 ExoPlayer 版本可能会导致代码停止编译。
直接依赖 ExoPlayer 以及通过中间库依赖 ExoPlayer 的应用必须确保这两个依赖项的版本相同，否则二进制文件不兼容可能会导致运行时崩溃。

Media3 中的改进

Media3 可保证 API Surface 的子集的二进制文件兼容性。不保证二进制文件兼容性的部分带有 @UnstableApi 标记。为了明确这一区别，使用不稳定的 API 符号会导致 lint 错误，除非这些符号带有 @OptIn 注解。

从 ExoPlayer v2 迁移到 Media3 后，您可能会看到许多不稳定的 API lint 错误。这可能会使 Media3 看起来不如 ExoPlayer v2“不稳定”。事实并非如此。Media3 API 的“不稳定”部分的稳定性与 ExoPlayer v2 API Surface 的稳定性相同，并且 ExoPlayer v2 中根本不提供稳定的 Media3 API Surface 的保证。不同之处在于，lint 错误现在会提醒您不同的稳定性级别。

处理不稳定的 API lint 错误

如需详细了解如何为使用不稳定 API 的 Java 和 Kotlin 添加 @OptIn 注解，请参阅关于这些 lint 错误的问题排查部分。

已弃用的 API

您可能会注意到，对已废弃 API 的调用在 Android Studio 中会带有删除线。我们建议您将此类调用替换为适当的替代调用。将鼠标悬停在该符号上即可查看 JavaDoc，其中会说明应改用哪个 API。

屏幕截图：如何使用已废弃方法的替代方法显示 JavaDoc — **图 3**：Android Studio 中的 JavaDoc 提示针对任何已弃用的符号提供了替代建议。

代码示例和演示应用

AndroidX Media3 会话演示应用（移动设备和 WearOS）
- 自定义操作
- 系统界面通知、MediaButton/BT
- Google 助理播放控制
UAMP：Android Media Player（分支 media3）（移动设备、AutoOS）
- 系统界面通知、MediaButton/BT、继续播放
- Google 助理/Wear OS 播放控制
- AutomotiveOS：自定义命令和登录