Skip to main content

POM files

POM (Project Object Model) files are an essential part of Apache Maven. They are XML files used to define the configuration, dependencies, and other project-related information for Maven-based projects. POM files reside in the root directory of the project and have the name "pom.xml".

Here are the key elements that can be specified in a POM file:

  1. Project Information: The POM file contains general information about the project, such as the project's name, description, version, and organization.
  2. Project Dependencies: POM files define the project's dependencies on external libraries or modules. Dependencies specify artifacts (JARs, WARs, etc.) that are required to build and run the project.
  3. Build Settings: Maven uses plugins to perform various build tasks. The POM file specifies which plugins to use and how to configure them for tasks like compiling code, running tests, packaging the project, etc.
  4. Project Repositories: POM files can include information about the repositories where Maven should look for dependencies that are not available in the local repository.
  5. Project Inheritance: POM files can inherit from a parent POM, which allows common configurations to be shared across multiple projects.
  6. Profiles: Profiles in POM files allow you to define specific build configurations that can be activated under certain conditions, such as different environments (development, production) or operating systems.
  7. Reporting: POM files can configure reporting plugins that generate various project reports, such as test coverage, code quality, and more.


Here's a simple example of a POM file:


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

    

    <!-- Project Information -->

    <groupId>com.example</groupId>

    <artifactId>my-project</artifactId>

    <version>1.0.0</version>

    <name>My Project</name>

    <description>A sample Maven project</description>

    

    <!-- Project Dependencies -->

    <dependencies>

        <dependency>

            <groupId>org.apache.commons</groupId>

            <artifactId>commons-lang3</artifactId>

            <version>3.12.0</version>

        </dependency>

    </dependencies>

    

    <!-- Build Settings -->

    <build>

        <plugins>

            <!-- Maven Compiler Plugin -->

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

                </configuration>

            </plugin>

        </plugins>

    </build>

</project>



In this example, the POM file defines the project's basic information, including its name, description, and version. It also specifies a project dependency on the Apache Commons Lang library and configures the Maven Compiler Plugin to use Java 8 as the source and target version for compilation.


With the POM file in place, Maven can read the configuration and perform various tasks, such as downloading dependencies, compiling the code, running tests, and packaging the project. The POM file serves as the backbone of Maven-based projects, enabling efficient and standardized project management.

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