IntelliJ IDEA 2019.2 Help

Maven

IntelliJ IDEA supports a fully-functional integration with Maven that helps you automate your building process. You can easily create a new Maven project, open and sync an existing one, add a Maven support to any existing IntelliJ IDEA project, configure and manage a multi-module project.

Create a new Maven project

  1. If no project is currently open in IntelliJ IDEA, click Create New Project on the Welcome screen. Otherwise, select File | New | Project from the main menu.

  2. Select Maven from the options on the left.

  3. Specify project's SDK (JDK) or use the default one and an archetype if you want to use a predefined project template (configure your own archetype by clicking Add Archetype).

    Click Next.

  4. On the next page of the wizard, specify the following Maven basic elements that are added to the pom.xml file:
    • GroupId - a package of a new project.

    • ArtifactId - a name of your project.

    • Version - a version of a new project. By default, this field is specified automatically.

    Click Next.
  5. If you are creating a project using a Maven archetype, IntelliJ IDEA displays the Maven settings that you can use to set the Maven home directory and Maven repositories. Also, you can check the archetype properties.

    Click Next.

  6. Specify the name and location settings.

    Click Finish.

Open an existing Maven project

  1. From the main menu, select File | Open.

  2. In the dialog that opens, select the pom.xml file of the project you want to open.

    Click OK.

  3. In the dialog that opens, click Open as Project.

IntelliJ IDEA opens and syncs the Maven project in the IDE.

Add a new Maven module to an existing project

You can add a Maven module to the project in which you are already working.

  1. In the Project tool window, right-click the project folder and select New | Module. Alternatively, from the main menu, select File| New | Module to open the New Module wizard.

  2. If you used main menu to add a module then the process of adding a module is the same as Creating a new Maven project.

    If you are adding sub modules by right-clicking the root folder then the process of adding a new module is shorter. You need to specify the name of your module in the ArtifactId field. The rest of the information is added automatically and you can use either the default settings or change them according to your preferences. Also, note that Add as module to and Parent fields, by default, display the basic Maven attributes (groupId, artifactId, and version) of the project to which you are trying to add the module. You can click the Browse button to change the information displayed.

Configure a multi-module Maven project

You can create a multi-module Maven project in IntelliJ IDEA. The multi-module project is defined by a parent POM file with several sub modules.

  1. Create a Maven parent project. IntelliJ IDEA creates a standard Maven layout including an src folder.

  2. In the Project tool window, remove the src folder since you would only need it in the very rare cases. For your general project, you don't need the src folder for the parent POM.

  3. In the Project tool window, right-click your project (or from the main menu, click File) and select New | Module to add a sub project.

  4. In the New Module wizard following the instructions on how to add a module, specify the necessary information and click Finish.

    The src folder is created automatically and you can open POM and add a packaging that you need. IntelliJ IDEA adds the module to the parent project. IntelliJ IDEA also adds name and the description of the sub project to the parent POM.

    the parent POM
    Note that the packaging in the parent POM is defined as pom since it is an appropriate packaging for the parent project which refers to other sub projects.

    Last, but not least, IntelliJ IDEA adds the description of the parent POM to the sub project's POM.

    the subproject POM
    You can click the Parent POM icon in the left gutter to quickly open the parent POM from your sub project.
  5. You can also add dependencies to the parent POM that will be inherited by the sub projects.

    Parent POM: added dependency

  6. Open Maven tool window to see that all changes made in the parent POM are reflected in sub projects.

    the Maven tool window

Install the Maven 2 version

  1. Download the Maven 2 version on your computer.

  2. From the main menu select File | Settings/Preferences | Build, Execution, Deployment |Build Tools | Maven.

  3. On the Maven settings page, in the Maven home directory field, specify the location of the Maven 2 installation.

  4. Click OK.

Last modified: 28 August 2019