How to Create a Simple Maven Project

Before we dive in, it’s important to know why we use maven at all.

So..

Why do we use Maven?

Maven helps us build java projects faster. It automates our build process by:

  1. Downloading dependencies
  2. Running unit tests
  3. Packaging artifacts

Maven creates a simple project structure that can be easily understood and shared.

It’s our handy build assistant…and it can learn new skills too!

How do we set Maven up?

What You’ll Need

  • JBoss Developer Studio w/ JBoss EAP 6.4 or higher. Download here (Steps 1 & 2)

Create a Project

If you’re using an IDE, this is fairly easy. I’m using JBoss Developer Studio, which is basically a flavor of Eclipse with a JBoss Application server runtime.

  1. Open JBoss Developer Studio
  2. Go to File -> New -> Project -> Maven Project. Click Next.maven1.png
  3. Make sure Create a simple project is left unchecked. Click Next.maven2.png
  4. Select the Internal catalog and find maven-archetype-quickstartmaven3.png
  5. Fill in the following and Click Finish
    • groupId – a unique identifier for your project. It’s usually your domain in reverse order. Ex. org.codelikethewind, org.apache
    • artifactId – the name of your project. This will also be the name of our JAR. Ex. simple-maven-projectmaven4.png
  6. Update Java to 1.6
    • Click on the pom.xml. Under Properties, create two properties

      Name(s):maven.compiler.source & maven.compiler.target
      Value:1.6

      Screen Shot 2017-03-08 at 10.27.06 AM

  7. Update Maven
    • Right click your project -> Maven -> Update Project
      Screen Shot 2017-04-14 at 11.22.10 AM

Maven’s standard templates make creating a project very simple. Let’s look around.

POM File (Project Object Model)

Open the pom.xml file and click the pom.xml tabmaven5.png

This file defines our project and specifies how it will be built. Right now, you’ll see

  1. Our project identifiers (groupId, artifactId, version, name)
  2. The packaging type (JAR)
  3. Our list of dependencies

Dependencies

Click on the Dependencies tab.

Screen Shot 2017-02-07 at 2.41.06 PM.png

When you build a project, Maven automatically downloads all required dependencies. This saves us from the frustrating task of managing dependencies ourselves.

There should be one dependency in your pom file called JUnit.

Unit Tests

When you build a project, Maven automatically runs your unit tests. Just make sure they are under the src/test/java folder.

There should be a sample test called AppTest

Packaging

Instead of having to manually package our JAR files, Maven will do this for us. The packaging element we saw in our pom file defines the type of artifact maven will create.

Plugins

Every capability in Maven is defined as a plugin. If we want to give Maven a new skill, we can define a new plugin in our POM file and it will run during the build cycle.

Ex. jboss-as plugin – after building, maven will automatically deploy applications to a remote JBoss Application Server

Build Your First Maven Project

    1. Right click the top level folder of your project -> Click Maven BuildScreen Shot 2017-02-07 at 2.43.52 PM.png
    2. In the goals section, type clean install. Click RunScreen Shot 2017-02-06 at 3.24.32 PM.png
    3. You should see a BUILD SUCCESS message

Maven downloaded our dependencies, ran our unit tests, compiled our artifacts. In one click.

Note: the actual build artifacts are stored in the target folder

Run Your First Maven Project

Our sample application prints a simple “Hello World” string to the console.

    1. Right click the top level folder of your project -> Run-As -> Java Application
    2. App should be selected. Click Ok.maven6.png
    3. “Hello World!”

What’s a best practice for using Maven?

At some point, you will run into the following scenario:

“I don’t see my code changes!?!”

Not to fear. Most likely Maven is using your old build artifacts.

So whenever building a project, remember to use the ‘clean install’ goals like we did above.

The extra clean step will remove old artifacts before creating new ones.

So…

  1. Maven helps us build java projects quickly by automatically downloading dependencies, running unit tests, and packaging our artifacts
  2. Maven templates are great starting points for creating new projects
  3. Use maven clean install goals to remove old artifacts before creating new ones.

Source Code & Useful Links

  1. Project Source Code
  2. Getting Started with Maven
  3. How to create multi-module Maven EAR projects

Happy Coding,

-T.O.

Proudly powered by WordPress | Theme: Baskerville 2 by Anders Noren.

Up ↑