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-finder.html
More file actions
293 lines (253 loc) · 12.2 KB
/
java-finder.html
File metadata and controls
293 lines (253 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
291
292
293
<!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> / Finder</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>Finder</h2>
<div class="alert alert-info">
We can use the <code>ebeaninit</code> command line tool to generate Finders for us.
</div>
<p>
We can create and use a Finder for each of our entity beans, for example a CustomerFinder for the Customer
entity bean. We do this to organise our code grouping all the "finder logic" for a given bean type into
it's finder (so that everyone knows where it is).
</p>
<h4>e.g. CustomerFinder</h4>
<p>
A CustomerFinder generated by the <code>ebeaninit</code> command line tool.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="kn">package</span> <span class="nn">org.example.domain.finder</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">io.ebean.Finder</span><span class="o">;</span>
<span class="kn">import</span> <span class="nn">org.example.domain.Customer</span><span class="o">;</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">CustomerFinder</span> <span class="kd">extends</span> <span class="n">Finder</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="cm">/**</span>
<span class="cm"> * Construct using the default EbeanServer.</span>
<span class="cm"> */</span>
<span class="kd">public</span> <span class="nf">CustomerFinder</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="o">}</span>
<span class="o">}</span>
</pre></div>
</div>
<p>
When we generate Finders these are also linked to the entity via a public field.
We can use <code>ebean-mocker</code> when we want to mock or stub the finders for
testing purposes.
</p>
<h4>Linked CustomerFinder</h4>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="o">...</span>
<span class="nd">@Entity</span>
<span class="kd">public</span> <span class="kd">class</span> <span class="nc">Customer</span> <span class="kd">extends</span> <span class="n">BaseModel</span> <span class="o">{</span>
<span class="c1">// finder linked as a public static field</span>
<span class="kd">public</span> <span class="kd">static</span> <span class="kd">final</span> <span class="n">CustomerFinder</span> <span class="n">find</span> <span class="o">=</span> <span class="k">new</span> <span class="n">CustomerFinder</span><span class="o">();</span>
</pre></div>
</div>
<h4>Example Finder use</h4>
<p>
With the CustomerFinder linked as a field to Customer we can then easily use it.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="c1">// find by id</span>
<span class="n">Customer</span> <span class="n">customer</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">byId</span><span class="o">(</span><span class="mi">42L</span><span class="o">);</span>
<span class="c1">// reference bean</span>
<span class="n">Customer</span> <span class="n">refBean</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">ref</span><span class="o">(</span><span class="mi">42L</span><span class="o">);</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span> <span class="o">=</span>
<span class="n">Customer</span><span class="o">.</span><span class="na">find</span>
<span class="o">.</span><span class="na">where</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="s">"Rob"</span><span class="o">)</span>
<span class="o">.</span><span class="na">findList</span><span class="o">();</span>
<span class="c1">// generally it is recommended that we move "find logic" for Customer</span>
<span class="c1">// into the CustomerFinder so instead we should create a "byName" method</span>
<span class="c1">// on CustomerFinder and end up with:</span>
<span class="n">List</span><span class="o"><</span><span class="n">Customer</span><span class="o">></span> <span class="n">customers</span> <span class="o">=</span> <span class="n">Customer</span><span class="o">.</span><span class="na field">find</span><span class="o">.</span><span class="na">byName</span><span class="o">(</span><span class="s">"Rob"</span><span class="o">);</span>
</pre></div>
</div>
<h2>Finder vs Repository</h2>
<p>
We don't have to use Finders to organise our code. The common alternative would be to use the
repository pattern and have a <code>CustomerRepository</code> instead and have all the
"finder logic" for customer in CustomerRepository.
</p>
<div class="alert alert-info">
The recommended approach is to use Model and Finder rather than the Repository pattern.
</div>
<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-finder.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 class="active">
<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>