Mirakle 使用教程

1. 项目介绍

Mirakle 是一个Gradle插件，它允许用户将构建过程从本地机器移至远程机器。这个插件与Gradle 7.0+版本兼容，并能与IntelliJ IDEA和Android Studio无缝工作。使用远程性能更强的机器进行构建，可以显著提升构建速度，特别是在网络带宽充足或构建产生数据量较小的情况下。

2. 项目快速启动

在开始之前，确保你的本地机器和远程机器都已经安装了Gradle。

安装Mirakle

将以下脚本放入本地用户目录下的 USER_HOME/.gradle/init.d/mirakle_init.gradle 文件中：

initscript {
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath 'io.github.adambl4:mirakle:1.6.0'
    }
}

apply plugin: 'Mirakle'

然后配置远程机器的主机名：

rootProject {
    mirakle {
        host = "your_remote_machine"
    }
}

启动构建

使用以下命令启动构建，所有任务都将在远程机器上执行：

./gradlew build

如果要禁用远程执行，可以在命令中添加 -x mirakle 参数：

./gradlew build install -x mirakle

3. 应用案例和最佳实践

使用案例

• 当你需要构建一个大型项目，且本地机器资源有限时，可以使用Mirakle将构建过程移至配置更高的远程机器。
• 在持续集成（CI）流程中，利用远程机器的强大性能来加速构建过程。

最佳实践

• 确保远程机器上的Gradle版本与本地机器一致。
• 在 mirakle_init.gradle 文件中配置好文件同步和SSH连接的相关参数，以优化构建过程。

4. 典型生态项目

目前没有明确指出直接依赖Mirakle的生态项目，但任何使用Gradle作为构建系统的项目都可能从Mirakle的使用中受益。例如，Android项目和基于Java的微服务项目等。

通过使用Mirakle，这些项目可以在远程服务器上利用更强大的资源来加速构建过程，特别是在进行大规模构建或频繁构建时。