Thursday, December 07, 2006

Run/Debug java webapp without packaging/deploying it with Jetty and under Maven2

Goals

As the title mentioned, run(with maven2 command or in IDE)/debug(in IDE) java webapp without packaging the war file, installing/configuring any appserver like tomcat or deploying your code to anywhere. The practice will be "compile and run".

Why Jetty?

Jetty is a lightweight, flexible and embeddable Java servlet container. It's so flexible that it can even start servicing a webapp directly from given classpath and a web.xml file without assembling them into a standard webapp.

Step by step

Introduce several dependencies into you pom file. This is required whatsoever if you want to run/debug jetty in IDE and make sure the servlet-api, xercesImpl and java tools.jar(if you want to run JSP) are in dependency list.

<dependency>
<groupId>jetty</groupId>
<artifactId>org.mortbay.jetty</artifactId>
<version>5.1.10</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>jetty</groupId>
<artifactId>jasper-runtime</artifactId>
<version>4.2.20RC0</version>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>jetty</groupId>
<artifactId>jasper-compiler</artifactId>
<version>4.2.20RC0</version>
<scope>runtime</scope>
</dependency>
Create jetty config file PROJECT_BASE_DIR/src/test/config/jetty.xml, assuming the web.xml file is already under src/main/webapp/WEB-INF directory. Feel free to change the directory and port if you want.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN"
"http://jetty.mortbay.org/configure.dtd">
<Configure class="org.mortbay.jetty.Server">
<Call name="addListener">
<Arg>
<New class="org.mortbay.http.SocketListener">
<Set name="port">
<SystemProperty name="jetty.port" default="8081" />
</Set>
</New>
</Arg>
</Call>
<Call name="addWebApplication">
<Arg>/</Arg>
<Arg>./src/main/webapp</Arg>
</Call>
</Configure>
Now, after injecting add dependencies into you IDE(For eclipse, run mvn eclipse:eclipse [-DdownloadSources=true] or use m2eclipse eclipse plugin), you should be able to run/debug the webapp after the code compiles. A java application with org.mortbay.jetty.Server as main class and src/test/config/jetty.xml as argument will start the webapp on port 8081.

Jetty6.x required less jar file dependencies, particularly only one jetty jar file if you don't want to run JSP, and syntax of jetty.xml file will be different. Please look at http://www.mortbay.org for more details.
Post a Comment