THIS IS A TEST INSTANCE. ALL YOUR CHANGES WILL BE LOST!!!!
FreeMarker is a template Java-based template language engine that is a great alternative to JSP. FreeMarker is ideal for situations where your action results can possibly be loaded from outside a Servlet container. For example, if you wished to support plugins in your application, you might wish to use FreeMarker so that the plugins could provide the entire action class and view in a single jar that is loaded from the classloader.
For more information on FreeMarker itself, please visit the FreeMarker website.
...
...
The framework utilizes FreeMarker because the engine includes strong error reporting, built-in internationalization and powerful macro libraries.
Support is also included for Velocity templates. For a comparison of Velocity vs FreeMarker see here.
Getting Started
Getting started with FreeMarker is as simple as ensuring all the dependencies are included in your project's classpath. This typically requires simply Typically, the only dependency is freemarker.jar. Other than that, action struts-default.xml already configures the FreeMarker Result needed to map your actions to your templates. You may now try out the following xwork.xml configuration:
...
process your application's templates.
...
Then in test-success.ftl:
...
Where name is a property on your action. That's it! Read the rest of this document for details on how templates are loaded, variables are resolved, and tags can be used.
...
The following are ways to obtained Application scope attributes, Session scope attributes, Request scope attributes, Request parameters, and SAF framework Context scope parameters:-
...
Assuming there's an attribute with name 'myApplicationAttribute' in the Application scope.
...
...
or
...
Session Scope Attribute
Assuming there's an attribute with name 'mySessionAttribute' in the Session scope.
...
or
...
Request Scope Attribute
Assuming there's an attribute with name 'myRequestAttribute' in the Request scope.
...
or
...
Request Parameter
Assuming there's a request parameter myParameter (eg. http://host/myApp/myAction.action?myParameter=one).
...
or
...
Context parameter
Assuming there's a parameter with the name myContextParam in SAF framework context.
...
...
or
...
Template Loading
WebWork The framework looks for FreeMarker templates in two locations (in this order):
...
This ordering makes it ideal for providing templates inside a fully-built jar, but allowing for overrides of those templates to be defined in your web application. In fact, this is how you can override the default UI tags and Form Tags included with WebWorkthe framework.
In addition, you can specify a location (directory on your file system) through the 'templatePath' or 'TemplatePath' context variable (in your the web.xml). If a variable is specified, the content of the directory it points to will be searched first.
...
...
This variable is currently NOT relative to the root of your
...
application.
Variable Resolution
In When using FreeMarker with the framework, variables are looked up in several different places, in this order:
- Built-in variables
- Value The value stack
- The action Action context
- Request scope
- Session scope
- Application scope
- Built-in variables
Note that the action context is looked up after the value stack. This means that you can reference the variable without the typical preceding has marker (#) like you would have to when using the JSP ww s:property tag. This is a nice convenience, though be careful because there is a small chance it could trip you up.
...
The built-in variables that WebWorkStruts-FreeMarker integration provides are:
Name | Description |
|---|---|
stack | The value stack itself, useful for calls like ${stack.findString('ognl expr')} |
action | The action most recently executed |
response | The HttpServletResponse |
res | Same as response |
request | The HttpServletRequest |
req | Same as request |
session | The HttpSession |
application | The ServletContext |
base | The request's context path |
Tag Support
FreeMarker is a great template language because it has includes complete tag support. See the FreeMarker Tags documentation for information on how to use the generic Struts Tags provided by WebWorkStruts. In addition to this, you can use any JSP tag, like so:
...
...
Where mytag.tld is the JSP Tag Library Definition file for your tag library. Note: in order to use this support in FreeMarker, you must enable the JSPSupportServlet in web.xml documented as follows:-
...
...
Tips and Tricks
There are some advanced features that may be useful when building WebWork Struts applications with FreeMarker.
...
FreeMarker has built in support for formatting dates and numbers. The formatting rules are based on the locale associated with the action request, which is by default set in action struts.properties but can be over-ridden using the I18n Interceptor. This is normally perfect for your needs, but it is important to remember that these formatting rules are handled by FreeMarker and not by WebWorkthe framework's Type Conversion support.
If you want WebWork the framework to handle the formatting according to the Type Conversion you have specified, you shouldn't use the normal ${...} syntax. Instead, you should use the property tag. The difference is that the property tag is specifically designed to take an OGNL expression, evaluate it, and then convert it to a String using any Type Conversion rules you have specified. The normal ${...} syntax will use a FreeMarker expression language, evaluate it, and then convert it to a String using the built in formatting rules.
The difference in how type conversion is handled under Freemarker is This difference is subtle but important to understand.
Extending
Sometimes you may with to extend the framework's FreeMarker support provided with WebWork. The most common reason for doing this is that you wish to include your own Tags, such as those that you have extended from the built in WebWork Tags.. For example, you might want to extend the Struts tags that come bundled with the framework.
To extend the Freemarker support, develop a class that extends org.apache.struts2To do so, write a new class that extends com.opensymphony.webwork.views.freemarker.FreemarkerManager and overrides it as needed. Then add the following to action, overriding methods as needed, and plugin the class through the struts.properties:
...
ObjectWrapper Settings
Once you get familiar with FreeMarker, you will find certain subtletieswith it that may become frustrating. The most common thing you'll likely run in to is the BeansWrapper provided by FreeMarker. If you don't know what this is, don't worry. However, if you do, know this:
...
INLINE
...
Syntax Notes
As of FreeMarker 2.3.4, an alternative syntax is supported. This alternative syntax is great if you find that your IDE (especially IntelliJ IDEA) makes it difficult to work with the default syntax. You can read more about this syntax here.
Cache
You can enable FreeMarker cache mechanism by specifying below options in struts.xml:
<constant name="struts.freemarker.mru.max.strong.size" value="250" />- this option will be used by freemarker.cache.MruCacheStorage
<constant name="struts.freemarker.templatesCache.updateDelay" value="1800" />- default update cache interval (5 seconds)
<constant name="struts.freemarker.templatesCache" value="true" />- *DEPRECATED* this option will use a internal ConcurrentHashMap in FreemarkerTemplateEngine but not freemarker native cache
Setting devMode to true will disable cache and updateDelay immediately, but you can explicit specify these constants to enable cache even in devMode, see devMode
Incompatible Improvements
By default Struts is using FreeMarker in way to be backward compatible as much as possible but if you need to enable new features you can do it via freemarker.properties by defining incompatible improvements settings, ie.:
...
You can also pass this setting via ServletContext <init-param/> (since Struts 2.5.13):
...
This can impact your freemarker powered pages and Struts tags as well, so please careful test this change.