forked from ebean-orm/ebean-orm.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathjava-repository.html
More file actions
290 lines (247 loc) · 12.2 KB
/
java-repository.html
File metadata and controls
290 lines (247 loc) · 12.2 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
<!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>Getting started | Ebean</title>
<link rel="shortcut icon" href="/images/favicon.ico" >
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.5/css/bootstrap.min.css">
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
<link rel="stylesheet" href="/css/pygments.css" type="text/css" />
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<div id="wrap">
<div id="header">
<div class="navbar" 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/lg5-21x100.png" height="35">
</a>
</div>
<div class="collapse navbar-collapse">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li ><a href="/docs">Docs</a></li>
<li class="active"><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/11">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
<div class="mobile-nav">
<ul class="nav navbar-nav pull-right nav-btn-rhs">
<li ><a href="/"><span class="fas fa-home"></span> Home</a></li>
<li ><a href="/docs">Docs</a></li>
<li class="active"><a href="/docs/getting-started">Get Started</a></li>
<li ><a href="/support">Help</a></li>
<li ><a href="/videos">Videos</a></li>
<li ><a target="_blank" href="/apidoc/11">ApiDocs</a></li>
<li ><a href="/releases">Releases</a></li>
<li><a target="_blank" href="https://github.com/ebean-orm/ebean"> <i class="fab fa-github"></i></a></li>
</ul>
</div>
</div>
</div>
</div>
<div id="main">
<div class="jumbotron mini">
<div class="container">
<h1><a href="/docs/">Documentation</a> / <a href="/docs/getting-started/">Getting started</a> / <a href="/docs/getting-started/java-first-entity">Java</a> / Repository</h1>
</div>
</div>
<div class="container doc-index bs-docs-container">
<div class="row">
<div class="col-md-9" role="main">
<form action="https://www.google.com/search" method="get">
<div class="page-inline-search" style="margin-bottom:8px;">
<div class="input-group">
<input name="q" id="searchinput" type="text" class="form-control" placeholder="Search... (press 's' to focus)" data-placeholder-focus="Search... (use '↑', '↓' and '⏎' to select results)" data-placeholder-blur="Search... (press 's' to focus)" autocomplete="off">
<input type="hidden" name="as_sitesearch" value="ebean.io">
<div class="input-group-btn">
<button class="btn btn-default form-control" type="submit"><i class="glyphicon glyphicon-search"></i></button>
</div>
</div>
<div class="search-results-inline-container" style="display: none;">
<ul id="search-results-container" class="search-results"><li class=" active"><a href="/docs" title="Docs"><span style="color:#777;">Docs</span> Documentation </a></li><li class=""><small style="color:#999;">And 101 more...</small></li></ul>
</div>
</div>
</form>
<div class="pull-right">
<p>Related: <a href="/docs/trouble-shooting">Trouble Shooting</a></p>
</div>
<h2>Repository</h2>
<p>
If we don't want to use <code>Model</code> and <code>Finder</code> then we typically use the
repository pattern. This means we create a repository for each entity bean type and we put
the "finder logic" and "persisting logic" on the repository.
</p>
<p>
Generally we will be using a DI container like <code>Spring</code> or <code>Guice</code>
and our repository classes will be singleton components with constructor injection taking
the EbeanServer instance (that we configure and create using ServerConfig and EbeanServerFactory).
</p>
<h4>e.g. CustomerRepository</h4>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="kn">package</span> <span class="nn">org.example.repository</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">io.ebean.BeanRepository</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.example.domain.Customer</span><span class="o">;</span>
<span class="nd">@Singleton</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">CustomerRepository</span> <span class="kd">extends</span> <span class="n">BeanRepository</span><span class="o"><</span><span class="n">Long</span><span class="o">,</span><span class="n">Customer</span><span class="o">></span> <span class="o">{</span>
<span class="nd">@Inject</span>
<span class="kd">public</span> <span class="nf">CustomerRepository</span><span class="o">(</span><span class="n">EbeanServer</span> <span class="n">server</span><span class="o">)</span> <span class="o">{</span>
<span class="kd">super</span><span class="o">(</span><span class="n">Customer</span><span class="o">.</span><span class="na">class</span><span class="o">,</span> <span class="n">server</span><span class="o">);</span>
<span class="o">}</span>
<span class="c1">// ... add customer specific finders and persist logic</span>
<span class="kd">public</span> <span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="nf">findByName</span><span class="o">(</span><span class="n">String</span> <span class="n">nameStart</span><span class="o">)</span> <span class="o">{</span>
<span class="k">return</span> <span class="n">query</span><span class="o">().</span><span class="na">where</span><span class="o">()</span>
<span class="o">.</span><span class="na">istartsWith</span><span class="o">(</span><span class="s">"name"</span><span class="o">,</span> <span class="n">nameStart</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
<span class="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
Typically we then <code>@Inject</code> the repository where we want to persist or fetch beans.
</p>
<h4>e.g. CustomerService</h4>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="o">...</span>
<span class="nd">@Service</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">OrderService</span> <span class="o">{</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="n">OrderRepository</span> <span class="n">orderRepository</span><span class="o">;</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="n">CustomerRepository</span> <span class="n">customerRepository</span><span class="o">;</span>
<span class="kd">private</span> <span class="kd">final</span> <span class="n">ProductRepository</span> <span class="n">productRepository</span><span class="o">;</span>
<span class="nd">@Inject</span>
<span class="kd">public</span> <span class="nf">OrderService</span><span class="o">(</span><span class="n">OrderRepository</span> <span class="n">orderRepository</span><span class="o">,</span>
<span class="n">CustomerRepository</span> <span class="n">customerRepository</span><span class="o">,</span>
<span class="n">ProductRepository</span> <span class="n">productRepository</span><span class="o">)</span> <span class="o">{</span>
<span class="k">this</span><span class="o">.</span><span class="na">orderRepository</span> <span class="o">=</span> <span class="n">orderRepository</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="na">customerRepository</span> <span class="o">=</span> <span class="n">customerRepository</span><span class="o">;</span>
<span class="k">this</span><span class="o">.</span><span class="na">productRepository</span> <span class="o">=</span> <span class="n">productRepository</span><span class="o">;</span>
<span class="o">}</span>
<span class="o">...</span>
</pre></div>
</div>
<p>
The potential downside to using the repository pattern vs Model and Finder is that we
can sometimes see many repositories injected in some services. When we end up with many
dependencies for a single service this can make constructor injection less appealing.
</p>
<p>
With Model and Finder we tend to end up with simpler / easier code and arguably it is
just as easy to test and mock (using ebean-mocker).
</p>
<div class="next pull-right">
<a href="java-next-steps" class="btn btn-info">Next: Next steps</a>
</div>
<p class="edit-page">
<a href="https://github.com/ebean-orm/website-source/blob/master/docs/getting-started/java-repository.html"><i class="fab fa-github"></i> Edit Page</a>
</p>
</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/getting-started#ide">IDE Plugin</a>
</li>
<li >
<a href="/docs/getting-started/dependencies">Dependencies</a>
</li>
<li >
<a href="/docs/getting-started/maven">Maven</a>
</li>
<li >
<a href="/docs/getting-started/maven-querybeans">Maven Query beans</a>
</li>
<li >
<a href="/docs/getting-started/gradle">Gradle</a>
</li>
<li >
<a href="/docs/getting-started/gradle-querybeans">Gradle Query beans</a>
</li>
<li >
<a href="/docs/getting-started/cli-tool">CLI Tool</a>
</li>
<li><b>Java</b></li>
<li >
<a href="/docs/getting-started/java-first-entity">First entity</a>
</li>
<li >
<a href="/docs/getting-started/java-constructors">Constructors</a>
</li>
<li >
<a href="/docs/getting-started/java-mapped-superclass">MappedSuperclass</a>
</li>
<li >
<a href="/docs/getting-started/java-model">Model</a>
</li>
<li >
<a href="/docs/getting-started/java-finder">Finder</a>
</li>
<li >
<a href="/docs/getting-started/java-next-steps">Next steps</a>
</li>
<li><b>Kotlin</b></li>
<li >
<a href="/docs/getting-started/kotlin-first-entity">First entity</a>
</li>
<li >
<a href="/docs/getting-started/kotlin-constructors">Constructors</a>
</li>
<li >
<a href="/docs/getting-started/kotlin-mapped-superclass">MappedSuperclass</a>
</li>
<li >
<a href="/docs/getting-started/kotlin-model">Model</a>
</li>
<li >
<a href="/docs/getting-started/kotlin-finder">Finder</a>
</li>
<li >
<a href="/docs/getting-started/kotlin-next-steps">Next steps</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
</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 type="text/javascript">
var categoryNames = {};
</script>
<script src="https://code.jquery.com/jquery-3.3.1.min.js"></script>
<script src="/js/bootstrap.min.js"></script>
<script src="/js/jquery.easing.min.js"></script>
<script src="/js/jquery.storageapi.min.js"></script>
<script src="/js/ebean-site.js"></script>
<script src="/js/extra.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>