Info |
---|
...
...
Getting started
0 or later is required to build Struts 2 |
First, let's review some Maven basics. Maven uses the notion of a build life-cycle to which plugins can attach. Plugins are similar to Ant tasks. When a Maven build is invoked, we specify a point in the life-cycle up to which the build should proceed. The compile phase Before we get too far ahead, it is important to know some basics concepts of Maven. The most important thing to understand is that unlike Ant, Maven has no concept of procedural tasks that get run. Instead, Maven has a concept of a build lifecycle in which plugins (somewhat similar to Ant asks) can attach to. When you execute a maven build, you specify a point in the lifecycle that you want the project built up to. The phase compile comes before test, and test comes before package, and package comes before install.
Installing
Once we have Maven setup, we can invoke the Struts build, and specify which phase the build should use.
Installing
The install phase simply means that maven should build builds up the project ("package"), and then install it to installs any JARs it needs into your local repository (found in e.g. ~/.m2/repository
). There is Once installed, the JARs can be used by any other maven Maven project you build. The install phase is the default phase if none is specified.
To run a basic install, simply invoke:change to the root of the source distribution, and enter
Code Block | ||
---|---|---|
| ||
> mvn install
|
That's it! Maven will download all any dependencies it the build needs, ; run all unit tests, ; package up the jars, and JARs; then install the jars new JARs locally. You can also find the jars For your convenience, copies of the JARs can be found in the target directories of each module. For example, action, after the build, the main JAR can found at core/target/
actionstruts2-core-2.0-SNAPSHOT.jar
would be where the main jar is built.
Warning | ||
---|---|---|
| ||
Sometimes, licensing restrictions prevent Maven from downloading all the JARs that a build might need. For example, Some dependencies, such as JavaMail and Activation, can 't only be downloaded automatically due to license restrictions. Fortunately, Maven gives you a nice error message showing you from Sun. When this happens, Maven will display a helpful message that explains how to install these to your local repository. Simply download the required jar from Sun's website and then use the command supplied by the error message to install it. You can then try the build again. |
If all goes well, you should see something like:
JARs manually. After downloading the required JAR, follow the instructions to install it to the your local repository. Once installed, the JAR is available to all your Maven builds, not just Struts. |
Code Block | ||
---|---|---|
| ||
[INFO] Reactor Summary:
[INFO]
[INFO] Struts 2 .......................................... SUCCESS [6.016s]
[INFO] XWork: Core .................... | ||
Code Block | ||
[INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary: [INFO] ------------------------------------------------------------------------ [INFO] Struts Action Framework 2.0 Project ................... SUCCESS [01:08.688s086s] [INFO] Struts Action2 Framework 2.0 API Core ..................................... SUCCESS [2:42.125s604s] [INFO] Struts Action Framework 2.0 Plugins .................................... SUCCESS [210.866s944s] [INFO] Webapps Struts 2 Spring Plugin .............................. SUCCESS [13.523s] [INFO] Struts 2 Convention Plugin ........................ SUCCESS [016.002s473s] [INFO] Struts 2 BlankJUnit WebappPlugin .......................................... SUCCESS [013.982s325s] [INFO] PortetWebapps Webapp ........................................... SUCCESS [21.038s027s] [INFO] ShoppingBlank Cart Webapp ...................................... SUCCESS [09.934s572s] [INFO] JBoss ShowcaseBlank Webapp ....................................... SUCCESS [37.351s814s] [INFO] StarterMail Reader Webapp ........................................ SUCCESS [17.013s028s] [INFO] ------------------------------------------------------------------------ [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 33 seconds [INFO] Finished at: Wed May 03 18:23:38 PDT 2006 [INFO] Final Memory: 11M/43M [INFO] ------------------------------------------------------------------------ |
Other phases
There are other phases that can be useful when working with Maven. The package phase will just jar (or war) up the modules. The test phase will only run the unit tests. The compile phase will only build the source code (but not the test sources). And the clean phase will remove all artifacts, typically the entire target directory.
Build profiles
The next step to building Struts with Maven is to understand build profiles. These are simply slightly different configurations for the build. The following profiles are available:
Profile | Description |
---|---|
default | Builds action-api, action, and all sample webapps |
xwork | Includes the xwork build |
thirdparty | Includes additional modules that cannot be part of the default build due to Apache rules |
In the previous example, we didn't specify a profile so the default profile was used. However, most developers will want to use additional profiles as they work on both XWork and other modules, such as the JasperReports integration.
Specify a profile is as simple as:
Code Block |
---|
> mvn -Pprofile ...
|
Third party profile
That is, if you wanted to build all the third-party add-ons not included with the default build, you'd simply use the thirdparty profile:
Code Block |
---|
> mvn -Pthirdparty package
|
Notice that the final output is now:
Code Block |
---|
[INFO] ------------------------------------------------------------------------ [INFO] Reactor Summary: [INFO] ------------------------------------------------------------------------ [INFO] Struts Action Framework 2.0 Project Struts 2 Portlet Plugin ........................... SUCCESS [20.995s] [INFO] Struts 2 DWR Plugin ............................... SUCCESS [4.432s] [INFO] Struts 2 Tiles Plugin ............................. SUCCESS [4.451s] [INFO] Struts 2 Portlet Tiles Plugin ..................... SUCCESS [3.741s] [INFO] Portlet Webapp .................................... SUCCESS [28.480s] [INFO] Struts 2 Struts 1 Plugin .......................... SUCCESS [8.353s] [INFO] Struts 2 Dojo Plugin .............................. SUCCESS [30.181s] [INFO] Struts 2 JSF Plugin ............................... SUCCESS [6.000s] [INFO] Struts 2 Configuration Browser Plugin ............. SUCCESS [7.531s] [INFO] Struts 2 Sitemesh Plugin .......................... SUCCESS [6.159s] [INFO] Struts 2 JSON Plugin .............................. SUCCESS [16.944s] [INFO] Showcase Webapp ................................... SUCCESS [20.303s] [INFO] Struts 2 REST Plugin .............................. SUCCESS [010.646s015s] [INFO] Struts Action2 FrameworkRest 2.0Showcase APIExample ....................... SUCCESS [26.389s928s] [INFO] Struts Action2 FrameworkCodebehind 2.0Plugin ........................... SUCCESS [2210.155s394s] [INFO] Webapps Struts 2 Java Templates Plugin .................... SUCCESS [9.633s] [INFO] Struts 2 Jasper Reports Plugin .......................... SUCCESS [0.002s SUCCESS [5.920s] [INFO] Struts 2 BlankJFreeChart WebappPlugin ........................ SUCCESS [18.296s] [INFO] Struts 2 Pell Multipart Plugin .................... SUCCESS [03.906s891s] [INFO] Portet WebappStruts 2 Plexus Plugin ......................................... SUCCESS [1.661s] SUCCESS [4.715s] [INFO] ShoppingStruts 2 CartSitegraph WebappPlugin .................................. SUCCESS [08.779s009s] [INFO] ThirdStruts 2 PartyTestNG ModulesPlugin ................................... SUCCESS [06.003s012s] [INFO] JasperReports Struts 2 OVal Plugin ......................................... SUCCESS [09.918s629s] [INFO] Struts Showcase2 OSGi WebappPlugin ....................................... SUCCESS [28.336s118s] [INFO] Starter WebappStruts 2 Embedded JSP Plugin ...................... SUCCESS [30.524s] [INFO] Struts 2 GXP Plugin ............................... SUCCESS [04.571s878s] [INFO] JFree ChartStruts 2 CDI Plugin ........................................... SUCCESS [17.972s620s] [INFO] Pell File Upload ...........Struts 2 Tiles 3 Plugin ........................... SUCCESS [05.385s132s] [INFO] ------------------------------------------------------------------------ [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 35 seconds [INFO] Finished at: Wed May 03 18:26:19 PDT 2006 [INFO] Final Memory: 14M/52M [INFO] ------------------------------------------------------------------------ |
As you can see, the additional modules that aren't part of the default build were not included.
XWork profile
Besides the third party profile, another useful profile is the xwork profile. This one assumes that the latest XWork CVS code is checked out and is located at ../xwork, relative to the Struts project. You can check out XWork using these commands:
Code Block |
---|
cvs -d :pserver:guest@cvs.dev.java.net:/cvs login
cvs -d :pserver:guest@cvs.dev.java.net:/cvs co xwork
|
Note |
---|
The guest user has a blank password at java.net. If you have your own java.net account, you can use that. |
Now you can do:
Code Block |
---|
> mvn -Pxwork package
|
And you'll see that XWork is included:
Code Block |
---|
Struts OSGi Bundles ............................... SUCCESS [0.254s] [INFO] Struts 2 OSGi Admin Bundle ........................ SUCCESS [5.204s] [INFO] Struts 2 OSGi Demo Bundle ......................... SUCCESS [4.582s] [INFO] Struts 2 Maven Archetypes ......................... SUCCESS [0.198s] [INFO] Struts 2 Archetypes - Angular JS .................. SUCCESS [10.509s] [INFO] Struts 2 Archetypes - Blank ....................... SUCCESS [1.440s] [INFO] Struts 2 Archetypes - Blank Convention ............ SUCCESS [1.324s] [INFO] Struts 2 Archetypes - Database Portlet ............ SUCCESS [0.990s] [INFO] Struts 2 Archetypes - Plugin ...................... SUCCESS [0.923s] [INFO] Struts 2 Archetypes - Portlet ..................... SUCCESS [0.888s] [INFO] Struts 2 Archetypes - Starter ..................... SUCCESS [1.992s] [INFO] Struts 2 Assembly ................................. SUCCESS [1:37.556s] [INFO] ------------------------------------------------------------------------ [INFO] ReactorBUILD Summary:SUCCESS [INFO] ------------------------------------------------------------------------ [INFO] Struts Action Framework 2.0 Project ................... SUCCESS [0.774s]Total time: 12:23.728s [INFO] Finished at: Wed Oct 30 17:26:27 CET 2013 [INFO] StrutsFinal Action Framework 2.0 API ....................... SUCCESS [1.969s] [INFO] XWork ................................................. SUCCESS [8.757s] [INFO] Struts Action Framework 2.0 ........................... SUCCESS [24.947s] [INFO] Webapps ............................................... SUCCESS [0.002s] [INFO] Blank Webapp .......................................... SUCCESS [1.068s] [INFO] Portet Webapp ......................................... SUCCESS [1.391s] [INFO] Shopping Cart Webapp .................................. SUCCESS [0.745s] [INFO] Showcase Webapp ....................................... SUCCESS [3.064s] [INFO] Starter Webapp ........................................ SUCCESS [0.625s] [INFO] ------------------------------------------------------------------------ [INFO] ------------------------------------------------------------------------ [INFO] BUILD SUCCESSFUL [INFO] ------------------------------------------------------------------------ [INFO] Total time: 44 seconds [INFO] Finished at: Wed May 03 18:31:49 PDT 2006 [INFO] Final Memory: 14M/46M [INFO] ------------------------------------------------------------------------ |
Notice that the build runs XWork before building the main Struts project. That is because instead of using the XWork snapshot release that is already pre-compiled, Maven is now understanding that it should build XWork and use the resulting artifact (jar) from that build to supply to Struts.
Multiple profiles
You can use multiple profiles at once. For example, this is possible and highly recommend for anyone spending a lot of time developing on Struts and XWork:
Code Block |
---|
> mvn -Pthirdparty,xwork package
|
This is especially important if you wish to use Maven to build your IDE project files, which is highly recommended.
Building IDE project files
Tips
...
Memory: 57M/945M
[INFO] ------------------------------------------------------------------------
|
Other phases
There are other phases that can be useful when working with Maven. The package phase will just JAR (or WAR) the modules. The test phase will only execute unit-tests. The compile phase will only build the source-code (but not the test sources). And the clean phase will remove all artifacts, typically the entire target directory.
Building IDE project files
Maven has a great feature that will allow you to build up your IDEA or Eclipse project files based on the project build structure. Using the Maven project files helps keep developers in-sync and efficient. The IDEA project files are pre-configured to define in the Run/Debug menu many common tasks, such as "execute all tests", "launch the showcase sample app", and so fort.
IDEA by JetBrains
The Maven IDEA plugin creates IDEA project and modules files, based on the Maven build configuraton (pom.xml).
First, be sure you have the latest IDEA plugin for Maven.
Code Block | ||
---|---|---|
| ||
mvn -DconnectionUrl=scm:svn:http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-idea-plugin \
-Dgoals=install \
scm:bootstrap
|
Most often, we use Maven to build projects, but it can also run plugins directly. To build an IDEA project file for Struts 2, including all the modules, run
Code Block | ||
---|---|---|
| ||
> mvn idea:idea -Papps,extras,thirdparty,xwork
|
Maven will generate struts-parent.ipr, struts-parent.iws, and an iml file for each module listed Open up struts-parent.ipr in IDEA, and you should be good to go.
If you ever need to rebuild your projects, running the idea:idea
command again will update your files without overriding any information that doesn't conflict. If you do want to overwrite the project files, specify the overwrite parameter as true.
Code Block | ||
---|---|---|
| ||
> mvn idea:idea -Doverwrite=true -Papps,extras,thirdparty,plugins,xwork
If you only need to rebuild some of the modules, adjust the list of "profiles".
|
Tip | ||
---|---|---|
| ||
If you find the xwork module causing you problems, such as displaying as "XWork" when it should be named "xwork", the problem is likely to be within IDEA. Try clearing out your IDEA system cache and then run it again |
Eclipse
For Eclipse, try
Code Block | ||
---|---|---|
| ||
> mvn -Pthirdparty,plugins,xwork eclipse:eclipse
|
Info | ||
---|---|---|
| ||
Many Struts 2 developers use IDEA, and the Eclipse project files are not as well-tested or featureful as the IDEA versions. But as far as we know, they work! |
IMPORTANT: Running the Sample Applications from Eclipse or non-IDEA IDEs
Currently the sample applications can be deployed using the Maven 2 Jetty plugin. For example, you can run the showcase example application from the command line:
Code Block | ||
---|---|---|
| ||
cd apps/showcase
mvn jetty:run
|
You could also use one of the Maven IDE plugins to run the plugin or simply execute the mvn
or mvn.bat
file as an external application within your IDE.
A good tutorial on how to use the Maven 2 jetty plugin along with your IDE, including JPDA debugging support, can be found at the Apache Wicket documentation.
Maven Tips
A few helpful tips for using Maven are provided:
Skip exporting pages from Confluence
The whole Struts2 documentation resists on Confluence and during normal build process is exported with SiteExporter tool locally to html files. To perform that, you must have an account on Confluence. In most cases you don't need to export the whole Confluence, so you can skip this, just type command:
Code Block |
---|
mvn clean install -DskipWiki
|
Skip creating assemblies
During normal development cycle you don't need to create assembly packages which consist of all the libraries, example apps and docs - you can skip them as well:
Code Block |
---|
mvn clean install -DskipAssembly
|
Offline mode
If you are disconnected from the Internet or simply wish to make your build faster, pass in the -o argument and Maven won't check for new modules to download.
Code Block | ||
---|---|---|
| ||
mvn -o
|
OutOfMemoryError
If you get an OutOfMemoryError while running the tests:
Code Block | ||
---|---|---|
| ||
// Bash
export MAVEN_OPTS=-Xmx512m
// Windows
set MAVEN_OPTS=-Xmx512m
|
Skipping test execution
Although this shouldn't ever happen, sometimes tests do fail and you need to build the framework anyway. If there's a problem, you can pass in the skip tests parameter.
Code Block | ||
---|---|---|
| ||
mvn -Dmaven.test.skip=true
|
Of course, if you find tests are failing, please submit a patch to fix them!
Debugging build failures
Struts 2 depends on the current snapshot artifact of XWork 2. Unfortunately, if XWork 2 is modified in a significant way, the Struts build doesn't check for and retrieve a new version of the XWork snapshot jar, resulting in compilation or unit test failures.
The solution is to clear out any stale XWork 2 jars in your local Maven repository, usually by removing the directory ~/.m2/repository/opensymphony
. This will force the Struts Maven build to pull down a fresh copy of XWork and hopefully resolve your problem.
Mirrors
The default mirror for Maven builds ("ibiblio") can be slow and unreliable. Maven lets you specify alternative mirrors so that you don't have to depend on ibiblio for everything.
You can add new mirrors through the Settings file (~/.m2/settings.xml).
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
<settings>
<mirrors>
<mirror>
<id>dotsrc</id>
<url>http://mirrors.dotsrc.org/maven2</url>
<mirrorOf>central</mirrorOf>
</mirror>
</mirrors>
</settings>
|
Tip |
---|
Sometimes the alternative mirrors have problems too or aren't updated at the same frequency as the main mirror. If you have trouble building, try commenting out the aternative mirror. |
First time building
In some cases it has been seen that Maven will complain if a module doesn't exist, even though it is part of the current build. Often, the missing module turns up when executing mvn package
. A simple fix for this is to run mvn install
instead. If you have to do this, it will probably only be a one time thing.
Next: Creating and Signing a Distribution
...