使用Gradle替换不同环境的恒定路径

时间:2020-10-28 17:15:30

标签: java gradle

这是一个基于Apache Storm的项目。我有一个常量文件,看起来像这样

public class Constant {    
    public static final String CONTEXT_PATH ="<some path to a context.xml file>"; 
    public static final String APP_PROPERTIES_PATH = "<path to the properties file>";

    //...More static properties
}

此CONTEXT_PATH变量在不同的环境(开发,测试,生产)中有所不同。

我有一个gradle任务,可以生成要部署的JAR文件

task stormJar(type: Jar) {
    baseName = 'diagnostic'
    from { configurations.compile.collect { it.isDirectory() ? it : zipTree(it) } }
    with jar
}

我希望动态更改或引用CONTEXT_PATH变量,以便我们可以为不同的环境创建版本,而无需对此文件进行任何更改。

我相信在Android领域(BuildConfig)中可以找到解决方案,但是找不到针对纯Java项目的解决方案。

解决方案应该是这样的,它应该适用于IDE(IntelliJ和Eclipse)以及创建特定于环境的内部版本。

做下面的事情应该可以完成工作

gradlew build -pEnvironment=prod

没有太多关于gradle的经验。请指出正确的方向。

1 个答案:

答案 0 :(得分:1)

请注意,有一个有效的示例here

一种技术是生成Constants.java作为构建的一部分。考虑以下模板(存储为资源而不是Java代码):

public class Constants {
    public static final String CONTEXT_PATH = "__CONTEXT_PATH";
    public static final String APP_PROPERTIES_PATH = "__APP_PROPERTIES_PATH";
}

,以下内容在Constants.java任务的早期生成compileJava

compileJava.doFirst {
    def newConstantsFile = new File("${projectDir}/src/main/java/net/codetojoy/util/Constants.java")
    def templateConstantsFile = new File("${projectDir}/resources/TemplateConstants.java")

    newConstantsFile.withWriter { def writer ->
        templateConstantsFile.eachLine { def line ->
            def newLine = line.replace("__PACKAGE", "net.codetojoy.util")
                              .replace("__CONTEXT_PATH", getContextPath())
                              .replace("__APP_PROPERTIES_PATH", getAppPropertiesPath())
            writer.write(newLine + "\n");
        }
    }
}

,然后是关键的特定于env的谓词:

def getContextPath = { ->
    def result = "default"

    if (project.Environment == "prod") {
        result = "PROD context path here"
    } else if (project.Environment == "uat") {
        result = "UAT context path here"
    } else if (project.Environment == "dev") {
        result = "DEV context path here"
    }

    return result
}

def getAppPropertiesPath = { ->
    def result = "default"

    if (project.Environment == "prod") {
        result = "PROD app properties path here"
    } else if (project.Environment == "uat") {
        result = "UAT app properties path here"
    } else if (project.Environment == "dev") {
        result = "DEV app properties path here"
    }

    return result
}

请注意,特定于ENV的值可以轻松地抽象到配置文件,ENV vars等中。

还要注意,该示例处理以下内容:使用的Java package,项目版本和构建时间戳。我为大多数项目写了类似的东西。