Project

General

Profile

Sample-vaadin-spring-hibernate » History » Version 10

Henning Blohm, 20.07.2013 12:07

1 1 Henning Blohm
h1. A sample using Vaadin with Hibernate JPA and Spring on Z2
2
3
This sample is similar to [[Sample-spring-hibernate]] but differs (or rather extends) in that it show cases
4
the use of the "Vaadin":http://www.vaadin.com user interface toolkit in conjunction with Spring implemented annotation based
5
dependency injection over Z2 modularity. 
6
7
As Spring is used throughout - in all modules - this is another practical application of [[How to Spring]].
8
9 8 Henning Blohm
Moreover this sample illustrates modularization of Vaadin user interfaces with Z2 using extension points as described in [[Vaadin add-on]].
10
11 1 Henning Blohm
This sample is stored in "z2-samples.vaadin-spring-hibernate":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate.
12
13
h2. Prerequisites
14
15
You need to run Java DB as network server on localhost. This is explained next.
16
17
The application will create a database "z2-samples"
18
19
{{include(How to run Java db)}}
20
21
22
h2. Run it
23
24
Like all samples, also this sample can be run as in [[How to run a sample]]. If you have the database, the fastest way to verify whether it runs is:
25
26
<pre><code class="ruby">
27
mkdir install
28
cd install 
29
git clone -b master http://git.z2-environment.net/z2-base.core
30
git clone -b master http://git.z2-environment.net/z2-samples.vaadin-spring-hibernate
31
32
# on Linux / Mac OS:
33
cd z2-base.core/run/bin
34
./gui.sh
35
36
# on Windows:
37
cd z2-base.core\run\bin
38
gui.bat
39
</code></pre>
40
41
When running, go to http://localhost:8080/vaadin-spring-hibernate. You should see this:
42
43
!vaadin-spring-hibernate.png!
44
45
h2. Details
46
47 3 Henning Blohm
As in the other samples we have a re-use domain module. That is a recurring theme for many good reasons. In this case, the domain module "com.zfabrik.samples.vaadin-spring-hibernate.domain":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/show/com.zfabrik.samples.vaadin-spring-hibernate.domain is essentially like the similarly named module of [[Sample-spring-hibernate]]. The only difference is some more data access methods in the "ThingyRepository":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.domain/java/src.api/com/zfabrik/samples/vaadin_spring_hibernate/thingies/ThingyRepository.java.
48 1 Henning Blohm
49 3 Henning Blohm
The Vaadin Web application is defined in the module "com.zfabrik.samples.vaadin-spring-hibernate.web":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/show/com.zfabrik.samples.vaadin-spring-hibernate.web. It has the usual Spring application context in "web/WebContent/WEB-INF/applicationContext.xml":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.web/web/WebContent/WEB-INF/applicationContext.xml that imports the thingy repository:
50 1 Henning Blohm
51 3 Henning Blohm
<pre><code class="xml">
52
        <!-- import external components -->
53
        <bean id="thingyRepository" class="com.zfabrik.springframework.ComponentFactoryBean">
54
                <property name="componentName" value="com.zfabrik.samples.vaadin-spring-hibernate.domain/repository" />
55
                <property name="className" value="com.zfabrik.samples.vaadin_spring_hibernate.thingies.ThingyRepository" />
56
        </bean>
57
</code></pre>
58
59 5 Henning Blohm
One particularity of using Vaadin in a modular environment is that Vaadin loads it's application class using the class loader that loaded the Vaadin classes (rather than the current thread's context class loader - as would be advised normally). When the Web application module is separated from the Vaadin module this can obviously not work too well (see also "Enhancement #9809":http://dev.vaadin.com/ticket/9809). To fix that you can tell Vaadin to use a custom class loader implementation (that - again - is loaded with the Vaadin class loader). That's why we declare the Vaadin servlet in "web/WebContent/WEB-INF/web.xml":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.web/web/WebContent/WEB-INF/web.xml list this:
60
61
<pre><code class="xml">
62
<!-- Vaadin -->
63
<servlet>
64
  <servlet-name>VaadinServlet</servlet-name>
65
  <servlet-class>com.vaadin.terminal.gwt.server.ApplicationServlet</servlet-class>
66
  <init-param>
67
    <param-name>application</param-name>
68
    <param-value>com.zfabrik.samples.impl.vaadin_spring_hibernate.ApplicationImpl</param-value>
69
  </init-param>
70 1 Henning Blohm
  <!-- this because Vaadin doesn't use the thread's context class loader by default -->
71 8 Henning Blohm
  <init-param>
72 5 Henning Blohm
    <param-name>ClassLoader</param-name>
73
    <param-value>com.zfabrik.vaadin.ContextClassLoader</param-value>
74
  </init-param>*
75
</servlet>
76
</code></pre>
77
78 3 Henning Blohm
The Vaadin application class "ApplicationImpl":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.web/java/src.impl/com/zfabrik/samples/impl/vaadin_spring_hibernate/ApplicationImpl.java constructs a simple view hierarchy that containes a table view based on a "lazy query container add-on":https://vaadin.com/directory#addon/lazy-query-container data model that is fed from the domain module. To do so the corresponding query implementation (in lazy query container speak) has the repository injected:
79
80
<pre><code class="java">
81
@Configurable
82
public class ThingiesQuery implements Query {
83
	@Autowired
84
	private ThingyRepository repository;
85
	private Integer size;
86
	private boolean asc;
87
88
// ...
89
}
90
</code></pre>
91 5 Henning Blohm
92
Please browse the actual UI code at "com.zfabrik.samples.vaadin-spring-hibernate.web/java/src.impl/com/zfabrik/samples/impl/vaadin_spring_hibernate":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/show/com.zfabrik.samples.vaadin-spring-hibernate.web/java/src.impl/com/zfabrik/samples/impl/vaadin_spring_hibernate. It pretty much speaks for itself.
93 4 Henning Blohm
94 10 Henning Blohm
h3. Transaction Management
95
96 4 Henning Blohm
One important note on transaction management: In this example, transaction boundaries are enforced by a servlet filter once more. It is implemented in "TransactionFilter":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.web/java/src.impl/com/zfabrik/samples/impl/vaadin_spring_hibernate/util/TransactionFilter.java and essentially looks like this:
97
98
<pre><code class="java">
99
public class TransactionFilter implements Filter {
100
101
102
        @Transactional
103
        @Override
104
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
105
                chain.doFilter(request, response);
106
        }
107
108
}
109
</code></pre>
110
111
In other words, the only thing it really does is to make sure Spring spans a transaction (using the underlying JTA implementation) along the request. It is tempting to implement transaction demarcation in the Vaadin Application class. However, we cannot use the <code>@Transactional</code> annotation as there is no single request spanning method and using the JTA UserTransaction object is unfortunately not sufficient to "remote control" Spring's JTA wrappers. So the easiest work around is to use Spring TX demarcation right away (see also [[how to transaction management]]).
112 10 Henning Blohm
113
h3. Extensibility
114 6 Henning Blohm
115 7 Henning Blohm
Furthermore this sample illustrates the use of the *ExtensionComponentsUtil* ("javadoc":http://www.z2-environment.net/javadoc/com.zfabrik.vaadin!2Fjava/api/com/zfabrik/vaadin/ExtensionComponentsUtil.html) as described in detail at [[Vaadin_Add-on]]. This utility allows to conveniently modularize the user interface implementation by providing and retrieving Vaadin user interface component implementations across modules.
116 6 Henning Blohm
117 9 Henning Blohm
In the specific case, the module "com.zfabrik.samples.vaadin-spring-hibernate.extension":https://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/show/com.zfabrik.samples.vaadin-spring-hibernate.extension provides an extension component "somethingAboutThingies":https://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-vaadin-spring-hibernate/revisions/master/entry/com.zfabrik.samples.vaadin-spring-hibernate.extension/somethingAboutThingies.properties that is added as the button "About these..." to the button toolbar of the main interface.