Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

dust.js for your Java web applications

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

dust4j

dust.js is the very nice and ultra-fast JavaScript templating library now chosen and adopted by LinkedIn from over 20 others.

dust4j provides extensible, zero-dependency and non-intrusive automatic on-the-fly compilation of Servlet/JSP output to dust.js templates for any Java Web Application that adheres Java Servlet specification.

Features

  • small and independent
  • integrates with Spring's DelegatingFilterProxy
  • extensible
  • integrated internal cache and ETag support
  • configurable

Requirements

none, except plain Java SDK 6+, Servlet API and human

How to use?

NOTE Right now dust4j is half-way to Maven Central. Until then, you should manually install it into your local repository.

Add dust4j as dependency to your Maven project

    <dependency>
        <groupId>me.noroutine</groupId>
        <artifactId>dust4j</artifactId>
        <version>0.1</version>
    </dependency>

Add DustCompilingFilter to your web.xml

    <filter>
        <filter-name>dustCompilingFilter</filter-name>
        <filter-class>me.noroutine.dust4j.DustCompilingFilter</filter-class>
    </filter>

    <filter-mapping>
        <filter-name>dustCompilingFilter</filter-name>
        <url-pattern>/*</url-pattern>
    </filter-mapping>

Setup your framework to return templates when URL ending with .dust.js are requested. Say, in Spring MVC 3.0, with Tiles, it'd be something like this:

  • Controller code:

    @Controller
    @RequestMapping("/")
    public class HomeController {
    
        // first mapping is main, the second is useful for debugging, designing or client-side compilation
        // only URLs ending with .dust.js will trigger the compilation
        @RequestMapping({"/template/{template}.dust.js", "/template/{template}.dust"})
        public String getAddTemplate(@PathVariable String template) {
            return "template." + template;
        }
    
    }
    
  • definition in tiles-defs.xml:

    ...
    <definition name="template.*" template="/WEB-INF/jsp/templates/{1}.jsp" />
    ...
    

Now, if you gonna ask your container for URL like http://localhost:8080/fancyapp/template/dustjs_demo.dust.js it will hit the JSP of your dust.js template, that template will be evaluated by JSP engine, will be automatically compiled by filter and client will get already compiled template

Compiled templates register themselves with client-side dust.js library under unique name. This name is generated automatically from request URL relative to application context, stripping down .dust.js suffix. For example for http://localhost:8080/fancyapp/template/dustjs_demo.dust.js template name will be 'template/dustjs_demo'. You can however change this to your needs.

On your web page, you need to include dust.js libraries

<script type="text/javascript" src="/fancyapp/resources/js/vendor/dust-core-1.1.1.js"></script>
<script type="text/javascript" src="/fancyapp/resources/js/vendor/dust-helpers-1.1.0.js"></script>

and your template

<script type="text/javascript" src="/fancyapp/template/dustjs_demo.dust.js?version=6b3a3c4a3&cache=true"></script>

Noticed the version and cache parameters? This is for caching and ETag. Read on

Now, you're ready to use the template, which is registered with name template/dustjs_demo

Filter configuration options

init-param name Type Default Description
cache boolean true Enable/disable internal cache
eTag boolean false Enable/disable ETag support
compilerFactory string me.noroutine.dust4j.DefaultDustCompilerFactory Canonical name of factory for obtaining DustCompiler instance. Should implement DustCompilerFactory interface
templateNameRegex regular expression /(.*).dust.js$ Regex to apply to relative part of requests to generate template names. Should contain one and only matching group that will be used to infer template name

Using with Spring (and possibly other DI frameworks)

Filter has a set of setters to use it as a component in DI framework like Spring. Spring provides a proxy servlet filter that can delegate filter processing to Spring-managed bean.

To configure this, define your filter in web.xml like this:

<filter>
    <filter-name>dustCompilingFilter</filter-name>
    <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class>
</filter>

<filter-mapping>
    <filter-name>dustCompilingFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

And define a bean with id dustCompilingFilter in your applicationContext.xml (NOT dispatcher servlet context)

<bean name="dustCompilingFilter" class="me.noroutine.dust4j.DustCompilingFilter">
   <property name="compilerFactory">
       <bean class="me.noroutine.dust4j.DefaultDustCompilerFactory" />
   </property>
   <property name="cacheEnabled" value="true" />
   <property name="ETagEnabled" value="true" />
</bean>

Overriding cache

Filter has cache enabled by default, as compilation takes significant time and slows downs container to commit the response. You can disable it, but this is not generally recommended. If you have cache enabled and want to go through the cache to the compiler for debugging or whatever reasons, just add cache=false to your template URL.

Important thing to understand is that caching of dynamic templates may not make sense and often will produce undesired results. For example if you will interleave your template with Spring Security tags to show/hide certain parts of it, caching will be in your way. In such case you have three options:

  • implement your logic not in JSP but with dust syntax, which basically making it less tied to JSP
  • disable cache with adding cache=false to script src attribute on your page
  • create several templates (aka views)

Choose whatever best suits your particular use case

ETag support

Filter has built-in support for ETag for controlling client-side caching. To enable it set init-param eTag to true.

To use it, you need to add version parameter to URL with ETag string you want to check. This string will be checked agains the If-None-Match header, if any, and in case of mismatch, the template will be recompiled. Maintaining consistency of version parameter values is project-specific and is out of scope of this library.

Writing your own compiler

For your convenience, filter supports plugging in custom compilers, though only one exists in all observable Universe atm ;). If you need major customizations like your own cache or own compiler, you have two interfaces, which will allow you to plug into this filter. Compiler should implement DustCompiler interface and is obtained via DustCompilerFactory's createDustCompiler() method. Your custom factory will need also to have default constructor.

Please, also consider contributing your work to this project.

Thanks

Thanks go to Aleksander Williams for creating such a nice templating rocket. Also special thanks to LinkedIn for taking care of it

Also thanks in advance to you for the code, feedback, bug reports, suggestions or just a star on GitHub :)

Links

Something went wrong with that request. Please try again.