In the previous tutorial, I showed you how to create a Maven Archetype for a normal Maven project. For Maven multi-module projects, how to create Maven Archetype? We will find out together in this article!
As an example, I will take an example project of Clean Architecture in the article Introduction about Clean Architecture – Part 2 to build a Maven Archetype for this example project. You can find the source code of this example project here https://github.com/khanhnguyenj/huongdanjava.com/tree/master/clean-architecture-example.
First, I will also create a new Maven Archetype project using Maven Archetype maven-archetype-archetype, the results are as follows:
First, I will copy the contents of the pom.xml file in the clean-architecture-example project and replace the contents of the pom.xml file at the project’s src/main/resources/archetype-resources directory.
We will edit the version of the dependencies so that they are updated to the latest version!
The content of pom.xml file of my Maven Archetype project will be as follows:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>3.1.1</version> <relativePath /> <!-- lookup parent from repository --> </parent> <groupId>com.huongdanjava</groupId> <artifactId>clean-architecture-example</artifactId> <version>1.0-SNAPSHOT</version> <packaging>pom</packaging> <modules> <module>rest</module> <module>use-cases</module> <module>db</module> <module>entities</module> <module>configuration</module> </modules> <dependencyManagement> <dependencies> <dependency> <groupId>com.huongdanjava</groupId> <artifactId>entities</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>com.huongdanjava</groupId> <artifactId>use-cases</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>com.huongdanjava</groupId> <artifactId>db</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>com.huongdanjava</groupId> <artifactId>rest</artifactId> <version>1.0-SNAPSHOT</version> </dependency> <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-core</artifactId> <version>6.2.5.Final</version> </dependency> </dependencies> </dependencyManagement> </project> |
We will use the placeholders ${groupId}, ${artifactId}, and ${version} to replace the groupId, artifactId, and version information defined above so that when generating the project from our Maven Archetype project, these information is taken from user input:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 |
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> ... <groupId>${groupId}</groupId> <artifactId>${artifactId}</artifactId> <version>${version}</version> <packaging>pom</packaging> ... <dependencyManagement> <dependencies> <dependency> <groupId>${groupId}</groupId> <artifactId>entities</artifactId> <version>${version}</version> </dependency> <dependency> <groupId>${groupId}</groupId> <artifactId>use-cases</artifactId> <version>${version}</version> </dependency> <dependency> <groupId>${groupId}</groupId> <artifactId>db</artifactId> <version>${version}</version> </dependency> <dependency> <groupId>${groupId}</groupId> <artifactId>rest</artifactId> <version>${version}</version> </dependency> ... </dependencies> </dependencyManagement> </project> |
Next, we will copy the module directories from the clean-architecture-example project to the src/main/resources/archetype-resources directory of the Maven Archetype project.
The following results:
In order for the modules to be generated as we want, like the clean-architecture-example project, we need to edit a little bit of the content of the module directories.
Specifically, for the configuration module, in the pom.xml file of this module, we will use the placeholders ${groupId}, ${rootArtifactId} and ${version} to replace the information about groupId, artifactId and version of the parent and module dependencies. The value of the placeholder ${rootArtifactId} will be the artifactId value that the user input!
The contents of the pom.xml file in the configuration directory will look like this:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 |
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <parent> <groupId>${groupId}</groupId> <artifactId>${rootArtifactId}</artifactId> <version>${version}</version> </parent> <modelVersion>4.0.0</modelVersion> <artifactId>configuration</artifactId> <dependencies> <dependency> <groupId>${groupId}</groupId> <artifactId>use-cases</artifactId> </dependency> <dependency> <groupId>${groupId}</groupId> <artifactId>db</artifactId> </dependency> <dependency> <groupId>${groupId}</groupId> <artifactId>rest</artifactId> </dependency> ... </dependencies> ... </project> |
For the Application class, we will move it to the /src/main/java directory and replace the package name with the placeholder ${package} as follows:
|
1 2 3 4 5 6 7 8 9 10 11 12 |
package ${package}; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; @SpringBootApplication public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } |
Since the UseCaseConfiguration class is in a sub-package, we will move this class to the src/main/java/configuration directory and edit its content as follows:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 |
package ${package}.configuration; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import ${package}.db.StudentAdapterImpl; import ${package}.usecases.adapter.StudentAdapter; import ${package}.usecases.student.FindStudentByNameUseCase; @Configuration public class UseCaseConfiguration { @Bean FindStudentByNameUseCase findStudentByNameUseCase(StudentAdapter studentAdapter) { return new FindStudentByNameUseCase(studentAdapter); } @Bean StudentAdapter studentAdapter() { return new StudentAdapterImpl(); } } |
Please notice that I have also replaced the placeholder ${package} in the import lines so that when generating the project, the package information will be taken from the user input.
For the remaining modules, please do the same!
The last step that we need to do is configure the archetype-metadata.xml file located in the src/main/resources/META-INF/maven directory to include all the necessary files and directories when generating the Maven project using our Maven Archetype project.
We will use the <modules> tag along with the <module> tag to include the module directories into the project in the archetype-metadata.xml file, specifically as follows:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
<archetype-descriptor xmlns="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-archetype-plugin/archetype-descriptor/1.0.0 http://maven.apache.org/xsd/archetype-descriptor-1.0.0.xsd" name="${artifactId}"> <modules> <module dir="configuration"> <fileSets> <fileSet filtered="true" packaged="true"> <directory>src/main/java</directory> </fileSet> <fileSet filtered="true"> <directory>src/main/resources</directory> </fileSet> </fileSets> </module> <module dir="db"> <fileSets> <fileSet filtered="true" packaged="true"> <directory>src/main/java</directory> </fileSet> </fileSets> </module> <module dir="entities"> <fileSets> <fileSet filtered="true" packaged="true"> <directory>src/main/java</directory> </fileSet> </fileSets> </module> <module dir="rest"> <fileSets> <fileSet filtered="true" packaged="true"> <directory>src/main/java</directory> </fileSet> </fileSets> </module> <module dir="use-cases"> <fileSets> <fileSet filtered="true" packaged="true"> <directory>src/main/java</directory> </fileSet> </fileSets> </module> </modules> </archetype-descriptor> |
As you can see, I have defined each module in our project using a <module> tag. In each <module> tag, we define <fileSets> to copy the directory files in each module as we want, like when we create Maven Archetype project for normal Maven projects.
At this point, we have finished configuring the Maven Archetype for the Maven multi-module project!
Please run “mvn clean install” in the root directory of the project and then import the project basic-project in the directory
target/test-classes/projects/it-basic/project/ into a certain IDE, you will see the following results:
