Every Flavour Beans

At last we have a Java IDE that ships with Struts 2 support built-in: no manual configuring the web applications to add Struts 2 support and no more hassles of finding and installing Struts 2 plugins.

JetBrains released IntelliJ IDEA 8 Milestone release 1 a week ago and the milestone version includes support for Struts 2 out-of-the-box(no plugins need to be installed) so that we can test the functionality right away. Any loose ends should be tied up by the time the final version is released.

Installing IntelliJ IDEA 8 M1 and Other Required Components

1. Download and install the latest version of Sun JDK: Sun Java SE 6.
2. Download and install Apache Tomcat web application server: Apache Tomcat 5.5.
3. Download and install the 30-day trial version of the latest IntelliJ IDEA 8 version; currently Milestone 1 is available, but when you read this, probably another milestone, or beta, or even the final version may have been released, so make sure that you download the most recent release of IntelliJ IDEA 8. I show the screenshots from Windows Vista operating system in this post but it should work similarly for Mac and GNU/Linux too.

   

Creating a New Struts 2 Web Application Project in IntelliJ IDEA 8 M1

4. Run IntelliJ IDEA 8 M1 IDE and create a new project by going to File -> New Project... and following the wizard: Enter a name for the application(say "HelloWorld") when prompted and make sure you select Web Application and Struts 2 checkboxes on the technologies page.

   

You can accept the default settings for everything else in the wizard. Click Finish.

5. When you click Finish, IntelliJ IDEA will start downloading the required Struts 2 JAR library files to your project's lib directory, which may take a few minutes. IntelliJ IDEA may then parse all the files in the project to be able to help you later when you start editing/browsing the files.

   

   [The annoying thing is that IntelliJ downloads these Struts 2 library files for every Struts 2 application you create. Currently there is no option to reuse the previously downloaded library files. Hope they add it in the final version.]

   You should finally see the project structure created as shown below(expand the directories as needed).

   

   As you can see, the required Struts 2 libraries are automatically downloaded and installed in the lib directory(and included in the build path) by the IDE.

6. You can also see that the IntelliJ IDEA IDE has created and placed the struts.xml configuration file(containing basic template text) in the src directory. The generated web.xml file includes the following configuration elements needed by the Struts 2 framework so that you don't have to type or copy/paste it manually in every Struts 2 web application:
   Show Plain Text
   XML:

   1. <filter>
   2.         <filter-name>struts2</filter-name>
   3.         <filter-class>org.apache.struts2.dispatcher.FilterDispatcher</filter-class>
   4.     </filter>
   5.     <filter-mapping>
   6.         <filter-name>struts2</filter-name>
   7.         <url-pattern>/*</url-pattern>
   8.     </filter-mapping>

   You can add additional configuration elements to the file.

The basic structure needed for a Struts 2 web application project is now in place and we only ran the New Project wizard in Intellij IDEA so far! This is far cry from the experience with NetBeans or Eclipse IDEs even with the help of the plugins: see my previous posts “Hello, World” Web Application using Struts 2 in NetBeans IDE 6.1 and Struts 2 Plugin for NetBeans IDE - nbstruts2support for example. All we need to do now is to write our own application logic.

Let us create an example action class in Java and a JSP result page to go with it.

Create Struts 2 action Java class and JSP result page and configure struts.xml file

7. Right-click on the src folder, select New -> Class and enter hello.HelloWorld in the New Class dialog box.

   

   Edit the file so that it contains the following code.

   Show Plain Text
   JAVA:

   1. package hello;
   2.  
   3. public class HelloWorld {
   4.     private String userName;
   5.     public String getUserName() {
   6.         return userName;
   7.     }
   8.     public void setUserName(String userName) {
   9.         this.userName = userName;
   10.     }
   11.  
   12.     private String message;
   13.     public String getMessage() {
   14.         return message;
   15.     }
   16.  
   17.     public String execute() {
   18.         message = "Hello, " + userName + ".";
   19.         return "SUCCESS";
   20.     }
   21. }

8. Let us access the message property set by HelloWorld action and display it in the index.jsp page. Edit index.jsp so that it looks like this:
   Show Plain Text
   HTML:

   1. <%@ page contentType="text/html;charset=UTF-8" language="java" %>
   2. <%@ taglib prefix="s" uri="/struts-tags" %>
   3.  
   4. <html>
   5.   <head><title>Simple jsp page</title></head>
   6.   <body>
   7.         Struts 2 Message: <s:property value="message" default="Guest." />
   8.  
   9.         <s:form method="GET" action="hello/HelloWorld.action">
   10.             Enter your name:<s:textfield name="userName" />
   11.             <s:submit value="Submit" />
   12.         </s:form>
   13.   </body>
   14. </html>

9. We now need to configure the Java class(HelloWorld.java) as a Struts 2 Action and map it to the Struts 2 Result page(index.jsp) created in the above steps. Edit struts.xml file such that it has the following content:
   Show Plain Text
   XML:

   1. <!DOCTYPE struts PUBLIC
   2.     "-//Apache Software Foundation//DTD Struts Configuration 2.0//EN"
   3.     "http://struts.apache.org/dtds/struts-2.0.dtd">
   4.  
   5. <struts>
   6.     <package name="hw" extends="struts-default">
   7.         <action name="HelloWorld" class="hello.HelloWorld">
   8.             <result name="SUCCESS">/index.jsp</result>           
   9.         </action>
   10.     </package>
   11. </struts>

   (Ignore the error shown by IntelliJ IDEA in struts.xml file if it says it is not able to resolve struts-default package.)

   This maps the requests sent to the "/HelloWorld.action" url to HelloWorld.java Struts 2 action class, and after the successful execution of the request, it directs to the index.jsp result page.

10. The HelloWorld web application project structure, when relevant folders are expanded, should now look like this:

    

    (Did you notice how struts.xml was automatically moved to our hello package? Nice, huh?)

Create Run/Debug Configuration in IntelliJ IDEA and Run the Struts 2 Project

10. Before we can run the application, we first need to create/edit the Run configuration for our project. Select the HelloWorld project in the left pane and go to Run -> Edit Configuration. If the left pane is empty, it means that we need to create a new configuration which is a one-time job; after creating it the first time, we can use the same configuration for all our future projects.

    Click the + button at the top of the window and select Tomcat -> Local (or other application server of your choice; I use Tomcat server as example in this post) from the pop-up menu.

    

    In Run/Debug Configurations window, click the Configure button and in the popped-up Application Servers window click the [+ Add] button and select the directory where Apache Tomcat is installed on your system in Tomcat home and Tomcat base directory fields.

    

    You should now see a warning displayed near the bottom of the window and the option to fix it.

    

    Click the Fix button on the far right corner and then click OK.

11. We are now ready to run the application. Select the HelloWorld project in the left pane and go to Run -> Run.... You should see the run configuration window which allows you to make any further configuration changes before the application is run. (If you don't want to see the configuration window every time you run the application, uncheck the "Display settings before launching" checkbox.)

    Click the Run button to run the application. You can see the result in the following screenshots:

    

    

    Happy developing with Struts 2 in IntelliJ IDEA 8!

Last Words

This is a big moment for the Struts 2 users. It's a shame that after such a long period since the release of Struts 2 web framework, its support in all the popular IDEs is next to zero. The version of the NetBeans IDE that will be released next, version 6.5, talks nothing about the support for Struts 2 framework(you can see support for Struts 1.2.9 proudly displayed on NetBeans 6.5 Beta release page); all hopes are now pinned up on the nbstruts2support netbeans plugin I guess. I hope that IntelliJ IDEA's out-of-the-box Struts 2 support will encourage the teams/communities of other popular IDEs to follow the suit.

Also see:

1. more details on Struts 2 support in IntelliJ IDEA 8.0.
2. the full list of features introduced in IntelliJ IDEA 8.0 Milestone 1 and what is planned for the final release.