Skip to main content

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

    </plugins>

</build>

Depending on your project type and requirements, you would use different plugins (e.g., maven-jar-plugin for JAR projects or maven-war-plugin for web applications).

Run the Build: To create and build the artifact, you run the Maven build command. Open a command prompt or terminal in your project's directory and execute:

mvn clean package

clean: This goal removes the target directory, which contains the output of previous builds. It ensures that you start with a clean slate.

package: This goal is responsible for creating the artifact as specified in your project's pom.xml.

Review the Output: After running the Maven command, you'll find the built artifact in the target directory within your project's root directory. The name of the artifact is usually determined by the <finalName> configuration in your pom.xml file.

Deploy or Use the Artifact: Depending on your project's requirements, you can deploy the generated artifact to a repository, use it in other projects, or distribute it as needed.

Here's a more detailed example for creating a JAR artifact:

<project>

    <!-- ... -->

    <build>

        <finalName>my-jar-artifact</finalName>

        <plugins>

            <plugin>

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

                <artifactId>maven-jar-plugin</artifactId>

                <version>3.2.0</version>

                <configuration>

                    <archive>

                        <manifest>

                            <mainClass>com.example.MainClass</mainClass>

                        </manifest>

                    </archive>

                </configuration>

            </plugin>

        </plugins>

    </build>

    <!-- ... -->

</project>

In this example, the maven-jar-plugin is configured to create a JAR artifact with a specified main class in the manifest file. When you run mvn clean package, it will generate a JAR file with the name my-jar-artifact.jar in the target directory.

Remember that Maven is highly configurable, and you can customize the build process, including artifact creation, to meet the specific needs of your project.

Labels:

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