From Documentation

Revision as of 06:58, 16 October 2012 by Southerncrossie (Talk | contribs)
Jump to: navigation, search

WarningTriangle-32x32.png This page is under construction, so we cannot guarantee the accuracy of the content!

  • Author
    Ian YT Tsai, Engineer, Potix Corporation
  • Date
    October 05, 2012
  • Version
    ZK 6



Spring Framework is one of the most common frameworks for Java web developers. In this article, I'll introduce how to integrate ZK, Spring and Hibernate together to build a web application. First, I'll list the prerequisites of the demo application. Then I'll focus on the detail configuration of this application stack and guide you through how to use ZK Spring DelegatingVariableResolver in your ZK code with some programming tips of the Spring part design.

If you have already read Practices Of Using CDI In ZK, this article is the counterpart of it in Spring.

Develop Environment Preparation

To get the source code, you can download everything from [1], please get the zip file named, and it's better to get the latest one. If your are familiar with Git, you can also clone my smalltalk repository.

IDE Setup

In this article, we use Eclipse with M2Eclipse to manage our Maven Project.

  1. Eclipse 3.x: I think everything should be fine in 4.X but I haven't try it.
  2. M2Eclipse: a Maven management Eclipse plugin.
  3. RunJettyRun: a simple Jetty Server which is very easy to use with M2Eclipse.

Demo Project Setup

If you are a Maven user and already cloned my repository , the project is a Maven project, you can use Eclipse Import Existing Project function to import it. If you get the code by downloading tthe zip file, unpack it, and put them to the project type you preferred.

About The Demo Application

The demo case of this article is the same one in Practices Of Using CDI In ZK, it is an online order management system.text

This demo consists of 4 parts:

  1. Login, when it's the first time the user requests the URL: http://localhost:8080/springZkDemo, the request will be redirected to the login page and ask user to perform the login process.
  2. product view, after login, user will be redirected back to main page which has three fragments, the first one is product view which displays all available products.
  3. shopping cart view, At the east part of main view which displays user's shopping cart content, user can add, remove and change quantity of products in cart.
  4. order view, The bottom of the main page displays user's order and order details of each order.

Entity Beans of This Application

In this demo application we have several entity beans all under package demo.model.bean

  • Product, a product with several attributes like name, price, quantity
  • CartItem, a shopping cart item which has attribute amount and pointed to a product.
  • Order, an order which contains multiple order item.
  • OrderItem, an item that has attributes which comes from cartitem
  • User, a user with attributes user name and password

Using Spring in ZK Application

Just like a normal Spring web application, you have to configure some listener, context parameter and filter in WEB-INF/web.xml to make Spring can manage it's application context properly for different level of scope. The configuration is looked like this:

	<!--  Declares where the Spring application context setting is -->

	<!-- Spring Context Initialization & Request scope Handling -->

Persistence Layer

In this Demo we use JPA as our persistence layer solution. There are two ways to configure and use JPA:

  1. Use container specific data source configuration to setup the data source, and define and declare it in your web application. this way is strongly suggested if your are running your system in a official environment with a well managed application server.
  2. Define the JPA data source in classpath:META-INF/persistence.xml. your application must has JPA related jar library(Hibernate in our case) to scan and initialize the whole stuff while application start up.

We chose the second one here to make this demo project container independent.

Spring JPA Specific configuration

As the <context-param> declaration in WEB-INF/web.xml, we put our Spring application context configuration file in classpath:META-INF/spring/app-context.xml

Opening our app-context.xml, the JPA related configuration part is briefed bellow:

	<context:component-scan base-package="org.zkoss.springdemo.model, org.zkoss.springdemo.web.model" />
	<bean id="emf" class="org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean">
		<property name="persistenceUnitName" value="breakfast" />

	<bean id="txManager" class="org.springframework.orm.jpa.JpaTransactionManager">
		<property name="entityManagerFactory" ref="emf" />
	<tx:annotation-driven transaction-manager="txManager" />

<context:component-scan>: this part is to tell Spring which java package contains beans which have additional meta-info(annotation) that requires specific treatment. Though personally I'd much prefer to use XML declaration to manage bean's construction in Spring, but annotation in some cases are much convenient than XML, for example, to tell which class is a DAO and what method of it should become transactional.

<bean id="emf" ...>: To get and use a JPA Entity Manager, first, we need to have an Entity Manager Factory. in Spring, org.springframework.orm.jpa.LocalContainerEntityManagerFactoryBean is the bean that can simply construct a factory in application.

bean id="txManager" & tx:annotation-driven: These two parts will declare a transaction manager for JPA and tell Spring component scanner that transaction manager is aware of some annotation.

Open Entity Manager In View

After the configurations above, the Spring context of this application is ready to handle the usage of @PersistentContext, @Repository and @Transactional in DAO class:

public class OrderDAO {
	EntityManager em;
	@Transactional(value="txManager", propagation=Propagation.REQUIRES_NEW)
	public Order cancelOrder(final Order order) {
		if(order==null)return null;
		return em.merge(order);

According to Spring's manual: Spring JPA Note, if you use correct Entity Manager Factory bean to manage EntityManager usage, you can get fresh and safe entity Manager in application context during Http requesting. But this is not enough for the old entity bean, they were fetched last time and need to be reconciled to entity manager. For this purpose we need to declare a <filter> in WEB-INF/web.xml:



The entityManagerFactoryBeanName is mapped to the bean with id "emf" in app-context.xml, and the filter mapping is mapped to all possible request to make sure every request could use entity manager freshly.

Logic Layer

Logic Layer is a layer for business objects of this demo, in this demo application, all object about this layer has been put in package org.zkoss.springdemo.web.model.

Business Object Design practice

In this demo application, we have several main business objects which provides a set of logical API to interact with view. They are:

  • org.zkoss.springdemo.web.model.ProductManager
  • org.zkoss.springdemo.web.model.UserOrderManager
  • org.zkoss.springdemo.web.model.UserCredentialManager
  • org.zkoss.springdemo.web.model.ShoppingCart

Let's use them to see how to design your business object in some common scenario.

Application Scope Practice

In org.zkoss.springdemo.web.model.ProductManager, as the scenario here is to provide a list of available products for view to display, the code is very simple:

public class ProductManager {
	private ProductDAO productDao;

	public ProductDAO getProductDao() {
		return productDao;
	public void setProductDao(ProductDAO productDao) {
		this.productDao = productDao;
	public List<Product> findAllAvailable() {
		return productDao.findAllAvailable();

As what you can see this bean has nothing but a productDao attribute, the scope declaration and bean id are all defined in app-context.xml:

<bean id="productManager" scope="application"
	<property name="productDao" ref="productDAO" />

Inconsistent Scope handling

Though our ProductManager is application scoped, the ProductDAO which Spring injected has a request scoped life-cycle, this causes a scope inconsistent problem and this needs to be solved. To deal with this inconsistency, Spring has a Scoped Proxy mechanism which based on Spring AOP and we need to define the proxy mode in ProductDAO class annotation declaration:

@Scope(value="request", proxyMode=ScopedProxyMode.TARGET_CLASS)
public class ProductDAO{

At the back-end with this declaration, Spring will use CGLIB to create a proxy class to pretend our ProductDao and inject it into our ProductManager to make sure every time when user call: productDao.findAllAvailable(), the manager would works fine.

Session Scope Practice

In web logical layer design, a business object which needs to keep state across multiple requests should be stored in session. In this Spring demo app, business layered beans' meta info are all declared in app-context.xml:

	<bean id="shoppingCart" scope="session"
		<property name="userCredentialManager" ref="userCredentialManager" />

To identify if a managed bean should be session scoped or not, you can check if it contains unmanaged state-related member fields in bean class. For example in our demo application while user try to request http://localhost:8080/springZkDemo/index.zul we need to check if current user is authenticated. if not, well redirect him to login.zul for login process:

Zk cdi integration login proc.png

In order to do this, in this demo, i designed a org.zkoss.springdemo.web.model.UserCredentialManager which is a session scoped object maintaining the state of user credential:

public class UserCredentialManager implements Serializable{
	public UserCredentialManager(){}
	private User user;

	private UserDAO userDao;
	public UserDAO getUserDao() {
		return userDao;
	public void setUserDao(UserDAO userDao) {
		this.userDao = userDao;
	public synchronized void login(String name, String password) {

As you can see above, the UserCredentialManager has a login(name, password) method and stored a User bean inside. And in the app-context.xml:

	<bean id="userCredentialManager" scope="session"
		<property name="UserDao" ref="userDAO" />

Presentation Layer

This layer is about how to use BO in ZK's view, the java classes that controlling zk views are all under org.zkoss.springdemo.web.ui.ctrl. In this application we demonstrate how to use Spring bean in ZK MVC controller:

  • org.zkoss.springdemo.web.ui.ctrl.LoginViewCtrl
  • org.zkoss.springdemo.web.ui.ctrl.ProductViewCtrl

and how to use Spring bean in ZK MVVM view model bean:

  • org.zkoss.springdemo.web.ui.ctrl.OrderViewViewModel
  • org.zkoss.springdemo.web.ui.ctrl.ShoppingCartViewModel

Context Injection in ZK

Adopting Spring's context to ZK view context is very simple, you simply use ZK's org.zkoss.zkplus.spring.DelegatingVariableResolver. Here we will discuss 3 circumstances you can use ZK's Spring DelegatingVariableResolver.

ZK's Listener

In the login process example above, we have a WorkbenchInit declared in index.zul, let's see how to get managed bean in ZK's listener (ex: org.zkoss.zk.ui.util.Initiator).

In ZK, we have a bunch of Listeners that you can do some interception or flow control. To get Spring managed bean from them, the easiest way is to construct a new DelegatingVariableResolver instance:

public class WorkbenchInit implements Initiator {	
	private UserCredentialManager userCredentialManager;

	public void doInit(Page page, @SuppressWarnings("rawtypes") Map arg) throws Exception {
			userCredentialManager = (UserCredentialManager) 
			new DelegatingVariableResolver().resolveVariable("userCredentialManager");
		if (!userCredentialManager.isAuthenticated()) {

As illustrated above, we can get our session object userCredentialManager by calling resolveVariable(String) through DelegatingVariableResolver in an Initiator.

In Listener scenario we use a programmatic approach to get managed bean. In ZK MVC controller, we can use annotations for variable wiring to save coding effort. For example, in org.zkoss.spring demo.web.ui.ctrl.LoginViewCtrl:

public class LoginViewCtrl extends SelectorComposer<Window> {

	private Textbox nameTxb, passwordTxb;
	private Label mesgLbl;

	private UserCredentialManager userCredentialManager;

	@Listen("onClick=#confirmBtn; onOK=#passwordTxb")
	public void doLogin() {
		userCredentialManager.login(nameTxb.getValue(), passwordTxb.getValue());
		if (userCredentialManager.isAuthenticated()) {
		} else {
			mesgLbl.setValue("Your User Name or Password is invalid!");

We use @VariableResolver(org.zkoss.zkplus.spring.DelegatingVariableResolver.class) to annotate LoginViewCtrl which tells super class SelectorComposer that this controller will based on Spring context to do variable wiring. Then in the member field declaration part, we can use @WireVariable to wire UserCredentialManager. As you can see, by default if the field's name is the name of that Spring bean, the instance will be wired automatically.


In ZK MVVM, the way to do variable wiring is very similar to ZK MVC, let's use org.zkoss.springdemo.web.ui.ctrl.OrderViewViewModel for example:

public class OrderViewViewModel  {
	private UserOrderManager userOrderManager;
	private Order selectedItem;

	public Order getSelectedItem() {
		return selectedItem;
	public void setSelectedItem(Order selectedItem) {
		this.selectedItem = selectedItem;
	public List<Order> getOrders() {
		return userOrderManager.findAll();
	@NotifyChange({"orders", "selectedItem"})
	public void cancelOrder() {
		if (getSelectedItem() == null) {
	public void submitNewOrder( 
			 @BindingParam("cartItems")List<CartItem> cartItems 
			,@BindingParam("orderNote") String orderNote){
		userOrderManager.createOrder( cartItems, orderNote);

We reuse @VariableResolver and @WireVariable annotations here, which makes our View Model object becomes very clean to both ZK view and data.


In this series of articles(with the other two: Practices Of Using CDI In ZK, Starting A Web Application Based On ZK CDI JPA and Jetty ) I showed how to start a web application stack based on two of most famous application frameworks(CDI, Spring) with ZK, as what you can see, the usage of these framework's context are totally the same in ZK.


Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.