Можно ли объявить переменную в Gradle, используемую в Java?

можно ли объявить переменную в Gradle, используемую в Java ? В основном я хотел бы объявить некоторые vars в сборке.gradle, а затем получить его (очевидно) во время сборки. Так же, как макросы предварительного процессора в C/C++...

примером объявления было бы что-то вроде этого ... :

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

есть ли способ сделать что-то подобное ?

5 ответов


Генерировать Константы 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


пример использования ключа приложения Api в приложении Android (Java и XML)

gradle.свойства

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" />

пример использования системных свойств, установленных в build.gradle, прочитайте из приложения Java (следуя из вопроса в комментариях):

в основном, с помощью test задачи 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);
  }
}

Testcase: если 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);
    }
}

Run (Примечание: тест проходит):

$ 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), и файл журнала показывает результаты (альтернативно, run 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 или другом инструменте.

в приложении построить.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 полностью правильный я просто хотел добавить еще один лакомый кусочек, который вы также можете создавать переменные для каждого типа сборки в части конфигурации по умолчанию вашей сборки.градля. Это будет выглядеть так:

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

Это позволит вам иметь доступ к through

BuildConfig.App_NAME

просто хотел отметить этот сценарий, а если вы хотите общую конфигурацию.