IntelliJ IDEA 2019.2 Help

Spring

Configure the Spring facet

To use Spring in your project, you need the Spring facet that comprises libraries and UI elements for configuring Spring-specific settings.

IntelliJ IDEA automatically detects Spring configuration in your code. The IDE will inform you if the project requires any adjustements and will suggest the necessary actions. So normally, you need no manual configuration.

However, if IntelliJ IDEA could not detect configuration files automatically, you can add the facet manually:

Manually add Spring support to existing modules

  1. Press Ctrl+Shift+Alt+S to open the Project Structure dialog.

  2. From the left-hand list, select Modules.

  3. Select the necessary module and click the Add button in the middle section.

  4. Select Spring from the list.

  5. You might need to set up a library when adding the facet. In this case, click Fix at the bottom of the window next to a warning message.

    If you already have a Spring library, you can use it as is, or create a new library using JAR files on your computer. In this case, select the Use library option.

    If you do not have a library, select Download.

If the Spring facet is configured correctly, you will see Spring gutter icons marking each component, bean, and so on. To configure gutter icons, press Ctrl+Alt+S and go to Editor | General | Gutter Icons.

Create an application context

Spring application context is a way of grouping configuration files in IntelliJ IDEA. When you create a context, you let IntelliJ IDEA understand relationship between configuration files included into this context.

You can create as many application contexts as you need; any configuration file may be included in more than one context.

  1. Press Ctrl+Shift+Alt+S and select Facets.

  2. Select the Spring facet from the list and click the Add button in the right-hand section.

  3. In the New Application Context dialog, enter a name, and select files you want to include in the context.

Adding application context

Configure a parent context

IntelliJ IDEA allows you to configure a parent-child relationship between contexts. Beans from a parent context are visible to beans in child contexts, but not vice versa. Therefore, beans from child contexts can use configuration from the parent context.

For example, Spring MVC applications usually have two contexts. One context belongs to web layer beans, another context is used for services and repositories. The web layer context will be a child context in this case, as you need to inject services into controllers, not other way around.

To configure a parent context, use the New Application Context dialog.

The Multiple Context panel shows up on top of the editor for files included into two or more application contexts. You can use this panel to select another active context, for example, if you want to run your application with different configuration, and change highlighting.

To disable the panel, click the Settings button, and clear the Show Multiple Context panel checkbox.

Spring diagrams

Spring diagrams help you analyze dependencies in your application. You can double-click a bean or a file on a diagram to open it in a dedicated tab in the editor.

Spring Beans Dependencies diagram

The Spring Beans Dependencies diagram lets you view and analyze dependencies between beans in your project.

Open the diagram

  1. Right-click the bean for which you want to build a diagram. You can also build a diagram for a class to see beans and their dependencies inside this class.

  2. Select Diagrams from the menu.

  3. Select Show Diagram Popup Ctrl+Alt+U to open the diagram in a local popup window, or Show Diagram Ctrl+Shift+Alt+U to open the diagram in the editor.

  4. Click the Spring Beans Dependencies icon Spring Beans Dependencies.

    The Spring Beans Dependencies diagram

    If you want to view only direct dependencies between beans on the diagram, select the Neighborhood mode Neighborhood mode icon.

Spring Application Context Dependencies diagram

The Spring Application Context Dependencies diagram lets you view dependencies between multiple configuration files and analyze how they include and reference each other.

Red arrows on the diagram mark errors (such as circular dependencies) and allow you to easily spot and remove them from your Spring configuration.

Open the diagram

  1. Right-click the configuration file for which you want to build a diagram.

  2. Select Diagrams from the menu.

  3. Select Show Diagram Popup Ctrl+Alt+U to open the diagram in a local popup window, or Show Diagram Ctrl+Shift+Alt+U to open the diagram in the editor.

  4. Click Spring Application Context Dependencies icon Spring Application Context Dependencies.

    Spring Application Context Dependencies diagram

Solid blue arrow

A solid blue line stands for @ComponentScan annotation dependencies.

Solid yellow arrow

A solid yellow line stands for @Enable annotation dependencies.

Dashed green arrow

A dashed green line stands for @Import annotation dependencies.

Dotted red arrow

Solid red arrow

Red lines stand for errors.

Dotted grey arrow

Dotted grey lines stand for other dependencies.

Browse dependencies in the Spring tool window

The Spring tool window helps you navigate between Spring components and dependencies. You can view definitions for Spring beans used in your project, and see how they are related to other beans.

To access the Spring tool window, go to View | Tool Windows | Spring.

Spring tool window

The Beans tab shows definitions for Spring beans used in your project, their documentation, and how they are related to other beans. Each bean is marked with an icon — Spring bean (beans defined in XML files); Spring Java bean (auto-discoverable beans declared through @Component annotations); Spring implicit bean (service beans added by Spring that not defined explicitly).

Use icons on the left frame to change the way beans are displayed, view documentation, or build a graph.

The MVC tab allows you to view controller mappings for the Spring MVC framework. You can also use the Spring Request method icon Request Method option to filter mappings by HTTP method.

If your configuration comprises Spring Data, the Data tab will show you the list of repositories, their queries and their projection.

Change active profiles

Spring allows you to map specific contexts or beans to different profiles — for example, test or production. This way, you can activate different profiles in different environments.
If you have defined at least one profile in your project, IntelliJ IDEA will show a special panel on top of the editor. You can use this panel to view the current profile name and to change active profiles:

  1. Click Change Profiles on the panel.

  2. Select the component to which you want to map the profile. This can be either an entire project, the current module, or context.

  3. Select the profile to which you want to map this component.

Changing the Spring profile

If you want to hide the panel, click Settings on it. In the next dialog, clear the Show Profiles Panel checkbox.

Last modified: 17 October 2019