是否可以在 Gradle 中声明一个可在 Java 中使用的变量？答案

【问题标题】：Is it possible to declare a variable in Gradle usable in Java?是否可以在 Gradle 中声明一个可在 Java 中使用的变量？
【发布时间】：2013-06-16 08:45:51
【问题描述】：

是否可以在 Gradle 中声明一个可在 Java 中使用的变量？基本上我想在 build.gradle 中声明一些变量，然后在构建时（显然）得到它。就像 C/C++ 中的预处理器宏...

声明的一个例子是这样的......：

android {
    debug {
        A_VAR_RETRIEVABLE_IN_JAVA = 42
    }
    release {
        A_VAR_RETRIEVABLE_IN_JAVA = 42+52
    }
}

有没有办法做这样的事情？

【问题讨论】：

stackoverflow.com/a/65624195/3970630

标签： java android gradle android-gradle-plugin

【解决方案1】：

这里有两种从 Gradle 传递值以在 Java 中使用的方法；

生成 Java 常量

android {
    buildTypes {
        debug {
            buildConfigField "int", "FOO", "42"
            buildConfigField "String", "FOO_STRING", "\"foo\""
            buildConfigField "boolean", "LOG", "true"
        }

        release {
            buildConfigField "int", "FOO", "52"
            buildConfigField "String", "FOO_STRING", "\"bar\""
            buildConfigField "boolean", "LOG", "false"
        }
    }
}

您可以通过BuildConfig.FOO 访问它们

生成 Android 资源

android {
    buildTypes {
        debug{
            resValue "string", "app_name", "My App Name Debug"
        }
        release {
            resValue "string", "app_name", "My App Name"
        }
    }
}

您可以使用@string/app_name 或R.string.app_name 以通常的方式访问它们

【讨论】：

不，但您也可以生成资源。我已经更新了我的答案，包括那个。
太棒了，谢谢。我发现很好的是，您可以为调试和发布版本指定备用目录。在<project>/src/ 中，如果您创建文件debug/res/values/strings.xml 和另一个文件release/res/values/strings.xml，您也可以以更简洁的方式为调试和发布版本设置资源。
@rciovati 是否可以在没有android 插件的情况下实现相同的目标？即只使用apply plugin java？谢谢！
如何为不同的构建风格和构建类型创建常量？
是否可以将其中一个字段设置为当前年份，并且无论选择哪种构建类型（发布，调试，...）也可以达到它？

【解决方案2】：

在 Android 应用程序（Java 和 XML）中使用 Api App Key 的示例

gradle.properties

AppKey="XXXX-XXXX"

build.gradle

buildTypes {
//...
    buildTypes.each {
        it.buildConfigField 'String', 'APP_KEY_1', AppKey
        it.resValue 'string', 'APP_KEY_2', AppKey
    }
}

在java代码中的使用

Log.d("UserActivity", "onCreate, APP_KEY: " + getString(R.string.APP_KEY_2));

BuildConfig.APP_KEY_1

在xml代码中的使用

<data android:scheme="@string/APP_KEY_2" />

【讨论】：

如果我可以添加，这个变量也可以在运行时传递。在运行具有不同配置的测试时最有用。使用./gradlew -PAppKey="1234" testdebug
要为每种构建类型声明相同的属性，您也可以使用 defaultConfig 块：stackoverflow.com/a/51521146/321354
您有 XML 部分的工作示例吗？在 Github 存储库或 Gist 中。这对我不起作用，我无法引用 @string/APP_KEY_2

【解决方案3】：

使用系统属性的示例，在 build.gradle 中设置，从 Java 应用程序读取（从 cmets 中的问题跟进）：

基本上，使用build.gradle 中的test 任务，使用测试任务方法systemProperty 设置在运行时传递的系统属性：

apply plugin: 'java'
group = 'example'
version = '0.0.1-SNAPSHOT'

repositories {
    mavenCentral()
    // mavenLocal()
    // maven { url 'http://localhost/nexus/content/groups/public'; }
}

dependencies {
    testCompile 'junit:junit:4.8.2'
    compile 'ch.qos.logback:logback-classic:1.1.2'
}

test {
  logger.info '==test=='
  systemProperty 'MY-VAR1', 'VALUE-TEST'
}

这是示例代码的其余部分（您可能可以推断，但无论如何都包含在此处）：它获取系统属性MY-VAR1，预计在运行时设置为VALUE-TEST：

package example;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class HelloWorld {
  static final Logger log=LoggerFactory.getLogger(HelloWorld.class);
  public static void main(String args[]) {
    log.info("entering main...");
    final String val = System.getProperty("MY-VAR1", "UNSET (MAIN)");
    System.out.println("(main.out) hello, world: " + val);
    log.info("main.log) MY-VAR1=" + val);
  }
}

测试用例：如果 MY-VAR 未设置，测试应该失败：

package example;
...
public class HelloWorldTest {
    static final Logger log=LoggerFactory.getLogger(HelloWorldTest.class);
    @Test public void testEnv() {
        HelloWorld.main(new String[]{});
        final String val = System.getProperty("MY-VAR1", "UNSET (TEST)");
        System.out.println("(test.out) var1=" + val);
        log.info("(test.log) MY-VAR1=" + val);
        assertEquals("env MY-VAR1 set.", "VALUE-TEST", val);
    }
}

运行（注意：测试通过）：

$ gradle cleanTest test
:cleanTest
:compileJava UP-TO-DATE
:processResources UP-TO-DATE
:classes UP-TO-DATE
:compileTestJava UP-TO-DATE
:processTestResources UP-TO-DATE
:testClasses UP-TO-DATE
:test

BUILD SUCCESSFUL

我发现棘手的部分实际上是从 gradle 获取输出......所以，这里配置了日志记录（slf4j+logback），并且日志文件显示了结果（或者，运行gradle --info cleanTest test；有还有将标准输出发送到控制台的属性，但是，你知道为什么）：

$ cat app.log
INFO Test worker example.HelloWorld - entering main...
INFO Test worker example.HelloWorld - main.log) MY-VAR1=VALUE-TEST
INFO Test worker example.HelloWorldTest - (test.log) MY-VAR1=VALUE-TEST

如果您注释掉“systemProperty...”（顺便说一句，它只适用于test 任务），那么：

example.HelloWorldTest > testEnv FAILED
    org.junit.ComparisonFailure at HelloWorldTest.java:14

为了完整起见，这里是 logback 配置 (src/test/resources/logback-test.xml)：

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>app.log</file>
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>%d %p %t %c - %m%n</pattern>
        </layout>
 </appender>
 <root level="info">
     <appender-ref ref="FILE"/>
</root>
</configuration>

文件：

build.gradle
src/main/java/example/HelloWorld.java
src/test/java/example/HelloWorldTest.java
src/test/resources/logback-test.xml

【讨论】：

请注意，这是对已接受答案中评论的直接回复，因此与原始问题略有不同。
我可以通过 Java 代码获得version = '0.0.1-SNAPSHOT' 吗？
SystemProperty 仅在 gradle 测试任务中可用:(。有人知道在库的 java 代码中具有 gradle 变量值的任何其他方式吗？
systemProperty 真的只对测试有意义，所以我明白他们为什么这样做（这不是疏忽），但同时，我也尝试使用 gradle它不是为（如应用程序 DSL）而设计的，所以我可以识别。作为替代方案，我建议只从属性文件（或配置服务等）加载属性，因为如果它不是处于“测试”模式，那么它就是“生产”模式并且需要应用程序逻辑。（无论如何，这就是理论。）

【解决方案4】：

您可以在构建期间创建可通过系统环境变量覆盖的构建配置字段：

开发时使用回退，但您可以在 Jenkins 或其他工具上运行构建时覆盖该变量。

在您的应用中build.gradle：

buildTypes {
        def serverUrl =  '\"' + (System.getenv("SERVER_URL")?: "http://default.fallback.url.com")+'\"'
        debug{
            buildConfigField "String", "SERVER_URL", serverUrl
        }
        release {
            minifyEnabled true
            proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
            buildConfigField "String", "SERVER_URL", serverUrl
        }
    }

该变量将以BuildConfig.SERVER_URL 的形式提供。

【讨论】：

感谢您的回答！我一直在尝试研究如何让环境变量在 Android .java 文件中可见，效果很好！
如果你想定义布尔变量，你应该使用 buildConfigField "boolean", "CI_BUILD", "${isCi}" 或 buildConfigField "boolean", "CI_BUILD", "Boolean.parseBoolean(" + '"' + isCi + '"' + ")" 如果你想逃避 lint 检查 (stackoverflow.com/questions/29889098/…)

【解决方案5】：

rciovati 的回答完全正确我只是想再添加一个花絮，您还可以在 build.gradle 的默认配置部分中为每种构建类型创建变量。这看起来像这样：

android {
    defaultConfig {
        buildConfigField "String", "APP_NAME", "\"APP_NAME\""
    }
}

这将允许您通过

BuildConfig.App_NAME

如果您想要一个通用配置，也只是想记下这种情况。

【讨论】：

【解决方案6】：

我正在使用此代码并且工作得很好。

def baseUrl = '\"http://patelwala.com/myapi/"'
def googleServerKey = '\"87171841097-opu71rk2ps35ibv96ud57g3ktto6ioio.apps.googleusercontent.com"'
android {
  buildTypes {
  release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id', googleServerKey
    }
    releasedebug {
        initWith debug
        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id' ,googleServerKey
    }
    debug {

        buildConfigField 'String', 'BASE_URL', baseUrl
        buildConfigField 'String', 'web_client_id', googleServerKey
    }
 }
}

}

【讨论】：

如果您指定您修改的内容及其影响，这将是很好的，从而产生您的工作解决方案。

【解决方案7】：

以上答案都没有给我任何指导，所以我不得不花两个小时学习 Groovy 方法。

我希望能够对抗生产环境、沙盒环境和本地环境。因为我很懒，我只想在一个地方更改 URL。这是我想出的：

 flavorDimensions 'environment'
    productFlavors {
        production {
            def SERVER_HOST = "evil-company.com"
            buildConfigField 'String', 'API_HOST', "\"${SERVER_HOST}\""
            buildConfigField 'String', 'API_URL', "\"https://${SERVER_HOST}/api/v1/\""
            buildConfigField 'String', 'WEB_URL', "\"https://${SERVER_HOST}/\""
            dimension 'environment'
        }
        rickard {
            def LOCAL_HOST = "192.168.1.107"
            buildConfigField 'String', 'API_HOST', "\"${LOCAL_HOST}\""
            buildConfigField 'String', 'API_URL', "\"https://${LOCAL_HOST}/api/v1/\""
            buildConfigField 'String', 'WEB_URL', "\"https://${LOCAL_HOST}/\""
            applicationIdSuffix ".dev"
        }
    }

替代语法，因为您只能在 Groovy 方法中使用带有双引号的 ${variable}。

    rickard {
        def LOCAL_HOST = "192.168.1.107"
        buildConfigField 'String', 'API_HOST', '"' + LOCAL_HOST + '"'
        buildConfigField 'String', 'API_URL', '"https://' + LOCAL_HOST + '/api/v1/"'
        buildConfigField 'String', 'WEB_URL', '"https://' + LOCAL_HOST + '"'
        applicationIdSuffix ".dev"
    }

让我难以理解的是，字符串需要声明为用引号括起来的字符串。由于这个限制，我不能直接使用引用API_HOST，这是我一开始就想做的。

【讨论】：

【解决方案8】：

我正在使用

buildTypes.each {
    it.buildConfigField 'String', 'GoogleMapsApiKey', "\"$System.env.GoogleMapsApiKey\""
}

它基于Dennis's answer，但从环境变量中获取。

【讨论】：

【解决方案9】：

如何将函数的字符串结果插入到 buildConfigField 中

以下是人类可读格式集的构建日期示例：

def getDate() {
    return new SimpleDateFormat("dd MMMM yyyy", new Locale("ru")).format(new Date())
}

def buildDate = getDate()

defaultConfig {
    buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}

【讨论】：

【解决方案10】：

https://stackoverflow.com/a/17201265/12021422@rciovati 的回答作品

但请确保您重建项目以便能够从 Android Studio IDE 中删除错误

我花了 30 分钟试图弄清楚为什么新的属性变量无法访问。

如果用红色标记的“制作项目”不起作用，请尝试用绿色标记的“重建项目”按钮。

【讨论】：

【解决方案11】：

这适用于可在 Java 和 Kotlin 中使用的 Kotlin DSL (build.gradle.kts)：

buildTypes {
    getByName("debug") {
        buildConfigField("Boolean", "isHappy", "true")
        buildConfigField("String", "favoriteSong", """"Black Forest"""")
        resValue("string", "myName", "Lind")
    }
}

【讨论】：