Java EE 8 JSON Support with JsonParser Streaming API
•
5 j'aime•2,394 vues
The document discusses JSON support in Java EE 8, including a JSON processing API and JSON binding API. The JSON processing API allows parsing, generating, transforming and querying of JSON through a streaming parser and generator similar to StAX. The JSON binding API allows binding of JSON documents to Java objects similarly to JAXB. The document then focuses on the JSON parser, describing how it can be used to parse a sample JSON document into a stream of parsing events.
Contenu connexe
Tendances
Tendances (20)
Similaire à Java EE 8 JSON Support with JsonParser Streaming API
Similaire à Java EE 8 JSON Support with JsonParser Streaming API (20)
Dernier
Dernier (20)
Java EE 8 JSON Support with JsonParser Streaming API
- 3. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 3 Lukas Jungmann • So#ware Developer @ Oracle • JSON-B (JSR-367) EG member • JSON-P (JSR-374) EG member • JPA (JSR-338) Spec lead • EclipseLink project commiJer
- 6. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JSON Support in Java EE 8 • JSON Processing API – Standard API to parse, generate, transform, query JSON – Object Model and Streaming API • similar to DOM and StAX • JSON Binding API – Binding JSON documents to Java objects • similar to JAXB 6
- 8. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JsonParser • JsonParser – Parses JSON in a streaming way from input sources – Similar to StAX’s XMLStreamReader, a pull parser • Created using: • Json.createParser(…), Json.createParserFactory().createParser(…) • OpSonally, configured with features • Parser state events: – START_ARRAY, START_OBJECT, KEY_NAME, VALUE_STRING, VALUE_NUMBER, VALUE_TRUE, VALUE_FALSE, VALUE_NULL, END_OBJECT, END_ARRAY 8
- 9. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 9 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 10. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 10 JsonParser START_OBJECT!{! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 11. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 11 JsonParser START_OBJECT! KEY_NAME! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 12. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 12 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 13. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 13 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 14. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 14 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 15. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 15 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 16. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 16 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 17. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 17 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 18. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 18 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! KEY_NAME, KEY_STRING! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 19. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 19 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! KEY_NAME, KEY_STRING! KEY_NAME, KEY_STRING! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 20. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 20 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! KEY_NAME, KEY_STRING! KEY_NAME, KEY_STRING! END_OBJECT! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 21. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 21 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! KEY_NAME, KEY_STRING! KEY_NAME, KEY_STRING! END_OBJECT! END_ARRAY! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 22. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 22 JsonParser START_OBJECT! KEY_NAME! VALUE_STRING! KEY_NAME! VALUE_NUMBER! KEY_NAME! START_ARRAY! START_OBJECT! KEY_NAME, KEY_STRING! KEY_NAME, KEY_STRING! END_OBJECT! END_ARRAY! END_OBJECT! {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }!
- 23. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 23 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! !
- 24. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 24 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! !
- 25. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 25 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! !
- 26. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 26 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! !
- 27. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 27 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! !
- 28. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 28 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! parser.getString(); // John Doe! !
- 29. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 29 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! parser.getString(); // John Doe! parser.next(); // KEY_NAME! !
- 30. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 30 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! parser.getString(); // John Doe! parser.next(); // KEY_NAME! parser.getString(); // age! !
- 31. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 31 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! parser.getString(); // John Doe! parser.next(); // KEY_NAME! parser.getString(); // age! parser.next(); // VALUE_NUMBER! !
- 32. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 32 JsonParser {! "name": ! "John Doe", ! "age": ! 35,! "phoneNumbers": ! [! { ! "type": "home", ! "number": "123-456-789" ! } ! ]! }! JsonParser p = Json.createParser(...);! Event e = p.next(); // START_OBJECT ! parser.next(); // KEY_NAME! parser.getString(); // name! parser.next(); // VALUE_STRING! parser.getString(); // John Doe! parser.next(); // KEY_NAME! parser.getString(); // age! parser.next(); // VALUE_NUMBER! parser.getInt (); // 35! ! !
- 33. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JsonGenerator • Generates JSON in a streaming way to output sources – Similar to StAX’s XMLStreamWriter • Created using: – Json.createGenerator(…) – Json.createGeneratorFactory().createGenerator(…) • OpSonally, configured with features – e.g. preny prinSng • Allows method chaining 33
- 34. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 34 JsonGenerator JsonGenerator ge=Json.createGenerator(…);! ge.writeStartArray()! .writeStartObject()! .write("type", "home”)! .write("number", "123-456-789")! .writeEnd()! .writeStartObject()! .write("type", "fax”)! .write("number", "123-456-790")! .writeEnd()! .writeEnd()! .close();! [! {! "type": "home”,! "number": "123-456-789"! },! {! "type": "fax”,! "number": "123-456-790"! }! ]!
- 35. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Object Model API • Builder to build JsonObject and JsonArray from scratch • Allows method chaining • Type-safe (cannot mix array and object building methods) • Can also use exisSng JsonObject and JsonArray in a builder 35
- 36. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 36 Object Model API JsonArray value = Json.createArrayBuilder()! .add(Json.createObjectBuilder()! .add("type", "home")! .add("number", "123-456-789")! )! .add(Json.createObjectBuilder()! .add("type", "fax")! .add("number", "123-456-790")! )! .build();! [! {! "type": "home”,! "number": "123-456-789"! },! {! "type": "fax”,! "number": "123-456-790"! }! ]!
- 37. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JSON-P 1.1 • Update JSON-P spec to stay current with emerging standards (RFC 7159) • Support for IETF standards on – JSON Pointer (RFC 6901) – JSON Patch (RFC 6902) – JSON Merge Patch (RFC 7396) • Add ediSng/transformaSon operaSons to JSON objects and arrays • Support for a streaming API, together with Collectors • Support for processing big JSON, e.g. add filters to JSON parsing. 37
- 38. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JsonPointer • IETF RFC 6901 • String syntax for idenSfying a specific value – /phone/mobile – /parents/0 • Special characters – "/" —> "~1" – "~" —> "~0" • Absolute 38
- 39. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JSON Pointer Sample JsonArray dogs = . . .;! JsonPointer pointer = ! Json.createPointer("/1/breed");! JsonValue breed = ! pointer.getValue(dogs);! p.replace(dogs, ! Json.createValue("English Bulldog"));! 39 [! { ! "name": "Cassidy",! "breed": "English Bulldog",! "age": 6! },! { ! "name": "Falco",! "breed": "Pug",! "age": 4! }! ]!
- 40. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JsonPatch • IETF RFC 6902 • Modify Parts of JSON document • Patch is a JSON document itself • OperaSons: – Add, replace, remove, move, copy, test • HTTP PATCH method (applicaSon/json-patch+json) 40
- 41. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 41 JSON Patch Sample [! { "op": "replace",! "path": "/1/breed",! "value": "English Bulldog" },! { "op": "remove",! "path": "/2" }! ]! [! { ! "name": "Cassidy",! "breed": "English Bulldog",! "age": 6! },! { ! "name": "Falco",! "breed": "Pug",! "age": 4! },! { ! "name": "Funes",! "breed": "Frenchie",! "age": 2! }! ]!
- 42. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 42 JSON Patch Sample [! { "op": "replace",! "path": "/1/breed",! "value": "English Bulldog" },! { "op": "remove",! "path": "/2" }! ]! [! { ! "name": "Cassidy",! "breed": "English Bulldog",! "age": 6! },! { ! "name": "Falco",! "breed": "English Bulldog",! "age": 4! },! { ! "name": "Funes",! "breed": "Frenchie",! "age": 2! }! ]!
- 43. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 43 JSON Patch Sample [! { "op": "replace",! "path": "/1/breed",! "value": "English Bulldog" },! { "op": "remove",! "path": "/2" }! ]! [! { ! "name": "Cassidy",! "breed": "English Bulldog",! "age": 6! },! { ! "name": "Falco",! "breed": "English Bulldog",! "age": 4! }! ]!
- 45. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JSON Binding • API to serialize/deserialize Java objects to/from JSON documents – Similar to JAX-B – Standardizes the current technologies (Jackson, Genson, Gson) • Default mapping between classes and JSON • CustomizaSon APIs – AnnotaSons (@JsonbProperty, @JsonbNillable) – RunSme configuraSon builder • Natural follow on to JSON-P – Closes the JSON support gap – Allows to change providers 45
- 46. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • No configuraSon, no annotaSons • The scope: – Basic Types – Specific JDK Types – Dates – Classes – CollecSons/Arrays – EnumeraSons – JSON-P 46 Default Mapping import javax.json.bind.Jsonb;! import javax.json.bind.JsonbBuilder;! ! // Create with default config! Jsonb jsonb = JsonbBuilder.create();!
- 47. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 47 JSON-B Engine public interface Jsonb extends AutoCloseable {! <T> T fromJson(String str, Class<T> type);! <T> T fromJson(String str, Type runtimeType);! <T> T fromJson(Reader reader, Class<T> type);! <T> T fromJson(Reader reader, Type runtimeType);! <T> T fromJson(InputStream stream, Class<T> type);! <T> T fromJson(InputStream stream, Type runtimeType);! ! String toJson(Object object);! String toJson(Object object, Type runtimeType);! void toJson(Object object, Writer writer);! void toJson(Object object, Type runtimeType, Writer writer);! void toJson(Object object, OutputStream stream);! void toJson(Object object, Type runtimeType, OutputStream stream);! }!
- 48. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | JSON-B Sample 48 Dog dog1 = new Dog();! dog1.setName("Cassidy");! dog1.setBreed("English Bulldog");! dog1.setAge(6);! ! Dog dog2 = new Dog();! dog2.setName("Falco");! dog2.setBreed("English Bulldog");! dog2.setAge(4);! ! List<Dog> dogs = new ArrayList<>();! dogs.add(dog1);! dogs.add(dog2);! ! Jsonb jsonb = JsonbBuilder.create();! jsonb.toJson(dogs);! [! { ! "name": "Cassidy",! "breed": "English Bulldog",! "age": 6! },! { ! "name": "Falco",! "breed": "English Bulldog",! "age": 4! }! ]!
- 50. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Date/Time 50 java.uSl.Date ISO_DATE_TIME java.uSl.Calendar, java.uSl.GregorianCalendar ISO_DATE if to Sme informaSon present, otherwise ISO_DATE_TIME Java.uSl.TimeZone, java.uSl.SimpleTimeZone NormalizedCustomId (see TimeZone javadoc) java.Sme.Instant ISO_INSTANT java.Sme.LocalDate ISO_LOCAL_DATE java.Sme.LocalTime ISO_LOCAL_TIME java.Sme.LocalDateTime ISO_LOCAL_DATE_TIME java.Sme.ZonedDateTime ISO_ZONED_DATE_TIME java.Sme.OffsetDateTime ISO_OFFSET_DATE_TIME java.Sme.OffsetTime ISO_OFFSET_TIME java.Sme.ZoneId NormalizedZoneId as specified in ZoneId javadoc java.Sme.ZoneOffset NormalizedZoneId as specified in ZoneOffset javadoc java.Sme.DuraSon ISO 8601 seconds based representaSon java.Sme.Period ISO 8601 period representaSon
- 51. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Date/Time Samples 51 // java.util.Date! SimpleDateFormat sdf = new SimpleDateFormat("dd.MM.yyyy");! Date parsedDate = sdf.parse("25.10.2015");! jsonb.toJson(parsedDate); // ”2015-10-25T00:00:00"! ! // java.util.Calendar! Calendar dateCalendar = Calendar.getInstance();! dateCalendar.clear();! dateCalendar.set(2015, 10, 25);! jsonb.toJson(dateCalendar); // ”2015-10-25”! ! // java.time.Instant! jsonb.toJson(Instant.parse("2015-10-25T23:00:00Z")); // ”2015-10-25T23:00:00Z”! ! // java.time.Duration! jsonb.toJson(Duration.ofHours(5).plusMinutes(4)); // “PT5H4M"! ! // java.time.Period! jsonb.toJson(Period.between(! LocalDate.of(1960, Month.JANUARY, 1),! LocalDate.of(1970, Month.JANUARY, 1))); // "P10Y"!
- 52. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Arrays/CollecSons • CollecSon • Map • Set • HashSet • NavigableSet • SortedSet • TreeSet • LinkedHashSet • TreeHashSet • HashMap • NavigableMap • SortedMap • TreeMap • LinkedHashMap • TreeHashMap • List • ArrayList • LinkedList • Deque • ArrayDeque • Queue • PriorityQueue • EnumSet • EnumMap 52
- 53. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • javax.json.JsonArray • javax.json.JsonStructure • javax.json.JsonValue • javax.json.JsonPointer • javax.json.JsonString • javax.json.JsonNumber • javax.json.JsonObject 53 JSON-P Types // JsonObject! JsonBuilderFactory f = ! Json.createBuilderFactory(null);! ! JsonObject jsonObject = ! f.createObjectBuilder()! .add(“name", "Jason")! .add(“city", "Prague")! .build();! ! jsonb.toJson(jsonObject); !
- 54. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Classes • Public and protected nested and staMc nested classes • Anonymous classes (serializaSon only) • Inheritance is supported • Default no-argument constructor is required for deserializaSon 54
- 55. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | Fields • Final fields are serialized • StaMc fields are skipped • Transient fields are skipped • Null fields are skipped • Fields order – Lexicographical order – Parent class fields are serialized before child class fields 55
- 56. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | public class Parent {! public int parentB;! public int parentA;! }! {! "parentA": 1,! "parentB": 2! } ! 56 Fields Order Sample
- 57. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | public class Parent {! public int parentB;! public int parentA;! }! ! public class Child extends Parent {! public int childB;! public int childA;! }! {! "parentA": 1,! "parentB": 2! } ! ! {! "parentA": 1,! "parentB": 2,! ! "childA": 3,! "childB": 4! }! 57 Fields Order Sample
- 58. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | SerializaMon • ExisSng fields with public geners • Public fields with no geners • Public gener/sener pair without a corresponding field • DeserializaMon • ExisSng fields with public seners • Public fields with no seners • Public gener/sener pair without a corresponding field 58 Scope and Field Access Strategy
- 59. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | public class Foo {! public final int publicFinalField;! private final int privateFinalField;! ! public static int publicStaticField; ! ! public int publicWithNoGetter;! public int publicWithPrivateGetter;! public Integer publicNullField = null;! ! private int privateWithNoGetter;! private int privateWithPublicGetter;! ! public int getNoField() {};! public void setNoField(int value) {};! }! { ! "publicFinalField": 1,! ! ! ! ! "publicWithNoGetter": 1,! ! ! ! ! "privateWithPublicGetter": 1,! ! "noField": 1! }! 59 Scope and Field Access Strategy
- 60. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • AnnotaSons • RunSme configuraSon – JsonbConfig – JsonbBuilder 60 JSON-B Engine ConfiguraSon JsonbConfig config = new JsonbConfig()! .withFormatting(…)! .withNullValues(…)! .withEncoding(…)! .withStrictIJSON(…)! .withPropertyNamingStrategy(…)! .withPropertyOrderStrategy(…)! .withPropertyVisibilityStrategy(…)! .withAdapters(…)! .withBinaryDataStrategy(…);! ! Jsonb jsonb = JsonbBuilder.newBuilder()! .withConfig(…)! .withProvider(…)! .build();! !
- 61. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | 61 CustomizaSons • Property names • Property order • Ignoring properSes • Null handling • Custom instanSaSon • Fields visibility • Adapters • Date/Number Formats • Binary Encoding
- 62. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • AnnotaSon – @JsonbProperty • Scope: – Field – Gener/Sener – Parameter 62 Property Names public class Customer {! private int id;! ! @JsonbProperty("name")! private String firstName;! }! ! public class Customer {! public int id;! public String firstName;! ! @JsonbProperty("name")! public String getFirstName() {! return firstName;! }! }! !
- 64. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • Strategies: – LEXICOGRAPHICAL (A-Z) – ANY – REVERSE (Z-A) • AnnotaSon – @JsonbPropertyOrder on class • JsonbConfig – withPropertyOrderStrategy(…) 64 Property Order Strategy @JsonbPropertyOrder(ANY)! public class Foo {! public int bar2;! public int bar1;! }!
- 65. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • AnnotaSon – @JsonbTransient 65 Ignoring ProperSes public class Customer {! public int id;! public String name;! ! @JsonbTransient! public BigDecimal salary;! }!
- 66. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • PropertyVisibilityStrategy interface • AnnotaSon – @JsonbVisibility • JsonbConfig – withPropertyVisibilityStrategy(…) 66 Property Visibility public interface PropertyVisibilityStrategy {! boolean isVisible(Field field);! boolean isVisible(Method method);! }! ! public class MuStrategy implements! PropertyVisibilityStrategy {! /* ... */! }! ! @JsonbVisibility(MyStrategy.class)! public class Bar {! private int field1;! private int field2;! }! ! !
- 67. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • Null fields are skipped by default • AnnotaSon – @JsonbNillable • JsonbConfig – withNullValues(true) 67 Null Handling public class Customer {! public int id = 1;! ! @JsonbNillable! public String name = null;! }! ! @JsonbNillable! public class Customer {! public int id = 1;! public String name = null;! }!
- 68. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | public class Customer {! public int id;! public String name;! ! @JsonbCreator! public static Customer getFromDb(int id) {! return CustomerDao.getByPrimaryKey(id);! }! }! ! public class Order {! public int id;! public Customer customer;! }! ! ! ! ! ! ! ! ! ! ! {! "id": 123,! "customer": {! "id": 562,! }! } ! ! 68 Custom InstanSaSon
- 69. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • AnnotaSons – @JsonbDateFormat – @JsonbNumberFormat • JsonbConfig – withDateFormat(…) – withLocale(…) 69 Date/Number Format public class FormatSample { ! public Date defaultDate; ! ! @JsonbDateFormat("dd.MM.yyyy")! public Date formattedDate; ! ! public BigDecimal defaultNumber; ! ! @JsonbNumberFormat(“#0.00")! public BigDecimal formattedNumber; ! }!
- 70. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • Supported encodings – BYTE (default) – BASE_64 – BASE_64_URL • JsonbConfig – withBinaryDataStrategy(…) 70 Binary Data Encoding JsonbConfig config = new JsonbConfig()! .withBinaryDataStrategy(! BinaryDataStrategy.BASE_64);! ! Jsonb jsonb = JsonbBuilder.create(config);! String json = jsonb.toJson(obj);! ! !
- 72. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • Inspired by JAXB • AnnotaSons – @JsonbTypeAdapter annotaSon • JsonbConfig – withAdapters(…) 72 Adapters public interface JsonbAdapter<Original, Adapted> {! Adapted adaptToJson(Original obj);! Original adaptFromJson(Adapted obj);! }! ! @JsonbTypeAdapter(AnimalAdapter.class)! public Animal animal;! ! JsonbConfig config = new JsonbConfig()! .withAdapters(new AnimalAdapter());! ! !
- 73. Copyright © 2016, Oracle and/or its affiliates. All rights reserved. | • Low level control on serializaSon/deserializaSon • AnnotaSons – @JsonbTypeSerializer – @JsonbTypeDeserializer • JsonbConfig – withSerializers(…) – withDeserializers(…) 73 Serializers/Deserializers public interface JsonbSerializer<T> {! void serialize(T obj, JsonGenerator generator,! SerializationContext ctx);! ! public interface JsonbDeserializer<T> {! T deserialize(JsonParser parser, ! DeserializationContext ctx, Type rtType);! }! ! @JsonbTypeSerializer(AnimalSerializer.class)! @JsonbTypeDeserializer(AnimalDeserializer.class) ! public Animal animal;! ! JsonbConfig config = new JsonbConfig()! .withSerializers(new AnimalSerializer())! .withDeserializers(new AnimalDeserializer());! ! !