IntelliJ IDEA lets you manage Maven dependencies in your project. You can add, import Maven dependencies, and view them in the diagram.
Add a Maven dependency
IntelliJ IDEA lets you add a Maven dependency to your project. We recommend that you specify the dependency inside your POM. Dependencies that you set up manually inside IntelliJ IDEA module settings will be discarded on the next Maven project reload.
Open your POM in the editor.
Press Alt+Insert to open the Generate context menu.
From the context menu, select Dependency or Dependency Template for quick search.
- In the dialog that opens either search for artifacts or for classes if you switch to the Search for class tab.
The syntax for searching Maven artifacts is as follows:group-id:artifact-id:versionYou can also use the
:*:wildcard character to specify your search where
:acts as a separator between group-id, artifact-id and version.
For example, typingTyping
*:fest:*will return artifacts that contain "fest" part in their
easy:*:4will return artifacts that have "4" in their versions and "easy" in their
group-id. Click Add. IntelliJ IDEA adds the dependency to your pom.xml.
IntelliJ IDEA also adds the dependency to the Dependencies node in the Maven tool window and to the External Libraries in the Project tool window.
If the added dependency has its own transitive dependencies, IntelliJ IDEA displays them in both tool windows.
Enable annotation processors
Open your POM file.
- Specify the
For example, check the following code:<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>3.5.1</version> <configuration> <annotationProcessorPaths> <annotationProcessorPath> <groupId>org.sample</groupId> <artifactId>sample-annotation-processor</artifactId> <version>1.2.3</version> </annotationProcessorPath> </annotationProcessorPaths> <configuration> </plugin> </plugins> </build>For more information, refer to Maven.
Re-import your project. IntelliJ IDEA creates an annotation processors profile, enables the annotation processing and adds the appropriate path to the Annotation Processor settings located in .
Centralize dependency information
In a multi-module Maven project, the dependency in the parent POM will be inherited by all sub projects. You can use
dependencyManagement to consolidate and centralize the management of the dependencies' versions.
Open your POM in the editor.
Press Alt+Insert to open the Generate context menu.
From the context menu, select the Managed Dependency option that will show you the list of the dependencies that are defined in the
dependencyManagementsection of your parent POM in a multi-module project. IntelliJ IDEA also shows the list of dependencies from the BOM files.
Select the desired dependency and click OK. The dependency is added to the POM. You don't need to specify the version on the dependency it will be taken from the
DependencyManagement. However, if you want to overwrite the defined version, you need to include
versionwhen you add the managed dependency to the POM.
Add a scope for the Maven dependency
You can add a scope for your dependency using POM. In this case IntelliJ IDEA will execute the dependency at the specified phase.
In your POM, in the dependency description add
scopeand using the code completion add the name of the scope.
Import your changes. The name of the scope is displayed in the Maven tool window. In the Project Structure dialog, on the Modules page you can see that the scope of the dependency is also displayed. Note that changing dependency's scope in the Project Structure dialog will not affect the pom.xml file.
You can also add a custom jar file as a dependency using the Maven scope system when you define your dependency. However, note that this dependency will only be available on your machine and you can use it only for the local deployment.
Work with Maven transitive dependencies
You can view transitive dependencies that were pulled in with the added or imported Maven dependency. You can check their versions, change them, or exclude those dependencies altogether.
The Maven tool window displays the direct dependency and all its transitive dependencies that were pulled in.
View the transitive dependency
In your project's POM, press Ctrl and hover the mouse over the dependency.
Click the dependency to open the dependency's POM.
In the dependency POM, view the active dependency, its transitive dependencies and their versions. You can check the origin from which the dependency was pulled in.
Exclude the transitive dependency
You can exclude a transitive dependency if you want.
Open the dependency POM and find the transitive dependency you want to exclude. Copy
- In your project POM, underneath your active dependency, enter
exclusionsand using code completion paste the copied info of the dependency you want to exclude. The dependency is also excluded from the Project and Maven tool windows.
Import Maven dependencies
You can import dependencies to your Maven project. When IntelliJ IDEA imports the added dependency, it parses the dependency and updates your project.
In the pom.xml file, add a dependency you need. When you change the pom.xml, IntelliJ IDEA displays a notification suggesting to load the changes. Click in the editor to import the dependency and update your project.
View Maven dependencies as a diagram
IntelliJ IDEA lets you view and work with Maven dependencies in a diagram format.
Generate a diagram
- In the Maven tool window, on the toolbar, click or select the appropriate option from the context menu.
In the diagram window, IntelliJ IDEA displays the sub project and all its dependencies including the transitive ones.
View the diagram structure
Generate a diagram.
- Click Structure in the left toolbar. IntelliJ IDEA opens the Structure tool window that displays a map of your diagram with a small preview of the selected block and its neighbors.
Use the context menu to zoom in and out, move canvas, change layout, and export part of the diagram into an image.
You can perform different actions while in the diagram window.
Change the visibility level
You can change the visibility level and, for example, view dependencies that have a specific scope (compile, test, and so on).
In the diagram window, select the sub project and click .
From the list, select the dependency scope you want to see. IntelliJ IDEA displays only the specified dependency scope.
Navigate to POM
You can easily navigate to POM from the diagram window.
Select the desired node, and press F4, or chooseon its context menu. The corresponding file opens in the editor.
You can check conflicts and duplicates by clicking icon in the diagram window.
Check conflicts and duplicates
In the diagram window, click icon.
The red arrow points to dependencies that contain duplicates or errors. IntelliJ IDEA also displays dependencies' versions to help you resolve the conflicts. Double-click the dependency to open its POM.
Show path from the selection to the root
You can select dependencies and see how they are included into the project.
In the diagram window, select a dependency for which you want to see a connection to a project. If you want to select several dependencies at once, hold down Shift and make the selection.
Show neighbors of the selected node
You can select dependencies and see what other dependencies are connected to the selected nodes. It might be helpful if you have a large diagram and want to focus on just a part of it.
In the diagram window, select a dependency you need. If you want to select several dependencies at once, hold down Shift and make the selection.
Click . .
Exclude a dependency
You can use a diagram to exclude a dependency from the project's POM.
Select a dependency in the diagram window.
From the context menu, choose.
- From the list, select the module (if any) where the exclusion definition will be added. The selected dependencies will be removed from diagram, and the
exclusionsection will be added to the corresponding dependency in the module's POM.