forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathspring.html
More file actions
308 lines (270 loc) · 14.4 KB
/
spring.html
File metadata and controls
308 lines (270 loc) · 14.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta id="layout-head" />
<title>Ebean ORM Setup</title>
<link rel="shortcut icon" href="/images/favicon.ico" >
<!--<link href="/css/bootstrap.min.css" rel="stylesheet">-->
<!-- Latest compiled and minified CSS -->
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
<link rel="stylesheet" href="//netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.min.css">
<!-- HTML5 Shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
<script src="https://oss.maxcdn.com/libs/respond.js/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar navbar-inverse navbar-fixed-top" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".mobile-nav">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/"><img src="/images/logo-black-3.png" width="32" style="display: inline;">Ebean ORM</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right">
<li ><a href="/"><span class="glyphicon glyphicon-home"></span> Home</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a href="/quickstart">Quick Start</a></li>
<li ><a href="/support">Support</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fa fa-github"></i> Github</a></li>
</ul> </div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right">
<li ><a href="/"><span class="glyphicon glyphicon-home"></span> Home</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a href="/quickstart">Quick Start</a></li>
<li ><a href="/support">Support</a></li>
<li class="active"><a href="/docs">Docs</a></li>
<li ><a target="_blank" href="/apidoc/10">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li ><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fa fa-github"></i> Github</a></li>
</ul> </div>
</div>
</div>
</div>
<div id="main" data-offset="60">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs">Documentation</a> / <a href="/docs/setup">Setup</a> / Spring </h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<div class="bs-docs-section">
<h2 id="spring-boot">Spring boot</h2>
<p>
Ebean is now aware of Spring boot runnable jar structure (for scanning the classpath). There is an
<a href="https://github.com/ebean-orm/example-springboot">example application<a/> showing:
</p>
<ul>
<li><a href="https://github.com/ebean-orm/example-springboot/blob/master/src/main/java/org/example/sboot/service/EbeanFactoryBean.java">Factory Bean (programmatic configuration of EbeanServer)</a></li>
<li>The EbeanFactoryBean also loads and uses configuration Properties from application.properties</li>
<li><a href="https://github.com/ebean-orm/example-springboot/blob/master/src/test/resources/test-ebean.properties">test-ebean.properties</a></li>
</ul>
<p>
This example does not show integration with Spring transactions (and instead uses Ebean's own transactions). Please
review the <code>ebean-spring</code> project for that.
</p>
<h2 id="ebean-spring">ebean-spring</h2>
<p>
The ebean-spring provides a FactoryBean as well as integration with Spring transactions.
</p>
<div role="tabpanel">
<ul class="nav nav-tabs" role="tablist">
<li role="presentation" class="active"><a href="#Maven4" aria-controls="Maven4" role="tab" data-toggle="tab">Maven</a></li>
<li role="presentation"><a href="#Ivy4" aria-controls="Ivy4" role="tab" data-toggle="tab">Ivy</a></li>
<li role="presentation"><a href="#Grape4" aria-controls="Grape4" role="tab" data-toggle="tab">Grape</a></li>
<li role="presentation"><a href="#Gradle4" aria-controls="Gradle4" role="tab" data-toggle="tab">Gradle</a></li>
<li role="presentation"><a href="#Buildr4" aria-controls="Buildr4" role="tab" data-toggle="tab">Buildr</a></li>
<li role="presentation"><a href="#SBT4" aria-controls="SBT4" role="tab" data-toggle="tab">SBT</a></li>
<li role="presentation"><a href="#Leiningen4" aria-controls="Leiningen4" role="tab" data-toggle="tab">Leiningen</a></li>
</ul>
<div class="tab-content">
<div role="tabpanel" class="tab-pane active" id="Maven4">
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt"><dependency></span>
<span class="nt"><groupId></span>io.ebean<span class="nt"></groupId></span>
<span class="nt"><artifactId></span>ebean-spring<span class="nt"></artifactId></span>
<span class="nt"><version></span><span class='ebean-spring-version'>${version}</span><span class="nt"></version></span>
<span class="nt"></dependency></span>
</pre></div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="Ivy4">
<div class="syntax xml"><div class="highlight"><pre><span></span><span class="nt"><dependency</span> <span class="na">org=</span><span class="s">"io.ebean"</span> <span class="na">name=</span><span class="s">"ebean-spring"</span> <span class="na">rev=</span><span class="s">"<span class='ebean-spring-version'>${version}</span>"</span><span class="nt">/></span>
</pre></div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="Grape4">
<div class="syntax groovy"><div class="highlight"><pre><span></span><span class="nd">@Grapes</span><span class="o">(</span>
<span class="nd">@Grab</span><span class="o">(</span><span class="n">group</span><span class="o">=</span><span class="s1">'io.ebean'</span><span class="o">,</span> <span class="n">module</span><span class="o">=</span><span class="s1">'ebean-spring'</span><span class="o">,</span> <span class="n">version</span><span class="o">=</span><span class="s1">'<span class='ebean-spring-version'>${version}</span>'</span><span class="o">)</span>
<span class="o">)</span>
</pre></div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="Gradle4">
<div class="syntax groovy"><div class="highlight"><pre><span></span><span class="s1">'io.ebean:ebean-spring:<span class='ebean-spring-version'>${version}</span>'</span>
</pre></div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="Buildr4">
<div class="syntax groovy"><div class="highlight"><pre><span></span><span class="s1">'io.ebean:ebean-spring:<span class='ebean-spring-version'>${version}</span>'</span>
</pre></div>
</div> </div>
<div role="tabpanel" class="tab-pane" id="SBT4">
<div class="syntax scala"><div class="highlight"><pre><span></span><span class="n">libraryDependencies</span> <span class="o">+=</span> <span class="s">"io.ebean"</span> <span class="o">%</span> <span class="s">"ebean-spring"</span> <span class="o">%</span> <span class="s">"<span class='ebean-spring-version'>${version}</span>"</span>
</pre></div>
</div>
</div>
<div role="tabpanel" class="tab-pane" id="Leiningen4">
<div class="syntax xml"><div class="highlight"><pre><span></span>[io.ebean/ebean-spring "<span class='ebean-spring-version'>${version}</span>"]
</pre></div>
</div>
</div>
</div>
</div>
<h5>EbeanServerFactoryBean</h5>
<p>
<code>EbeanServerFactoryBean</code> is a spring FactoryBean that also holds a serverConfig.
It is expected to be used in conjunction with <code>default-ebean-server.xml</code> which specifically
registers <code>SpringAwareJdbcTransactionManager</code> as the external transaction manager on the ServerConfig.
</p>
<h5>SpringAwareJdbcTransactionManager</h5>
<p>
<code>SpringAwareJdbcTransactionManager</code> implements Ebean's ExternalTransactionManager API and provides the
integration into Spring transaction management.
</p>
<h5>SpringJdbcTransaction</h5>
<p>
<code>SpringJdbcTransaction</code> extends Ebean's <code>ExternalJdbcTransaction</code> and
is used by SpringAwareJdbcTransactionManager.
</p>
<h2 id="factorybean">FactoryBean</h2>
<p>
Rather than use the implementation provided in <code>ebean-spring</code> you can write your
own Spring FactoryBean like the code below (or the spring boot EbeanFactoryBean example
<a href="https://github.com/ebean-orm/example-springboot/blob/master/src/main/java/org/example/sboot/service/EbeanFactoryBean.java">Factory Bean (programmatic configuration of EbeanServer)</a>).
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="cm">/**</span>
<span class="cm"> * Simple Spring bean factory for creating the EbeanServer.</span>
<span class="cm"> */</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">MyEbeanServerFactory</span> <span class="kd">implements</span> <span class="n">FactoryBean</span><span class="o"><</span><span class="n">EbeanServer</span><span class="o">></span> <span class="o">{</span>
<span class="kd">public</span> <span class="n">EbeanServer</span> <span class="nf">getObject</span><span class="o">()</span> <span class="kd">throws</span> <span class="n">Exception</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">createEbeanServer</span><span class="o">();</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="n">Class</span><span class="o"><?></span> <span class="n">getObjectType</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">EbeanServer</span><span class="o">.</span><span class="na">class</span><span class="o">;</span>
<span class="o">}</span>
<span class="kd">public</span> <span class="kt">boolean</span> <span class="nf">isSingleton</span><span class="o">()</span> <span class="o">{</span>
<span class="k">return</span> <span class="kc">true</span><span class="o">;</span>
<span class="o">}</span>
<span class="cm">/**</span>
<span class="cm"> * Create a EbeanServer instance.</span>
<span class="cm"> */</span>
<span class="kd">private</span> <span class="n">EbeanServer</span> <span class="nf">createEbeanServer</span><span class="o">()</span> <span class="o">{</span>
<span class="n">ServerConfig</span> <span class="n">config</span> <span class="o">=</span> <span class="k">new</span> <span class="n">ServerConfig</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setName</span><span class="o">(</span><span class="s">"pg"</span><span class="o">);</span>
<span class="c1">// load configuration from ebean.properties</span>
<span class="n">config</span><span class="o">.</span><span class="na">loadFromProperties</span><span class="o">();</span>
<span class="n">config</span><span class="o">.</span><span class="na">setDefaultServer</span><span class="o">(</span><span class="kc">true</span><span class="o">);</span>
<span class="o">...</span>
<span class="c1">// other programmatic configuration</span>
<span class="k">return</span> <span class="n">EbeanServerFactory</span><span class="o">.</span><span class="na">create</span><span class="o">(</span><span class="n">config</span><span class="o">);</span>
<span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
</div>
</div>
<div class="col-md-3" role="complementary">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm">
<ul class="nav bs-docs-sidenav">
<li >
<a href="/docs/setup/enhancement">Enhancement</a>
</li>
<li >
<a href="/docs/setup/eclipse-apt">Eclipse IDE - APT</a>
</li>
<li >
<a href="/docs/setup/logging">Logging</a>
</li>
<li >
<a href="/docs/setup/serverconfig">ServerConfig</a>
</li>
<li >
<a href="/docs/setup/guice">Guice</a>
</li>
<li class="active">
<a href="/docs/setup/spring">Spring</a>
<ul class="nav">
<li><a href="#spring-boot">Spring boot</a></li>
<li><a href="#ebean-spring">ebean-spring</a></li>
<li><a href="#factory">FactoryBean</a></li>
</ul>
</li>
<li >
<a href="/docs/setup/activerecord">Active Record</a>
</li>
<li >
<a href="/docs/setup/ddl-create-all">DDL - Create All</a>
</li>
<li >
<a href="/docs/setup/dbmigration">DDL - DB Migration</a>
</li>
<li >
<a href="/docs/setup/test-properties"> Test properties</a>
</li>
<li >
<a href="/docs/setup/testing">Testing</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<!-- /.row -->
</div> <!-- /.container -->
</div>
</div>
<footer id="footer">
<div class="doc-footer">
<ul class="doc-footer-links">
<li><a href="/">Ebean ORM</a></li>
<li> | </li>
<li><a href="http://avaje-metric.github.io">Metrics</a></li>
</ul>
</div>
</footer>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/json2.js"></script>
<script src="/js/jquery.cookie.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-75181644-1', 'auto');
ga('send', 'pageview');
</script> </body>
</html>