Skip to main content

Sample pom.xml file for a Java project using Maven, along with an explanation of its key elements

Sample pom.xml file for a Java project using Maven, along with an explanation of its key elements:


<?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">

    <!-- This is the root element of the POM file. It defines the project and its configuration. -->


    <modelVersion>4.0.0</modelVersion>

    <!-- Specifies the POM model version. Always use 4.0.0 for modern Maven projects. -->


    <groupId>com.example</groupId>

    <!-- Specifies the group or organization that this project belongs to. -->


    <artifactId>my-java-project</artifactId>

    <!-- Specifies the name of the project or the unique identifier. -->


    <version>1.0.0</version>

    <!-- Specifies the version of the project. -->


    <packaging>jar</packaging>

    <!-- Specifies the packaging type. Common values include 'jar', 'war', 'pom', etc. -->


    <name>My Java Project</name>

    <!-- Specifies the human-readable name of the project. -->


    <description>A simple Java project built with Maven.</description>

    <!-- Provides a brief description of the project. -->


    <properties>

        <!-- Defines project-wide properties that can be reused in the POM. -->

        <maven.compiler.source>1.8</maven.compiler.source>

        <!-- Specifies the Java source version. -->

        <maven.compiler.target>1.8</maven.compiler.target>

        <!-- Specifies the Java target version. -->

    </properties>


    <dependencies>

        <!-- Specifies project dependencies. This example includes a JUnit dependency. -->

        <dependency>

            <groupId>junit</groupId>

            <artifactId>junit</artifactId>

            <version>4.12</version>

            <!-- Specifies the dependency's group, artifact, and version. -->

            <scope>test</scope>

            <!-- Specifies the scope of the dependency (e.g., 'compile', 'test', etc.). -->

        </dependency>

    </dependencies>


    <build>

        <!-- Configures the build process for the project. -->

        <sourceDirectory>src/main/java</sourceDirectory>

        <!-- Specifies the directory containing the main Java source code. -->

        <testSourceDirectory>src/test/java</testSourceDirectory>

        <!-- Specifies the directory containing test Java source code. -->


        <plugins>

            <!-- Specifies build plugins. This example includes the Maven Compiler Plugin. -->

            <plugin>

                <groupId>org.apache.maven.plugins</groupId>

                <artifactId>maven-compiler-plugin</artifactId>

                <version>3.8.1</version>

                <!-- Specifies the version of the plugin. -->


                <configuration>

                    <!-- Configures plugin-specific settings. -->

                    <source>${maven.compiler.source}</source>

                    <!-- Configures the source version. -->

                    <target>${maven.compiler.target}</target>

                    <!-- Configures the target version. -->

                </configuration>

            </plugin>

        </plugins>

    </build>

</project>



Explanation of Key Elements:
  • <modelVersion>: This specifies the POM model version, which should be set to 4.0.0 for modern Maven projects.
  • <groupId>: This is a unique identifier for your project's group or organization.
  • <artifactId>: This is the name of your project or module.
  • <version>: Specifies the version of your project.
  • <packaging>: Defines the type of packaging used for the project (e.g., jar, war, pom, etc.).
  • <name>: Provides a human-readable name for your project.
  • <description>: A brief description of your project.
  • <properties>: This section allows you to define project-wide properties that can be reused in the POM.
  • <dependencies>: Lists the project dependencies, including their group, artifact, version, and scope.
  • <build>: This section configures the build process, specifying source and test directories and build plugins.
  • <sourceDirectory> and <testSourceDirectory>: Define the directories containing main and test Java source code.
  • <plugins>: Specifies build plugins. In this example, it includes the Maven Compiler Plugin.
  • <plugin>: Configures a specific plugin. In this case, it configures the Maven Compiler Plugin to set Java source and target versions.

This is a basic pom.xml file for a Java project. You can add more configuration elements and plugins as needed for your specific project requirements.

Comments

Post a Comment

Popular posts from this blog

Example of Maven project that interacts with a MySQL database and includes testing

Example Maven project that interacts with a MySQL database and includes testing To install Java, MySQL, Maven, and write a Java program to fetch table data, execute, and create a JAR file using Maven on Ubuntu, you can follow these steps: Step 1: Install Java You can install Java using the following commands: sudo apt update sudo apt install default-jre sudo apt install default-jdk Verify the installation by running: java -version Step 2: Install MySQL You can install MySQL using the following commands: sudo apt update sudo apt install mysql-server During the installation, you'll be prompted to set a root password for MySQL or you can set password at latter stage using following steps.  sudo mysql ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'password'; exit Step 3: Install Maven You can install Maven using the following commands: sudo apt update sudo apt install maven Verify the installation by running: mvn -version Step 4: Create ...
Post a Comment
Read more

Maven Create and Build Artifacts

In Maven, you can create and build artifacts using the package phase of the build lifecycle. The package phase is responsible for taking the compiled code and other project resources and packaging them into a distributable format, such as a JAR (Java Archive), WAR (Web Application Archive), or other custom formats. Here are the steps to create and build artifacts using Maven: Configure the Build Output: In your project's pom.xml file, you need to configure the output of the build. This includes specifying the type of artifact you want to create (e.g., JAR, WAR) and any additional resources to include. You do this in the <build> section of your pom.xml: <build>     <finalName>my-artifact</finalName> <!-- Name of the artifact without the extension -->     <plugins>         <!-- Plugin configurations for creating the artifact -->         <!-- For example, maven-jar-plugin or maven-war-p...
Post a Comment
Read more

Maven Repositories (local, central, global)

Maven relies on repositories to manage dependencies, plugins, and other artifacts required for a project. There are typically three types of repositories in Maven: local, central, and remote/global repositories. Local Repository: Location: The local repository is located on your local development machine. By default, it's in the .m2 directory within your user home directory (e.g., C:\Users\<username>\.m2\repository on Windows or /Users/<username>/.m2/repository on macOS and Linux). Purpose: The local repository is used to store artifacts (JARs, POMs, and other files) that your machine has downloaded or built during previous Maven builds. These artifacts are specific to your local development environment. Benefits: Using a local repository improves build performance since it caches dependencies locally, reducing the need to download them repeatedly. It also ensures reproducibility by maintaining a local copy of dependencies. Central Repository: Location: The central repo...
Post a Comment
Read more