logo标签列表

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

javaandroidgradleandroid-gradle-pluginbuild.gradle
464

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

声明的示例可能是这样的...：

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

有没有一种类似那样做的方法？

https://stackoverflow.com/a/65624195/3970630 - Ric17101
11个回答
870

这里有两种方法可以从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 访问它们。

6
不可以，但你也可以生成资源。我已经更新了我的回答并包含了这一点。 - rciovati
2
太棒了，谢谢。我发现另一个很好的方法是可以为调试和发布构建指定替代目录。在<project>/src/中，如果您创建文件debug/res/values/strings.xml和另一个文件release/res/values/strings.xml，您也可以以稍微更清晰的方式设置调试和发布构建的资源。 - elimirks
8
@rciovati，不使用 android 插件也能实现相同的效果吗？例如，只使用 apply plugin java？谢谢！ - Zennichimaro
3
我该如何为不同的构建风味和构建类型创建常量？ - Jakob Eriksson
3
无论选择哪种构建类型（发布版、调试版等），是否能将其中一个字段设置为当前年份，并且始终能够访问它？ - android developer
显示剩余18条评论
129

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

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" />
1
如果我可以补充一下，这个变量也可以在运行时传递。当使用不同配置运行测试时非常有用。使用./gradlew -PAppKey="1234" testdebug。 - Jaswanth Manigundan
1
要为每个构建类型声明相同的属性，您也可以使用defaultConfig块：https://dev59.com/4WQm5IYBdhLWcg3w-S6Y#51521146 - rciovati
你有XML部分的工作示例吗？是否在Github存储库或Gist中？它对我来说不起作用，我无法引用“@string/APP_KEY_2”。 - voghDev
33

以下是使用在build.gradle中设置的系统属性，在Java应用程序中读取的示例（根据评论中的问题进行跟进）：

基本上，使用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>

Files:

  • build.gradle
  • src/main/java/example/HelloWorld.java
  • src/test/java/example/HelloWorldTest.java
  • src/test/resources/logback-test.xml
1
请注意，这是对已接受答案中评论的直接回应，因此与原始问题有些偏差。 - michael
2
我能否通过Java代码以某种方式获取version = '0.0.1-SNAPSHOT'？ - Nom1fan
系统属性仅在Gradle测试任务中可用 :( 。有人知道其他方法在库的Java代码中拥有Gradle变量值吗？ - Stoycho Andreev
systemProperty 只有在测试时才有意义，所以我明白为什么他们这样做（这不是疏忽），但同时，我也尝试过将 gradle 用于它不打算使用的事情（比如应用程序 DSL），所以我可以理解。作为替代方案，我建议从属性文件（或配置服务等）中加载属性，因为如果不处于“测试”模式，则处于“生产”模式并需要应用程序逻辑。（无论如何，这是理论。） - michael
16

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

当进行开发时使用回退，但是当您在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可用。

1
谢谢您的回答！我一直在尝试弄清楚如何使环境变量在Android .java文件中可见，这个方法非常好用！ - Wayne Piekarski
如果你想定义布尔变量，你应该使用 buildConfigField "boolean", "CI_BUILD", "${isCi}" 或者 buildConfigField "boolean", "CI_BUILD", "Boolean.parseBoolean(" + '"' + isCi + '"' + ")" 如果你想要避免 lint 检查 (https://stackoverflow.com/questions/29889098/why-does-the-buildconfig-class-use-boolean-parseboolean-instead-of-literal-val/29889099#comment94698223_29889099)。 - android_dev
15

rciovati的答案完全正确，我只想再添加一点内容，即您还可以在build.gradle的默认配置部分为每个构建类型创建变量。这将如下所示：

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

这将使您能够通过访问

BuildConfig.App_NAME

我只想备注一下，如果你需要一个常见的配置，这种情况也可以。

4

以上答案均未给出任何指南，所以我不得不花费两个小时学习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，这本来就是我想做的。

4

我正在使用这段代码，它运行得非常好。

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
    }
 }
}

}

如果您能说明您所修改的内容以及其影响，从而得出您的解决方案，那就太好了。 - niclas_4
3

我正在使用

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

这个基于Dennis的回答，但是从一个环境变量中获取它。

3

这是针对 Kotlin DSL（build.gradle.kts）的，可在 Java 和 Kotlin 中使用：

buildTypes {
    getByName("debug") { // or simply  debug {  in newer version of Android Gradle Plugin (AGP)
        buildConfigField("Boolean", "isHappy", "true")
        buildConfigField("String", "favoriteSong", """"Black Forest"""")
        resValue("string", "myName", "Lind")
    }
}
3

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

以下是设置人类可读格式的构建日期的示例:

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

def buildDate = getDate()

defaultConfig {
    buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
网页内容由stack overflow 提供, 点击上面的
可以查看英文原文，
原文链接