是否可以在 Gradle 中声明一个可在 Java 中使用的变量?基本上我想在 build.gradle 中声明一些变量,然后在构建时(显然)得到它。就像 C/C++ 中的预处理器宏...
声明的一个例子是这样的......:
android {
debug {
A_VAR_RETRIEVABLE_IN_JAVA = 42
}
release {
A_VAR_RETRIEVABLE_IN_JAVA = 42+52
}
}
有没有办法做这样的事情?
这是从 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 {
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
以通常的方式访问它们
在 Android 应用程序(Java 和 XML)中使用 Api App Key 的示例
gradle.properties
AppKey="XXXX-XXXX"
构建.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" />
链接到 Android 应用程序中的 Api App Key 使用示例
使用 Gradle 构建配置生成的字符串常量
./gradlew -PAppKey="1234" testdebug
defaultConfig
块:stackoverflow.com/a/51521146/321354
@string/APP_KEY_2
使用系统属性的示例,在 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>
文件:
构建.gradle
src/main/java/example/HelloWorld.java
src/test/java/example/HelloWorldTest.java
src/test/resources/logback-test.xml
version = '0.0.1-SNAPSHOT'
吗?
systemProperty
真的只对测试有意义,所以我明白他们为什么这样做(这不是疏忽),但同时,我也尝试将 gradle 用于它不打算用于的事情(比如一个应用程序 DSL),所以我可以识别。作为替代方案,我建议只从属性文件(或配置服务等)加载属性,因为如果它不是处于“测试”模式,那么它就是“生产”模式和需要应用程序逻辑。 (无论如何,这就是理论。)
您可以在构建期间通过系统环境变量创建可覆盖的构建配置字段:
开发时使用回退,但您可以在 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
提供。
rciovati 的回答是完全正确的我只是想再添加一个花絮,您还可以在 build.gradle 的默认配置部分中为每种构建类型创建变量。这看起来像这样:
android {
defaultConfig {
buildConfigField "String", "APP_NAME", "\"APP_NAME\""
}
}
这将允许您通过
BuildConfig.App_NAME
如果您想要一个通用配置,也只是想记下这种情况。
我正在使用这段代码并且工作得很好。
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
}
}
}
}
以上答案都没有给我任何指导,所以我不得不花两个小时学习 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
,这是我最初想做的。
我在用着
buildTypes.each {
it.buildConfigField 'String', 'GoogleMapsApiKey', "\"$System.env.GoogleMapsApiKey\""
}
它基于 Dennis's answer,但从环境变量中获取。
如何将函数的字符串结果插入 buildConfigField
以下是人类可读格式集的构建日期示例:
def getDate() {
return new SimpleDateFormat("dd MMMM yyyy", new Locale("ru")).format(new Date())
}
def buildDate = getDate()
defaultConfig {
buildConfigField "String", "BUILD_DATE", "\"$buildDate\""
}
https://stackoverflow.com/a/17201265/12021422@rciovati 的回答作品
但请确保您重建项目以便能够从 Android Studio IDE 中删除错误
我花了 30 分钟试图弄清楚为什么新的属性变量无法访问。
如果用红色标记的“制作项目”不起作用,请尝试用绿色标记的“重建项目”按钮。
https://i.stack.imgur.com/iHB9r.png
这适用于在 Java 和 Kotlin 中都可以使用的 Kotlin DSL (build.gradle.kts):
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")
}
}
<project>/src/
中,如果您创建文件debug/res/values/strings.xml
和另一个文件release/res/values/strings.xml
,您也可以以稍微干净的方式为调试和发布版本设置资源。android
插件的情况下实现相同的目标?即只使用apply plugin java
?谢谢!