JSP debugging in IntelliJ IDEA

Debugging Problem Overview

Does anyone know how to debug JSP in IntelliJ IDEA?

When I set breakpoint in my JSP files, those breakpoints never seem to take effect. The debugger never hits them. IDEA seems to think that the breakpoints are valid. I do see a red dot placed to the left of the line where I place my breakpoint.

I read in IntelliJ forum in this post that JSP files need to be under web-inf for debugging to work.

But then I also read that JSP files placed under web-inf won't be directly accessible by the user.

I am not sure who's really right.

Debugging Solutions

Solution 1 - Debugging

For JSP debugging in Intellij there are some configurations that must be in order. The fact that Intellij always allows you to add a breakpoint on a JSP line does not necessarily imply that you’ve configured JSP debugging. In the following I refer to Intellij 8 configuration, w.r.t. previous versions you will need to do similar operations as the concepts are the same.

In order to enable JSP debugging you must do two steps: set a web application configuration in your project and add a web application server configuration.

Web application Configuration: in order to have JSP debugging, you must have a “web” facet in your project structure, pointing to the correct web.xml file. Depending on the kind of web application structure you are using, the facet may be detected automatically by Intellij (go anyway to check what it has done) or you may have to add it manually. Remember in the “Java EE build settings” tab to set as anable “Create web facet exploded directory”; if you don’t want duplications, a trick is just to enable it and point to your already existing directory.

(Web) Application server: Go to “edit configurations”, there you have to add to configurations an application server, not launch the web server as an application like any other. In this way Intellij will be able to intercept JSP calls. In the list of application servers, you should have the default one, Tomcat. Be sure to have a local Tomcat installation before you do this, and point to that when adding the web application server. The last trick is going to the “Deployment” tab and selecting as “Deployment source” the same facet that you configured in the previous step.

The same configuration works if you want to use another web application server, I tested it with the latest Caucho Resin releases and debugging works fine (it didn’t with the previous Intellij and Resin combinations).

If you don’t see Tomcat in the list of available application servers to add, check the plugins in the general Intellij settings pane: in the latest releases, more and more functionality has become “pluggable”, and even very basic functions may be disabled; this plugin is called “Tomcat integration”.

Finally, it is surely not true that JSP files need to be under WEB-INF to be under debugging.

Solution 2 - Debugging

For remote JSP debugging (which also applies to localhost) you'll need to install the JSR45 ㄧ support plugin. Please note this feature is only supported in the Ultimate edition of IntelliJ, not the community edition.

Go to Preferences > Plugins, search for the JSR45 plugin, and enable it.
Create a run configuration: Run > Run Configuration > click the + button, and pick JSR45 Compatible Server, and then in the dialog that opens, select Remote, and set server host and port. Setting Application Server: Generic should work fine.
Make sure you set the correct port in Startup/Configuration > Debug.
Open the module settings (F3 on the project folder), and add a Web Facet under Facets, and under Web Resource Directories specify your JSP root folder.
Click the Configuration... button, and select the folders with the beans, classes and libraries that your JSPs depend on.

Now JSP breakpoints should work, provided that you started your server with the proper debug arguments.

> ^{If you have a maven project with auto-import enabled then you might want to disable auto-import because every time the auto-import is triggered your library settings will be reset.}

Solution 3 - Debugging

Anyway, you need to launch the Tomcat in IDEA, not from a remote Tomcat.

Solution 4 - Debugging

Please make sure, that in you tomcat's conf/web.xml suppressSmap is not enabled as support of JSR45 is required by IntelliJ's debugger.

It should look like this:

<init-param>
  <param-name>suppressSmap</param-name>
  <param-value>false</param-value>
</init-param>

From https://tomcat.apache.org/tomcat-7.0-doc/jasper-howto.html

> suppressSmap - Should the generation of SMAP info for JSR45 debugging be suppressed? true or false, default false.

Solution 5 - Debugging

If you are using the Intellij debugger you can get the value of an individual attribute by putting a breakpoint inside JSP and evaluating the expression this.jspContext.request.getAttribute("attributeName").

Note that this may return a Java Object type, and you may have to cast it to the correct type. Also if you launch a remote Tomcat the IDEA won't hit any breakpoints, so you need to launch the Tomcat in debug mode from inside the IDEA.

Solution 6 - Debugging

For the second part of your question ("jsp files placed under web-inf won't be directly accessible by user") that is correct. To allow users to access JSP files in the WEB-INF folder servlet and servlet-mapping entries need to be made in the web.xml file for each JSP page.

Content Type	Original Author	Original Content on Stackoverflow
Question	yuantan	View Question on Stackoverflow
Solution 1 - Debugging	Pietro Polsinelli	View Answer on Stackoverflow
Solution 2 - Debugging	ccpizza	View Answer on Stackoverflow
Solution 3 - Debugging	Cong De Peng	View Answer on Stackoverflow
Solution 4 - Debugging	Romeo Frenksen	View Answer on Stackoverflow
Solution 5 - Debugging	naXa stands with Ukraine	View Answer on Stackoverflow
Solution 6 - Debugging	John Meagher	View Answer on Stackoverflow