How to Develop AEM Projects using IntelliJ IDEA

Last update: April 17, 2024

CREATED FOR:

  • Developer

Overview

To get started with AEM development on IntelliJ, the following steps are required.

Each step is explained in more detail in the remainder of this topic.

  • Install IntelliJ
  • Set up your AEM project based on Maven
  • Prepare JSP support for IntelliJ in the Maven POM
  • Import the Maven Project into IntelliJ
NOTE
This guide is based on IntelliJ IDEA Ultimate Edition 12.1.4 and AEM 5.6.1.

Install IntelliJ IDEA

Download IntelliJ IDEA from the Downloads page at JetBrains.

Then, follow the installation instructions on that page.

Set up your AEM project based on Maven

Next, set up your project using Maven as described in How-To Build AEM Projects using Apache Maven.

To start working with AEM Projects in IntelliJ IDEA, the basic setup in Getting Started in 5 Minutes is sufficient.

Prepare JSP Support for IntelliJ IDEA

IntelliJ IDEA can also provide support in working with JSP, for example:

  • auto-completion of tag libraries
  • awareness of objects defined by <cq:defineObjects /> and <sling:defineObjects />

For that to work, follow the instructions on How-To Work with JSPs in How-To Build AEM Projects using Apache Maven.

Import the Maven Project

  1. Open the Import dialog in IntelliJ IDEA by

    • selecting Import Project on the welcome screen if you have no project open yet
    • selecting File > Import Project from the main menu

  2. In the Import dialog, select the POM file of your project.

    chlimage_1-45

  3. Continue with the default settings as shown in the dialog below.

    chlimage_1-46

  4. Continue through the following dialogs by clicking Next and Finish.

  5. You are now set up for AEM Development using IntelliJ IDEA

    chlimage_1-47

Debugging JSPs with IntelliJ IDEA

The following steps are necessary for debugging JSPs with IntelliJ IDEA

  • Set up a Web Facet in the Project
  • Install the JSR45 support plugin
  • Configure a Debug Profile
  • Configure AEM for Debug Mode

Set up a Web Facet in the Project

IntelliJ IDEA must understand where to find the JSPs for debugging. Because IDEA cannot interpret the content-package-maven-plugin settings, it must be configured manually.

  1. Go to File > Project Structure
  2. Select the Content module
  3. Click + above the list of modules and select Web
  4. As the Web Resource Directory, select the content/src/main/content/jcr_root subdirectory of your project as shown in the screenshot below.

chlimage_1-48