Adding Extra Source Directories in Maven with Build Helper Plugin

Dec 01, 2025 · Programming · 13 views · 7.8

Keywords: Maven | Build Helper Plugin | Source Directory

Abstract: This article explains how to include additional source directories, such as src/bootstrap, in the Maven build process using the Build Helper Plugin. It covers configuration, compilation, and inclusion in the JAR, with references to alternative methods.

Maven, a widely used build tool for Java projects, typically compiles source code from the src/main/java directory. However, developers often require additional source directories for modularity or specific configurations.

Solution Using Build Helper Plugin

The Build Helper Maven Plugin is the recommended approach for adding extra source directories. It integrates into the build lifecycle to ensure proper compilation and packaging.

Configure the plugin in your pom.xml by adding the following snippet:

<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.codehaus.mojo</groupId>
        <artifactId>build-helper-maven-plugin</artifactId>
        <version>3.2.0</version>
        <executions>
          <execution>
            <id>add-source</id>
            <phase>generate-sources</phase>
            <goals>
              <goal>add-source</goal>
            </goals>
            <configuration>
              <sources>
                <source>src/bootstrap</source>
              </sources>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
</project>

This configuration adds the src/bootstrap directory as a source directory during the generate-sources phase, enabling Maven to compile Java files from this directory and include them in the build JAR.

Considerations and Alternatives

As noted in other answers, simply adding a directory via the <resources> tag only copies files to the target without compilation. For instance:

<resources>
  <resource>
    <directory>src/main/config</directory>
  </resource>
</resources>

This method is suitable for non-Java resources but not for source code requiring compilation. Thus, the Build Helper Plugin offers a more robust solution for comprehensive build integration.

In summary, leveraging the Build Helper Plugin allows developers to efficiently manage multiple source directories, enhancing project flexibility and maintainability.

Copyright Notice: All rights in this article are reserved by the operators of DevGex. Reasonable sharing and citation are welcome; any reproduction, excerpting, or re-publication without prior permission is prohibited.