-
Notifications
You must be signed in to change notification settings - Fork 7
Expand file tree
/
Copy pathjson.html
More file actions
221 lines (187 loc) · 8.51 KB
/
json.html
File metadata and controls
221 lines (187 loc) · 8.51 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
<!DOCTYPE html>
<html lang="en">
<head>
<title>Features</title>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script async defer src="https://buttons.github.io/buttons.js"></script>
<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 ><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/13">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 ><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/13">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><span class="sep"> / </span><a href="/docs/features/">Features</a><span class="sep"> / </span><span class="last">JSON Marshalling</span></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="bs-docs-section">
<h2 id="overview">Overview</h2>
<p>
Ebean has built in support for marshalling and unmarshalling entity beans to and from JSON.
Ebean uses <code>Jackson core</code> to do this. The reason Ebean does this is treat
JSON as a first class feature with built in support for <code>Partial objects</code> and
<code>cyclical relationships</code> which are both common in ORM. In additional all
supported types including <code>Joda types</code>, <code>Java8 types</code> and
<a href="/docs/features/json-in-db"><code>JSON database mapping types</code></a> work out of the box.
</p>
<blockquote>
JSON marshalling/unmarshalling should be painless, performant and work out of the box.
</blockquote>
<h2 id="json-context">JsonContext</h2>
<p>
Obtain a <code>JsonContext</code> from Database via the <code>json()</code> method.
This JsonContext then provides various methods for marshalling/unmarshalling JSON to and from
entity beans.
</p>
<div class="syntax java"><div class="highlight"><pre><span></span><span class="n">String</span> <span class="n">jsonWithUnknown</span> <span class="o">=</span> <span class="s">"{\"id\":42, \"unknownProp\":\"foo\", \"name\":\"rob\", \"version\":1}"</span><span class="o">;</span>
<span class="n">Customer</span> <span class="n">customer</span> <span class="o">=</span> <span class="n">DB</span><span class="o">.</span><span class="na">json</span><span class="o">().</span><span class="na">toBean</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">jsonWithUnknown</span><span class="o">);</span>
<span class="n">assertEquals</span><span class="o">(</span><span class="n">Integer</span><span class="o">.</span><span class="na">valueOf</span><span class="o">(</span><span class="mi">42</span><span class="o">),</span> <span class="n">customer</span><span class="o">.</span><span class="na">getId</span><span class="o">());</span>
<span class="n">assertEquals</span><span class="o">(</span><span class="s">"rob"</span><span class="o">,</span> <span class="n">customer</span><span class="o">.</span><span class="na">getName</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/features/elasticsearch">ElasticSearch</a>
</li>
<li >
<a href="/docs/features/history">History SQL2011</a>
</li>
<li >
<a href="/docs/features/json-in-db">JSON in DB</a>
</li>
<li class="active">
<a href="/docs/features/json">JSON</a>
</li>
<li >
<a href="/docs/features/eventlistening">Event listening</a>
</li>
<li >
<a href="/docs/features/softdelete">Soft Delete</a>
</li>
<li >
<a href="/docs/features/who">Who Created Modified</a>
</li>
<li >
<a href="/docs/features/readauditing">Read Auditing</a>
</li>
<li >
<a href="/docs/features/changelog">Change Log</a>
</li>
<li >
<a href="/docs/features/draftable">Draftable</a>
</li>
<li >
<a href="/docs/features/l2cache">L2 caching</a>
</li>
<li >
<a href="/docs/features/jvmlanguages">JVM Languages</a>
</li>
<li >
<a href="/docs/features/monitoring">Monitoring</a>
</li>
<li >
<a href="/docs/setup/dbmigration">DB Migration</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>