使用 Gradle 检测 IDE 环境

Question

有没有办法检测我正在运行我的项目的环境。

类似这样的：

build.gradle

def usingIntelliJ = ...
def usingAndroidStudio = ...
if (usingIntelliJ) {
    buildConfigField "String", "IDE_ENV", "IDEA"
} else if (usingAndroidStudio) {
    buildConfigField "String", "IDE_ENV", "AndroidStudio"
}

Answer 1

为了确定您的构建是否由 IDE 触发，Android 构建链将设置一个特定属性：

def isIdeBuild() {
    return project.properties['android.injected.invoked.from.ide'] == 'true'
}

在我们的构建中，我们使用此方法为我们的 IDE 构建设置静态 versionCode，但保留所需的行为以在我们的构建服务器上自动增加它：

def getNumberOfGitCommits() {
    def text = 'git rev-list --count HEAD'.execute().text.trim()
    return text == '' ? 0 : text.toInteger()
}

def calculateVersionCode() {
    return isIdeBuild() ? 123456789 : getNumberOfGitCommits()
}

android {
    defaultConfig {
        // ...
        versionCode calculateVersionCode()
    }
}

这解决了我们遇到的两个问题：

1. 之前，新提交有效地禁用了 Instant Run。因为 versionCode 是自动更新的，所以 Manifest 发生了变化——这会在 Instant Run 中触发完全重建。
2. 以前，当我们切换 Git 分支时，versionCode 经常会更改为较小的（降级），因此我们不得不重新安装应用程序。现在，我们的所有 IDE 构建都具有相同的 versionCode。

Answer 2

在构建脚本中，您可以评估 IDE 添加的以下属性：

• idea.active IDE 在您从 IDE 运行 Gradle 任务时设置的属性；

• idea.sync.active IDE 在 IDE reloads project from Gradle build scripts 时添加的属性。

例如：System.getProperty('idea.active')。

Answer 3

其他答案对我不起作用，但通过查看所有属性，这些似乎有效：

• idea.paths.selector - 在默认安装中，它具有诸如“AndroidStudioPreview2021.1”或“IntelliJIdea2021.2”之类的值，因此如果您需要知道它是不是，可以使用它：

def pathSelector = System.getProperty('idea.paths.selector') ?: ''
def usingIntelliJ = pathSelector.startsWith('IntelliJIdea')
def usingAndroidStudio = pathSelector.startsWith('AndroidStudio')
...

• idea.platform.prefix - 似乎只为 Android Studio 设置，值为“AndroidStudio”，所以它可能不适用于这种情况，但它是我的解决方案：

def usingAndroidStudio = System.getProperty('idea.platform.prefix') == 'AndroidStudio'
...