webdevqa.jp.net

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

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

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

Android {
    debug {
        A_VAR_RETRIEVABLE_IN_Java = 42
    }
    release {
        A_VAR_RETRIEVABLE_IN_Java = 42+52
    }
}

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

374
klefevre

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を使って通常の方法でそれらにアクセスできます。

736
rciovati

AndroidアプリケーションでのApi App Keyの使用例(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" />
87
Denis

Build.gradleに設定され、Javaアプリケーションから読み取られたシステムプロパティーの使用例(コメント内の質問からのフォローアップ):

基本的に、build.gradletestタスクを使用し、テストタスクメソッド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 config(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
28
michael

ビルド時にシステム環境変数で上書き可能なビルド設定フィールドを作成することができます。

フォールバックは開発中に使用されますが、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として利用可能になります。

13
Boris Treukhov

rciovatiの答えは完全に正しい私はあなたがあなたのbuild.gradleのデフォルトのconfig部分の中であらゆるビルドタイプのために変数を作成することができることをもう一つちょっと加えたいと思いました。これは次のようになります。

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

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

BuildConfig.App_NAME

あなたが共通の設定が欲しいならば、ちょうどこのシナリオのメモもしたかったです。

4
s.pike

私はこのコードを使っていて、とてもうまくいっています。

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

}

2
Hits sapra

どのようにして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
anil

上記の答えはどれもガイドラインを与えてくれなかったので、Groovyメソッドについて2時間かけて学ぶ必要がありました。

本番環境、サンドボックス、ローカル環境に逆らえたかった。私は怠け者なので、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"
        }
    }

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を直接使用することはできませんでした。これは最初にやりたいことでした。

0

私が使っている

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

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

0
Marc