Project

General

Profile

Sample-hibernate-basic » History » Version 32

Henning Blohm, 18.06.2023 13:02

1 1 Henning Blohm
h1. A plain Hibernate on Z2 sample
2 2 Henning Blohm
3 3 Henning Blohm
Note that Hibernate is used in other samples as well, such as [[Sample-jta-plain]], [[Sample-jta-spring]], and others. This sample shows the minimal things to do to use Hibernate as an implementation of the Java Persistence API ("JPA":http://de.wikipedia.org/wiki/Java_Persistence_API). 
4 4 Henning Blohm
5 5 Henning Blohm
This sample is stored in the repository "z2-samples.hibernate.basic":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic. 
6
7 19 Henning Blohm
This sample makes use of the [[Hibernate Add-on]] and is most likely the best documentation on how to use its supporting functionality. While some of the possibly complex seeming (but only needed once) glue code below is not required when using Spring (for example), as in [[Sample-spring-hibernate]], [[Sample-springds-hibernate]], this sample is most instructive on how Hibernate, Transaction Management, Z2, and the Jetty Web Container integrate with one another while closely sticking to standard descriptors (JPA) and naming (Java EE JNDI/Servlet).
8 14 Henning Blohm
9 5 Henning Blohm
h2. Prerequisites
10
11 22 Henning Blohm
{{include(Java Version Requirements)}}
12 21 Henning Blohm
13 11 Henning Blohm
You need to run Java DB as network server on localhost. This is explained next.
14 1 Henning Blohm
15 11 Henning Blohm
The application will create a database "z2-samples"
16 5 Henning Blohm
17 11 Henning Blohm
{{include(How to run Java db)}}
18
19
h2. Run the sample
20 5 Henning Blohm
21 25 Henning Blohm
If you have the database, the fastest way to verify whether it runs is:
22 1 Henning Blohm
23 25 Henning Blohm
{{include(Install_sample_prefix)}}
24 5 Henning Blohm
25 25 Henning Blohm
Check out the sample
26 5 Henning Blohm
27 26 Henning Blohm
<pre><code class="bash">
28 32 Henning Blohm
git clone -b v2.10 https://www.z2-environment.net/git/z2-samples.hibernate-basic
29 5 Henning Blohm
</code></pre>
30 25 Henning Blohm
31
{{include(Install_sample_postfix)}}
32 5 Henning Blohm
33 10 Henning Blohm
When started, go to http://localhost:8080/hibernate-basic. You should see this:
34
35
!hibernate-basic.png!
36
37 5 Henning Blohm
h2. Details
38
39 7 Henning Blohm
A lot of the things happening here relate to what is explained in [[How to transaction management]].
40 1 Henning Blohm
41 7 Henning Blohm
The assumption of this example is that of a re-use domain module *com.zfabrik.samples.hibernate-basic.domain* that implements a "Thingy Repository" and is used from a web application that is in another module *com.zfabrik.samples.hibernate-basic.web*. The domain module exposes the Thingy Repository as a Z2 component that is bound by the Web app as an environment (ENC) variable and injected into the controller filter by the Web container.
42
43
The domain module makes use of Hibernate's JPA implementation and integrates with the transaction management provided by *com.zfabrik.jta*.
44
45
Now, step-by-step.
46
47
h3. The domain module and its persistence context
48
49
The domain module *com.zfabrik.samples.hibernate-basic.domain* defines a persistence unit "thingies" in "java/src.impl/META-INF/persistence.xml":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/java/src.impl/META-INF/persistence.xml, i.e. in its implementation. That makes sense, as the XML file will be looked up with a class loader and we do not intent to retrieve from another module. Or, put differently, the persistence unit is not part of the module's API.
50
51
In order to integrate with the built-in transaction management the <code>persistence.xml</code> declares the JTA data source 
52
53
<pre><code class="xml">
54
<jta-data-source>components:com.zfabrik.samples.hibernate-basic.domain/DB</jta-data-source>
55
</code></pre>
56 1 Henning Blohm
57 14 Henning Blohm
and the _JTA Platform_ (Hibernate's transaction management abstraction since v4.3) 
58 1 Henning Blohm
59 7 Henning Blohm
<pre><code class="xml">
60 14 Henning Blohm
<property name="hibernate.transaction.jta.platform" value="com.zfabrik.hibernate.Z2JtaPlatform"/>
61 7 Henning Blohm
</code></pre>
62
63 14 Henning Blohm
The former points to the data source component "com.zfabrik.samples.hibernate-basic.domain/DB":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/DB.properties, while the latter makes sure Hibernate can register with the transaction manager implementation that comes built-in with Z2 (other samples, such as [[Sample-jta-plain]], [[Sample-springds-hibernate]] show alternative approaches).
64 7 Henning Blohm
65
The persistence unit defines only one entity. The Thingy as in "Thingy.java":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/java/src.api/com/zfabrik/samples/hibernate_basic/thingies/Thingy.java. That is an API-exposed type. We use the simplified pattern of exposing persistent objects in the API rather than using Data Transfer Objects (DTOs).
66
67 12 Udo Offermann
Also, the domain module exposes the interface of the "Thingy Repository":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/java/src.api/com/zfabrik/samples/hibernate_basic/thingies/ThingyRepository.java. This interface is used by the Web application to retrieve, store, and delete thingies.
68 7 Henning Blohm
69
The implementation of the Thingy Repository, "ThingyRepositoryImpl":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/java/src.impl/com/zfabrik/samples/hibernate_basic/impl/thingies/ThingyRepositoryImpl.java is not a public type. Instead, it is instantiated and held on to via a Z2 component lookup from the Web app on the component "com.zfabrik.samples.hibernate-basic.domain/repository":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.domain/repository.properties.
70
71
In ThingyRepositoryImpl, in order to access and re-use the JPA Entity Manager for the persistence unit "thingies" we use EntityManagerUtil from *org.hibernate* with a Entity Manager Factory that we create upon service instantiation and using the user transaction implementation of *com.zfabrik.jta*:
72
73
<pre><code class="java">
74 1 Henning Blohm
public class ThingyRepositoryImpl implements ThingyRepository {
75
	private EntityManagerFactory emf;
76
77 14 Henning Blohm
	/**
78
	 * Create the repo
79
	 */ 
80 1 Henning Blohm
	public ThingyRepositoryImpl() {
81 14 Henning Blohm
		/*
82
		 * We switch the context class loader so that Hibernate finds our persistence.xml.
83
		 * We use the EntityManagerUtil so that Hibernate doesn't freak out in a 
84
		 * no-Initial-Context-Factory (but URL for lookup) naming environment.
85
		 */
86 7 Henning Blohm
		this.emf = ThreadUtil.cleanContextExecute(
87 14 Henning Blohm
			this.getClass().getClassLoader(),
88 7 Henning Blohm
			new Callable<EntityManagerFactory>() {
89 14 Henning Blohm
				@Override
90 7 Henning Blohm
				public EntityManagerFactory call() throws Exception {
91 14 Henning Blohm
					return EntityManagerUtil.createEntityManagerFactory("thingies");
92
				}
93 7 Henning Blohm
			}
94
		);
95
	}
96
97
	@Override
98
	public void store(Thingy thingy) {
99
		this.em().persist(thingy);
100
	}
101
102
	@SuppressWarnings("unchecked")
103
	@Override
104
	public Collection<Thingy> findAll() {
105
		return this.em().createQuery("select t from Thingy t").getResultList();
106
	}
107
108
	@Override
109
	public void delete(int id) {
110
		Thingy t = this.em().find(Thingy.class, id);
111
		if (t != null) {
112
			this.em().remove(t);
113
		}
114
	}
115
116
	//
117
	// Uses the Entity Manager Util that holds on to EMs created from the passed on EMF
118
	// while the transaction is still open.
119
	//
120
	private EntityManager em() {
121
		return EntityManagerUtil.getEntityManager(
122 1 Henning Blohm
			IComponentsLookup.INSTANCE.lookup(
123 7 Henning Blohm
				"com.zfabrik.jta/userTransaction", 
124
				TransactionManager.class
125
			),
126
			this.emf
127
		);
128
	}
129
}
130 8 Henning Blohm
</code></pre>
131
132 1 Henning Blohm
Note that when creating the entity manager factory, we have to make sure the right context class loader is set so that the persistence unit definition will be picked up by Hibernate. This is a general pattern when initializing services in a modular application: You need to distinguish when the service's context matters vs. when the caller's context matters (check out "a blog article on that":http://www.z2-environment.net/blog/2012/07/for-techies-protecting-java-in-a-modular-world-context-classloaders/).
133 16 Henning Blohm
134 18 Henning Blohm
We would normally use the JPA class "Persistence":http://docs.oracle.com/javaee/6/api/javax/persistence/Persistence.html to create an entity manager factory. Due to "HHH-8818":https://hibernate.atlassian.net/browse/HHH-8818 we do need to work around some JNDI issue by using the EntityManagerUtil (see its "source code":https://redmine.z2-environment.net/projects/z2-addons/repository/z2-addons-hibernate/revisions/master/entry/org.hibernate/java/src.api/com/zfabrik/hibernate/EntityManagerUtil.java here).
135 13 Udo Offermann
136 8 Henning Blohm
h3. The web module, transaction boundaries, and service re-use
137
138
Let's turn to the Web application in *com.zfabrik.samples.hibernate-basic.web/web*. And let's start with how the Thingy Repository is accessed from the Web app. In this example we do not use Spring or direct lookups, instead we use the Web container provided dependency injection mechanisms. In "WebContent/WEB-INF/jetty-env.xml":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.web/web/WebContent/WEB-INF/jetty-env.xml we bind the result of a JNDI lookup for the repository implementation component to the _Environment Naming Context_ (ENC) variable "repos/thingies". This is java EE mechanics. It means that from within the Web app, the repository is available under the JNDI name "java:comp/env/repos/thingies":
139
140
<pre><code class="xml">
141
<Configure class="org.eclipse.jetty.webapp.WebAppContext">
142
  <New id="thingyRepository" class="org.eclipse.jetty.plus.jndi.Resource">
143
    <Arg>repos/thingies</Arg>
144
    <Arg>
145
      <New class="javax.naming.LinkRef">
146
        <Arg>components:com.zfabrik.samples.hibernate-basic.domain/repository?type=com.zfabrik.samples.hibernate_basic.thingies.ThingyRepository</Arg>
147
      </New>
148
    </Arg>
149
  </New>
150
</Configure>
151
</code></pre>
152
153 29 Henning Blohm
See also "Jetty JNDI":https://www.eclipse.org/jetty/documentation/current/using-jetty-jndi.html.
154 8 Henning Blohm
155
Anyway. Now, in the "ControllerFilter":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.web/java/src.impl/com/zfabrik/samples/hibernate_basic/impl/web/ControllerFilter.java we inject the Thingy Repository like this:
156
157
<pre><code class="java">
158
public class ControllerFilter implements Filter {
159
	
160
	// inject thingies repository (see WEB-INF/jetty-env.xml)
161
	@Resource(name="repos/thingies")
162
	private ThingyRepository thingyRepository;
163
	
164
...
165
}
166
</code></pre>
167
168
Alternatively, if you think this is a little overkill, you might as well use a direct lookup, either with JNDI using the name in the XML or via Z2's component lookup
169
170
<pre><code class="java">
171
IComponentsLookup.INSTANCE.lookup("com.zfabrik.samples.hibernate-basic.domain/repository",ThingyRepository.class);
172
</code></pre>
173
174
Finally a word on transaction management. Transaction boundaries are controlled by the "TransactionFilter":http://redmine.z2-environment.net/projects/z2-samples/repository/z2-samples-hibernate-basic/revisions/master/entry/com.zfabrik.samples.hibernate-basic.web/java/src.impl/com/zfabrik/samples/hibernate_basic/impl/web/TransactionFilter.java contained in the sample. We make use of *TransactionUtil* from *com.zabrik.jta* to wrap the actual web app request in a transaction:
175
176
<pre><code class="java">
177
@Override
178
public void doFilter(final ServletRequest sreq, final ServletResponse sres,	final FilterChain chain) throws IOException, ServletException {
179
  HttpServletRequest req = (HttpServletRequest) sreq;
180
  if (req.getDispatcherType()==DispatcherType.REQUEST || req.getDispatcherType()==DispatcherType.ASYNC) {
181
    try {
182
      TransactionUtil.run(
183
        (UserTransaction) new InitialContext().lookup("java:comp/UserTransaction"),
184
        new Callable<Void>() {
185
          public Void call() throws Exception {
186
            chain.doFilter(sreq, sres);
187
            return null;
188
          }
189
        }
190
      );
191
    } catch (Exception e) {
192
      throw new ServletException(e);
193
    }
194
  } else {
195
    chain.doFilter(sreq, sres);
196 1 Henning Blohm
  }
197
}
198 15 Henning Blohm
</code></pre>
199
200
Finally note that we retrieved the transaction manager via the standard Java EE JNDI name @java:comp/UserTransaction@. Z2 uses Jetty as its Web container implementation. In order to have Jetty bind the transaction manager, we configure the Web server in "environment/webServer/jetty.xml":https://redmine.z2-environment.net/projects/z2-samples/repository/revisions/master/entry/environment/webServer/jetty.xml to retrieve the built-in transaction manager:
201
202
<pre><code class="xml">
203
...
204
205
	<New id="tx" class="org.eclipse.jetty.plus.jndi.Transaction">
206
		<Arg>
207
			<New class="com.zfabrik.tx.UserTransaction">
208
			</New>
209
		</Arg>
210
	</New>
211
...
212 1 Henning Blohm
</code></pre>
213 20 Henning Blohm
214
h2. How this sample makes use of MVNCR
215
216 31 Henning Blohm
This sample in conjunction with the [[Hibernate add-on]] is a good example on how to use the Maven component repository (see [[How to Access a Maven Repository]]).
217 20 Henning Blohm
218
The situation is this:
219
220
* The add-on (the [[Hibernate add-on]] in this case) defines the artifacts required but may not define the actual artifact repository to use. After all it may be used with a locally hosted artifact repository.
221
* The solution environment (in this case this sample) may define the actual artifact repository but it should not need to repeat all the details on the actual artifact names and versions
222
223
To resolve this we use Maven component repository declarations and Maven component repository fragment declarations. 
224
225
* The repository declared as part of the sample in "environment/mavenDefault":https://redmine.z2-environment.net/projects/z2-samples/repository/revisions/master/entry/environment/mavenDefault has all the information on where to get artifacts from, while
226
* the fragment declared in the add-on at "org.hibernate/mvnFragment":https://redmine.z2-environment.net/projects/z2-addons/repository/z2-addons-hibernate/revisions/master/entry/org.hibernate/mvnFragment.properties declares the dependency roots it needs to have resolved from the (yet unknown - from the perspective of the add-on) MVNCR *environment/mavenDefault*.