Make a maven dependency provided based on active spring profile

Question

So I am building a spring boot web application, packaging as a war, and deploying to a tomcat application server.

I have the following dependency in my pom.xml for tomcat:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
    <scope>provided</scope>
</dependency>

The scope of this dependency needs to be provided in order to be able to deploy it to a tomcat instance. However, when I want to run the war via the spring boot CLI or via IntelliJ's default spring boot run configuration, I need to remove the <scope>provided</scope> in order for it to run the embedded tomcat.

My question is, is there some way to make the dependency conditionally provided based on an active spring profile, or some other method?

Solution 1

In your specific case, you can just do : In the dependencies to run spring-boot with embedded tomcat :

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-tomcat</artifactId>
</dependency>  

And in a profile to deploy under tomcat

<profile>
    <id>tomcat</id>
    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-tomcat</artifactId>
            <scope>provided</scope>
        </dependency>
    </dependencies>
</profile>

After, to build for a specific profile

mvn clean install -Ptomcat

Solution 2

You can't control dependencies via spring profiles. However you can control spring profiles by maven profiles and it can solve your problem.

You can declare several maven profiles in your application and provide different set of dependencies for each of them. Then you can configure maven profiles to use particular spring profile. Take a look on maven profiles and an example of such configuration in this thread

Solution 3

This is a solution that will work with both, jar and war packaging:

pom.xml

    ...
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.4.4.RELEASE</version>
        <relativePath /> <!-- lookup parent from repository -->
    </parent>

    <modelVersion>4.0.0</modelVersion>
    <artifactId>...</artifactId>
    <groupId>...</groupId>
    <version>0-SNAPSHOT</version>
    <packaging>${packaging.type}</packaging>
    ...
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <start-class>...</start-class>
        <packaging.type>jar</packaging.type>
    ...
    </properties>
    <dependencies>
        <dependency>
            <!-- Brings in Embedded Tomcat dependencies -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
...
    </dependencies>

    <profiles>
        <profile>
            <id>tomcat-war</id>
            <properties>
                <packaging.type>war</packaging.type>
            </properties>
            <dependencies>
                <dependency>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-tomcat</artifactId>
                    <scope>provided</scope>
                </dependency>
            </dependencies>
    ...
    </profiles>

    <build>
            <finalName>${project.artifactId}</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <executions>
                        <execution>
                            <goals>
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
    ...

Build artifact as jar:

mvn clean package

Build artifact as war:

mvn clean package -Ptomcat-war

Main class, that goes in <start-class> in pom.xml:

package ...

public class Application extends SpringBootServletInitializer {

    @Override
    protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
        return builder.sources(Application.class);
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}