Apache Tapestry

Tapestry emphasizes simplicity, ease of use, and developer productivity. It adheres to the Convention over Configuration paradigm, eliminating almost all XML configuration. Tapestry uses a modular approach to web development by having a strong binding between each user interface component (object) on the web page and its corresponding Java class. This component-based architecture borrows many ideas from WebObjects.

Notable features

Live Class Reloading: Tapestry monitors the file system for changes to Java page classes, component classes, service implementation classes, HTML templates and component property files, and it hot-swaps the changes into the running application without requiring a restart. This provides a very short code-save-view feedback cycle that is claimed to greatly improve developer productivity.
Component-based: Pages may be constructed with small nestable components, each having a template and a component class. Custom components are purportedly trivial to construct.
Convention over configuration: Tapestry uses naming conventions and annotations, rather than XML, to configure the application.
Spare use of HTTPSession: By making minimal use of the HTTPSession, Tapestry is designed to be highly efficient in a clustered, session-replicated environment.
Post/Redirect/Get: Most form submissions follow the Post/Redirect/Get (PRG) pattern, which reduces multiple form submission accidents and makes URLs friendlier and more bookmarkable, along with enabling the browser Back and Refresh buttons to operate normally.
Inversion of Control (IoC): Tapestry is built on a lightweight Inversion of Control layer with similarities to Google Guice, but designed to make nearly all aspects of Tapestry's behavior configurable and replaceable.

7 more chapters are free with a Lably account.

Hello World Example

A minimal, templated Tapestry application needs only three files:

HelloWorld.tml: The (X)HTML template for the /helloworld page. Tapestry templates can contain any well-formed (X)HTML markup.

<span id="mwSA"></span><span class="cp" id="mwSQ"><!DOCTYPE html></span> <span class="nt" id="mwSg"><html</span><span class="w" id="mwSw"> </span><span class="na" id="mwTA">xmlns=</span><span class="s" id="mwTQ">"http://www.w3.org/1999/xhtml"</span><span class="w" id="mwTg"> </span> <span class="w" id="mwTw"> </span><span class="na" id="mwUA">xmlns:t=</span><span class="s" id="mwUQ">"http://tapestry.apache.org/schema/tapestry_5_3.xsd"</span><span class="nt" id="mwUg">></span> <span class="nt" id="mwUw"><body></span> <span class="w" id="mwVA"> </span><span class="nt" id="mwVQ"><p></span>Hello,<span class="w" id="mwVg"> </span>${username}<span class="nt" id="mwVw"></p></span> <span class="nt" id="mwWA"></body></span> <span class="nt" id="mwWQ"></html></span>

HelloWorld.java: The page class associated with the template. Here, it merely provides a *username* property that the template can access.

<span id="mwXw"></span><span class="kn" id="mwYA">package</span><span class="w" id="mwYQ"> </span><span class="nn" id="mwYg">org.example.demo.pages</span><span class="p" id="mwYw">;</span> <span class="cm" id="mwZA">/** A page class (automatically associated with the template file of the same name) */</span> <span class="kd" id="mwZQ">public</span><span class="w" id="mwZg"> </span><span class="kd" id="mwZw">class</span> <span class="nc" id="mwaA">HelloWorld</span><span class="w" id="mwaQ"> </span><span class="p" id="mwag">{</span> <span class="w" id="mwaw"> </span><span class="cm" id="mwbA">/** An ordinary getter */</span> <span class="w" id="mwbQ"> </span><span class="kd" id="mwbg">public</span><span class="w" id="mwbw"> </span><span class="n" id="mwcA">String</span><span class="w" id="mwcQ"> </span><span class="nf" id="mwcg">getUsername</span><span class="p" id="mwcw">()</span><span class="w" id="mwdA"> </span><span class="p" id="mwdQ">{</span> <span class="w" id="mwdg"> </span><span class="k" id="mwdw">return</span><span class="w" id="mweA"> </span><span class="s" id="mweQ">"World"</span><span class="p" id="mweg">;</span> <span class="w" id="mwew"> </span><span class="p" id="mwfA">}</span> <span class="p" id="mwfQ">}</span>

web.xml: The servlet application Deployment Descriptor, which installs Tapestry as a servlet filter.

<span id="mwhQ"></span><span class="cp" id="mwhg"><?xml version="1.0" encoding="UTF-8"?></span> <span class="cp" id="mwhw"><!DOCTYPE web-app</span> <span class="cp" id="mwiA"> PUBLIC "-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"</span> <span class="cp" id="mwiQ"> "http://java.sun.com/dtd/web-app_2_3.dtd"></span> <span class="nt" id="mwig"><web-app></span> <span class="w" id="mwiw"> </span><span class="nt" id="mwjA"><display-name></span>Tapestry<span class="w" id="mwjQ"> </span>Example<span class="nt" id="mwjg"></display-name></span> <span class="w" id="mwjw"> </span><span class="nt" id="mwkA"><context-param></span> <span class="w" id="mwkQ"> </span><span class="cm" id="mwkg"><!-- Tell Tapestry 5 where to look for pages, components and mixins --></span> <span class="w" id="mwkw"> </span><span class="nt" id="mwlA"><param-name></span>tapestry.app-package<span class="nt" id="mwlQ"></param-name></span> <span class="w" id="mwlg"> </span><span class="nt" id="mwlw"><param-value></span>org.example.demo<span class="nt" id="mwmA"></param-value></span> <span class="w" id="mwmQ"> </span><span class="nt" id="mwmg"></context-param></span> <span class="w" id="mwmw"> </span><span class="nt" id="mwnA"><filter></span> <span class="w" id="mwnQ"> </span><span class="cm" id="mwng"><!-- Define the Tapestry servlet filter --></span> <span class="w" id="mwnw"> </span><span class="nt" id="mwoA"><filter-name></span>app<span class="nt" id="mwoQ"></filter-name></span> <span class="w" id="mwog"> </span><span class="nt" id="mwow"><filter-class></span>org.apache.tapestry5.TapestryFilter<span class="nt" id="mwpA"></filter-class></span> <span class="w" id="mwpQ"> </span><span class="nt" id="mwpg"></filter></span> <span class="w" id="mwpw"> </span><span class="nt" id="mwqA"><filter-mapping></span> <span class="w" id="mwqQ"> </span><span class="cm" id="mwqg"><!-- Tell the servlet container which requests to send to the Tapestry servlet filter --></span> <span class="w" id="mwqw"> </span><span class="nt" id="mwrA"><filter-name></span>app<span class="nt" id="mwrQ"></filter-name></span> <span class="w" id="mwrg"> </span><span class="nt" id="mwrw"><url-pattern></span>/*<span class="nt" id="mwsA"></url-pattern></span> <span class="w" id="mwsQ"> </span><span class="nt" id="mwsg"></filter-mapping></span> <span class="nt" id="mwsw"></web-app></span>

Class transformation

Tapestry uses bytecode manipulation to transform page and component classes at runtime. This approach allows the page and component classes to be written as simple POJOs, with a few naming conventions and annotations potentially triggering substantial additional behavior at class load time. Tapestry versions 5.0, 5.1 and 5.2 used the Javassist bytecode manipulation library. Subsequent versions replaced Javassist with a new bytecode manipulation layer called Plastic that is based on ObjectWeb ASM.

Client-side support

Tapestry 5 versions up through 5.3 bundled the Prototype and script.aculo.us JavaScript frameworks, along with a Tapestry-specific library, so as to support Ajax operations as first-class citizens. Third party modules are available to integrate jQuery instead of, or in addition to, Prototype/Scriptaculous.

Starting with version 5.4, Tapestry includes a new JavaScript layer that removes built-in components' reliance on Prototype, allowing jQuery or another JavaScript framework to be plugged in.

Version 5.4 also introduces support for JavaScript modules using the RequireJS module loading system.

Core principles

The Tapestry project documentation cites four "principles" that govern all development decisions for Tapestry, starting with version 5 in 2008:

Static Structure, Dynamic Behavior—page and component structure is essentially static, eliminating the need to construct (and store in session memory) large page and component trees.
Adaptive API—the framework is designed to adapt to the code, rather than having the code adapt to the framework
Differentiate Public vs. Internal APIs—all APIs are explicitly "internal" (private) except those that are necessarily public.
Ensure Backwards Compatibility—The Tapestry developers are reportedly committed to ensuring that upgrading to the latest version of Tapestry is always easy.

Criticism

Tapestry has been criticized as not being backward-compatible across major versions, especially noted in the transition from version 4 to version 5, where no clean migration path was available for existing applications. Project team members have acknowledged this as a major problem for Tapestry's users in the past, and backward compatibility was made a major design goal for Tapestry going forward. From early on in the development of version 5, backward compatibility was listed as one of Tapestry's four new "Core Principles", and two of the other three were intended to make the evolution of the framework possible without sacrificing backward compatibility. Project team members claim that all Tapestry releases since 5.0 have been highly backward compatible.

Early criticisms of Tapestry 5 also mentioned documentation as a shortcoming. Project members now claim that this deficiency has been largely addressed with a thoroughly revised and updated User's Guide and other documentation.

Since version 5.0, Tapestry has bundled the Prototype and Scriptaculous JavaScript libraries. According to Howard Lewis Ship, in the 2008-2009 timeframe these were reasonable choices. Since then, however, Prototype's popularity has declined, and jQuery's has risen dramatically. In response, the Tapestry community developed modules that allowed jQuery to be used in addition to, or instead of, Prototype. Meanwhile, the current version of Tapestry, 5.4, removes the dependency on Prototype entirely, replacing it with a compatibility layer into which either jQuery or Prototype (or potentially any other JavaScript framework) can be plugged.

Relation to other frameworks

According to Howard Lewis Ship, Tapestry was initially conceived as an attempt to implement in Java some of the general concepts and approaches found in WebObjects, which was at that time written in Objective-C and closed-source.

Apache Wicket was developed as a response to the complexity of early versions of Tapestry, according to Wicket originator Jonathan Locke.

Facelets, the default view technology in JavaServer Faces, was reportedly inspired by early versions of Tapestry, as an attempt to fill the need for "a framework like Tapestry, backed by JavaServer Faces as the industry standard".