Javaで使用可能なGradleで変数を宣言することは可能ですか?


417

Javaで使用可能なGradleで変数を宣言することは可能ですか?基本的には、いくつかの変数をbuild.gradleで宣言し、ビルド時に(明らかに)取得します。C / C ++のプリプロセッサマクロのように...

宣言の例は次のようなものです...:

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

そのようなことをする方法はありますか?

回答:


796

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


4
いいえ、リソースを生成することもできます。それを含めて私の答えを更新しました。
rciovati 2014年

2
素晴らしいです、ありがとう。私が発見したのは、デバッグビルドとリリースビルドの代替ディレクトリを指定できることです。では<project>/src/、ファイルdebug/res/values/strings.xmlと別のファイルを作成するとrelease/res/values/strings.xml、デバッグビルドとリリースビルドのリソースを少しクリーンな方法で設定することもできます。
elimirks 2014年

6
@rciovati androidプラグインなしで同じことを達成することは可能ですか?つまり、単に使用しapply plugin javaますか?ありがとう!
Zennichimaro、2014年

2
異なるビルドフレーバーとビルドタイプの定数を作成するにはどうすればよいですか?
Jakob Eriksson

3
現在の年としてフィールドの1つを設定し、どのビルドタイプを選択しても(リリース、デバッグなど)、そのフィールドに到達することはできますか?
android開発者

102

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 2017年

1
ビルドタイプごとに同じプロパティを宣言するには、defaultConfigブロックも使用できます:stackoverflow.com/a/51521146/321354
rciovati

XML部分の実例はありますか?GithubリポジトリまたはGist。それは私のために機能していない、私は参照することはできません@string/APP_KEY_2
voghDev

32

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

テストケース: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

完全を期すために、ここにログバック構成(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

これは、受け入れられた回答のコメントに対する直接の応答であるため、元の質問とは少し異なります。
マイケル2014

2
どういうわけversion = '0.0.1-SNAPSHOT'かJavaコード経由で取得できますか?
Nom1fan 2016

SystemPropertyは、gradleテストタスクでのみ使用できます:(。ライブラリのJavaコードに
gradle

systemProperty実際にテストするだけで意味があるので、なぜ彼らがこのようにしたのか(見落としではない)がわかりますが、同時に、意図しないもの(アプリケーションDSLなど)にもGradleを使用しようとしました)識別できるように。別の方法として、プロパティファイル(または構成サービスなど)からプロパティをロードすることをお勧めします。「テスト」モードでない場合は「本番」モードであり、アプリケーションロジックが必要になるためです。(とにかく、それが理論です。)
マイケル

14

ビルド中にシステム環境変数を介してオーバーライド可能なビルド構成フィールドを作成できます。

フォールバックは開発中に使用されますが、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ファイル内から環境変数を表示する方法を模索してきましたが、これはうまくいきました!
ウェインピエカルスキ2017年

ブール変数を定義する場合は、buildConfigField "boolean"、 "CI_BUILD"、 "$ {isCi}"またはbuildConfigField "boolean"、 "CI_BUILD"、 "Boolean.parseBoolean(" + '"' + isCi + 'を使用する必要があります「」+ 『)』あなたはリントチェック(脱出したい場合はstackoverflow.com/questions/29889098/...
android_dev

5

rciovatiの答えは完全に正しいです。私は、build.gradleのデフォルトのconfig部分内のすべてのビルドタイプの変数を作成できるもう1つのtidbitを追加したかっただけです。これは次のようになります。

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

これにより、アクセスできるようになります

BuildConfig.App_NAME

共通の設定が必要な場合は、このシナリオも書き留めておきたいだけです。


3

私はこのコードを使用して、非常にうまく機能しています。

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

}


何を変更し、どのような影響を与えるかを指定すると、ソリューションが機能するようになります。
Badgy 2018年

2

関数の文字列結果をbuildConfigFieldに挿入する方法

人間が読める形式のセットでのビルド日付の例を次に示します。

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

def buildDate = getDate()

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

1

私は使っています

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

これはDennisの回答に基づいていますが、環境変数から取得しています。


0

上記の回答のいずれにもガイドラインはありませんでしたので、2時間かけてGroovyメソッドについて学ぶ必要がありました。

プロダクション、サンドボックス、ローカル環境に対抗できるようにしたかったのです。私は怠惰なので、URLを1か所だけ変更したかったのです。これが私が思いついたものです:

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

代替構文${variable}。Groovyメソッドでは二重引用符のみを使用できるため。

    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、最初は参照を直接使用することができませんでした。

弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.