是否有可能在Gradle中声明一个可用于Java的变量?

是否有可能在Gradle中声明一个可用于Java的变量? 基本上我想在build.gradle中声明一些变量,然后在构建时明显地获得它。 就像C / C ++中的预处理器宏一样…

声明的例子就是这样的:

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

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

生成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_nameR.string.app_name以通常的方式访问它们

在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" /> 
  • 链接到Android应用程序中的Api App Key使用示例
  • 使用由Gradle构建配置生成的字符串常量

使用系统属性的示例,在build.gradle中设置,从Java应用程序中读取(从注释中的问题开始):

基本上,在build.gradle中使用测试任务,使用测试任务方法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 ;还有一些将stdout传递给控制台的属性,但是,你知道为什么):

 $ 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

在构建过程中,您可以通过系统环境变量创建构建配置字段。

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

在你的应用程序build.gradle

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