How to refer environment variable in POM.xml?

In Maven, using environment variables in the pom.xml file is a common practice, especially when the build process needs to be adjusted based on different environments. Here, I will explain how to reference environment variables in pom.xml with examples.

Step 1: Reference Environment Variables

In Maven, you can reference environment variables using the ${env.VAR_NAME} syntax, where VAR_NAME is the name of the environment variable defined in your system. For example, if you have an environment variable named JAVA_HOME, you can reference it in pom.xml as follows:

xml
<properties>
    <java.home>${env.JAVA_HOME}</java.home>
</properties>

Step 2: Using Referenced Environment Variables

Referenced environment variables can be used anywhere in the pom.xml file, such as in defining plugin configurations or setting build paths. For instance, using the java.home property defined above to set the JDK path:

xml
<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <version>3.8.1</version>
            <configuration>
                <source>1.8</source>
                <target>1.8</target>
                <executable>${java.home}/bin/javac</executable>
            </configuration>
        </plugin>
    </plugins>
</build>

Example: Adjusting Configuration Based on Environment Variables

Assume we have two environment variables, ENVIRONMENT and DB_PASSWORD, which indicate the current environment (development or production) and the database password, respectively. We can use these environment variables in pom.xml to dynamically configure the project:

xml
<profiles>
    <profile>
        <id>development</id>
        <activation>
            <property>
                <name>env.ENVIRONMENT</name>
                <value>dev</value>
            </property>
        </activation>
        <properties>
            <db.password>${env.DB_PASSWORD}</db.password>
        </properties>
    </profile>

    <profile>
        <id>production</id>
        <activation>
            <property>
                <name>env.ENVIRONMENT</name>
                <value>prod</value>
            </property>
        </activation>
        <properties>
            <db.password>${env.DB_PASSWORD}</db.password>
        </properties>
    </profile>
</profiles>

In this example, we define two Maven profile configurations—one for the development environment and one for the production environment. Based on the value of the ENVIRONMENT environment variable, Maven activates the corresponding profile and uses the appropriate database password.

By doing this, you can achieve flexible and adaptable project configuration, facilitating deployment and testing across different environments.