Wormhole 项目使用教程

Wormhole 项目使用教程

1、项目介绍

Wormhole 是一个时间旅行的字节码重写器，它能够将未来的 API 添加到 Android 的 android.jar 中。通过这种方式，开发者可以在较低的 API 级别上使用未来版本的 Android API，这些 API 可以通过 D8 和 R8 进行脱糖处理，从而在所有 API 级别上使用。

Wormhole 的主要功能是允许开发者在当前的 Android 项目中使用尚未正式发布的 API。例如，开发者可以在 API 29 的项目中使用 API 30 的特性，而不需要等待 API 30 正式发布。

2、项目快速启动

2.1 环境准备

在开始之前，请确保你已经安装了以下工具和环境：

• JDK 8 或更高版本
• Android Studio
• Android Gradle Plugin (AGP) 4.0 或更高版本

2.2 项目配置

首先，在你的项目根目录下的 build.gradle 文件中添加 Wormhole 的依赖：

buildscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'com.jakewharton.wormhole:wormhole-gradle:0.3.1'
    }
}

然后，在你的 Android 子项目的 build.gradle 文件中应用 Wormhole 插件：

apply plugin: 'com.jakewharton.wormhole'

android {
    compileSdkVersion wormhole(29)
}

如果你使用的是 Kotlin DSL，配置如下：

import com.jakewharton.wormhole.gradle.wormhole

android {
    compileSdkVersion(wormhole(29))
}

2.3 使用示例

配置完成后，你可以在代码中使用未来的 API。例如，你可以在 API 29 的项目中使用 API 30 的 List.of 方法：

// 在 API 30 中可用
List<String> names = List.of("Jake");

// Java 10 API，在任何 API 级别中不可用
List<String> copy = List.copyOf(names);

3、应用案例和最佳实践

3.1 应用案例

假设你正在开发一个 Android 应用，并且你希望在 API 29 的项目中使用 API 30 的特性。通过使用 Wormhole，你可以提前使用这些特性，而不需要等待 API 30 正式发布。

3.2 最佳实践

• 版本控制：确保你的项目使用的是最新版本的 Wormhole，以获得最新的 API 支持。
• 兼容性测试：在使用未来的 API 时，务必进行充分的兼容性测试，确保在不同 API 级别上都能正常工作。
• 文档记录：在使用 Wormhole 的项目中，建议详细记录所使用的未来 API，以便其他开发者理解项目的依赖关系。

4、典型生态项目

Wormhole 作为一个字节码重写器，主要用于 Android 开发中的 API 预览和测试。以下是一些与 Wormhole 相关的典型生态项目：

• D8 和 R8：Wormhole 依赖于 D8 和 R8 进行字节码脱糖处理，确保未来的 API 能够在所有 API 级别上使用。
• Android Gradle Plugin (AGP)：Wormhole 需要 AGP 4.0 或更高版本的支持，以确保插件能够正确应用。
• Kotlin：Wormhole 支持 Kotlin 项目，开发者可以在 Kotlin 代码中使用未来的 API。

通过这些生态项目的支持，Wormhole 能够为开发者提供一个强大的工具，帮助他们在较低的 API 级别上使用未来的 Android API。