Support for JSON Binding API (JSON-B)

Issue: SPR-14923

Author: jhoeller

build.gradle

@@ -735,6 +735,7 @@ project("spring-web") {
 		optional("com.fasterxml.jackson.dataformat:jackson-dataformat-smile:${jackson2Version}")
 		optional("com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:${jackson2Version}")
 		optional("com.google.code.gson:gson:${gsonVersion}")
+		optional("javax.json.bind:javax.json.bind-api:1.0.0-M1")
 		optional("com.rometools:rome:${romeVersion}")
 		optional("org.eclipse.jetty:jetty-servlet:${jettyVersion}") {
 			exclude group: "javax.servlet", module: "javax.servlet-api"

spring-web/src/main/java/org/springframework/http/converter/json/JsonbHttpMessageConverter.java

@@ -0,0 +1,109 @@
+/*
+ * Copyright 2002-2017 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.springframework.http.converter.json;
+
+import java.io.Reader;
+import java.io.Writer;
+import java.lang.reflect.Type;
+import javax.json.bind.Jsonb;
+import javax.json.bind.JsonbBuilder;
+import javax.json.bind.JsonbConfig;
+
+import org.springframework.util.Assert;
+
+/**
+ * Implementation of {@link org.springframework.http.converter.HttpMessageConverter}
+ * that can read and write JSON using the
+ * <a href="http://json-b.net/">JSON Binding API</a>.
+ *
+ * <p>This converter can be used to bind to typed beans or untyped {@code HashMap}s.
+ * By default, it supports {@code application/json} and {@code application/*+json} with
+ * {@code UTF-8} character set.
+ *
+ * @author Juergen Hoeller
+ * @since 5.0
+ * @see javax.json.bind.Jsonb
+ * @see javax.json.bind.JsonbBuilder
+ * @see #setJsonb
+ */
+public class JsonbHttpMessageConverter extends AbstractJsonHttpMessageConverter {
+
+	private Jsonb jsonb;
+
+
+	/**
+	 * Construct a new {@code JsonbHttpMessageConverter} with default configuration.
+	 */
+	public JsonbHttpMessageConverter() {
+		this(JsonbBuilder.create());
+	}
+
+	/**
+	 * Construct a new {@code JsonbHttpMessageConverter} with the given configuration.
+	 * @param config the {@code JsonbConfig} for the underlying delegate
+	 */
+	public JsonbHttpMessageConverter(JsonbConfig config) {
+		this(JsonbBuilder.create(config));
+	}
+
+	/**
+	 * Construct a new {@code JsonbHttpMessageConverter} with the given delegate.
+	 * @param jsonb the Jsonb instance to use
+	 */
+	public JsonbHttpMessageConverter(Jsonb jsonb) {
+		setJsonb(jsonb);
+	}
+
+
+	/**
+	 * Set the {@code Jsonb} instance to use.
+	 * If not set, a default {@code Jsonb} instance will be created.
+	 * <p>Setting a custom-configured {@code Jsonb} is one way to take further
+	 * control of the JSON serialization process.
+	 * @see #JsonbHttpMessageConverter(Jsonb)
+	 * @see #JsonbHttpMessageConverter(JsonbConfig)
+	 * @see JsonbBuilder
+	 */
+	public void setJsonb(Jsonb jsonb) {
+		Assert.notNull(jsonb, "A Jsonb instance is required");
+		this.jsonb = jsonb;
+	}
+
+	/**
+	 * Return the configured {@code Jsonb} instance for this converter.
+	 */
+	public Jsonb getJsonb() {
+		return this.jsonb;
+	}
+
+
+	@Override
+	protected Object readInternal(Type resolvedType, Reader reader) throws Exception {
+		return getJsonb().fromJson(reader, resolvedType);
+	}
+
+	@Override
+	protected void writeInternal(Object o, Type type, Writer writer) throws Exception {
+		if (type != null) {
+			getJsonb().toJson(o, type, writer);
+		}
+		else {
+			getJsonb().toJson(o, writer);
+		}
+	}
+
+}

spring-web/src/main/java/org/springframework/http/converter/support/AllEncompassingFormHttpMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 the original author or authors.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,6 +18,7 @@
 
 import org.springframework.http.converter.FormHttpMessageConverter;
 import org.springframework.http.converter.json.GsonHttpMessageConverter;
+import org.springframework.http.converter.json.JsonbHttpMessageConverter;
 import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 import org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter;
 import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
@@ -51,6 +52,9 @@ public class AllEncompassingFormHttpMessageConverter extends FormHttpMessageConv
 	private static final boolean gsonPresent =
 			ClassUtils.isPresent("com.google.gson.Gson", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
 
+	private static final boolean jsonbPresent =
+			ClassUtils.isPresent("javax.json.bind.Jsonb", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
+
 
 	public AllEncompassingFormHttpMessageConverter() {
 		addPartConverter(new SourceHttpMessageConverter<>());
@@ -65,6 +69,9 @@ public AllEncompassingFormHttpMessageConverter() {
 		else if (gsonPresent) {
 			addPartConverter(new GsonHttpMessageConverter());
 		}
+		else if (jsonbPresent) {
+			addPartConverter(new JsonbHttpMessageConverter());
+		}
 
 		if (jackson2XmlPresent) {
 			addPartConverter(new MappingJackson2XmlHttpMessageConverter());

spring-web/src/main/java/org/springframework/web/client/RestTemplate.java

@@ -44,6 +44,7 @@
 import org.springframework.http.converter.feed.AtomFeedHttpMessageConverter;
 import org.springframework.http.converter.feed.RssChannelHttpMessageConverter;
 import org.springframework.http.converter.json.GsonHttpMessageConverter;
+import org.springframework.http.converter.json.JsonbHttpMessageConverter;
 import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
 import org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter;
 import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
@@ -143,6 +144,9 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
 	private static final boolean gsonPresent =
 			ClassUtils.isPresent("com.google.gson.Gson", RestTemplate.class.getClassLoader());
 
+	private static final boolean jsonbPresent =
+			ClassUtils.isPresent("javax.json.bind.Jsonb", RestTemplate.class.getClassLoader());
+
 
 	private final List<HttpMessageConverter<?>> messageConverters = new ArrayList<>();
 
@@ -182,6 +186,9 @@ else if (jaxb2Present) {
 		else if (gsonPresent) {
 			this.messageConverters.add(new GsonHttpMessageConverter());
 		}
+		else if (jsonbPresent) {
+			this.messageConverters.add(new JsonbHttpMessageConverter());
+		}
 
 		if (jackson2SmilePresent) {
 			this.messageConverters.add(new MappingJackson2SmileHttpMessageConverter());