Skip to content

Commit e8530c9

Browse files
sdeleuzesdeleuze
committed
Add Smile and CBOR Jackson data formats support
This commit adds Smile and CBOR Jackson HttpMessageConverters and make it possible to create Smile and CBOR ObjectMapper via Jackson2ObjectMapperBuilder, which now allows to specify any custom JsonFactory. Like with JSON and XML Jackson support, the relevant HttpMessageConverters are automaticially configurered by Spring MVC WebMvcConfigurationSupport if jackson-dataformat-smile or jackson-dataformat-cbor dependencies are found in the classpath. Issue: SPR-14435
1 parent c399b4b commit e8530c9

File tree

14 files changed

+487
-2
lines changed

14 files changed

+487
-2
lines changed

‎build.gradle‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,8 @@ project("spring-web") {
733733
optional("com.squareup.okhttp3:okhttp:${okhttp3Version}")
734734
optional("com.fasterxml.jackson.core:jackson-databind:${jackson2Version}")
735735
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-xml:${jackson2Version}")
736+
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-smile:${jackson2Version}")
737+
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:${jackson2Version}")
736738
optional("com.google.code.gson:gson:${gsonVersion}")
737739
optional("com.rometools:rome:${romeVersion}")
738740
optional("org.eclipse.jetty:jetty-servlet:${jettyVersion}") {
@@ -855,6 +857,8 @@ project("spring-webmvc") {
855857
optional("com.lowagie:itext:2.1.7")
856858
optional("com.fasterxml.jackson.core:jackson-databind:${jackson2Version}")
857859
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-xml:${jackson2Version}")
860+
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-smile:${jackson2Version}")
861+
optional("com.fasterxml.jackson.dataformat:jackson-dataformat-cbor:${jackson2Version}")
858862
optional("com.rometools:rome:${romeVersion}")
859863
optional("javax.el:javax.el-api:${elApiVersion}")
860864
optional("org.apache.tiles:tiles-api:${tiles3Version}")

‎spring-web/src/main/java/org/springframework/http/converter/cbor/MappingJackson2CborHttpMessageConverter.java‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
/*
2+
* Copyright 2002-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.http.converter.cbor;
18+
19+
import com.fasterxml.jackson.databind.ObjectMapper;
20+
import com.fasterxml.jackson.dataformat.cbor.CBORFactory;
21+
22+
import org.springframework.http.MediaType;
23+
import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter;
24+
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
25+
import org.springframework.util.Assert;
26+
27+
/**
28+
* Implementation of {@link org.springframework.http.converter.HttpMessageConverter HttpMessageConverter}
29+
* that can read and write <a href="http://cbor.io/">CBOR</a> data format using
30+
* <a href="https://github.com/FasterXML/jackson-dataformats-binary/tree/master/cbor">
31+
* the dedicated Jackson 2.x extension</a>.
32+
*
33+
* <p>By default, this converter supports {@code "application/cbor"} media type. This can be
34+
* overridden by setting the {@link #setSupportedMediaTypes supportedMediaTypes} property.
35+
*
36+
* <p>The default constructor uses the default configuration provided by {@link Jackson2ObjectMapperBuilder}.
37+
*
38+
* <p>Compatible with Jackson 2.6 and higher.
39+
*
40+
* @author Sebastien Deleuze
41+
* @since 5.0
42+
*/
43+
public class MappingJackson2CborHttpMessageConverter extends AbstractJackson2HttpMessageConverter {
44+
45+
/**
46+
* Construct a new {@code MappingJackson2CborHttpMessageConverter} using default configuration
47+
* provided by {@code Jackson2ObjectMapperBuilder}.
48+
*/
49+
public MappingJackson2CborHttpMessageConverter() {
50+
this(Jackson2ObjectMapperBuilder.cbor().build());
51+
}
52+
53+
/**
54+
* Construct a new {@code MappingJackson2CborHttpMessageConverter} with a custom {@link ObjectMapper}
55+
* (must be configured with a {@code CBORFactory} instance).
56+
* You can use {@link Jackson2ObjectMapperBuilder} to build it easily.
57+
* @see Jackson2ObjectMapperBuilder#cbor()
58+
*/
59+
public MappingJackson2CborHttpMessageConverter(ObjectMapper objectMapper) {
60+
super(objectMapper, new MediaType("application", "cbor"));
61+
Assert.isAssignable(CBORFactory.class, objectMapper.getFactory().getClass());
62+
}
63+
64+
/**
65+
* {@inheritDoc}
66+
* The {@code objectMapper} parameter must be configured with a {@code CBORFactory} instance.
67+
*/
68+
@Override
69+
public void setObjectMapper(ObjectMapper objectMapper) {
70+
Assert.isAssignable(CBORFactory.class, objectMapper.getFactory().getClass());
71+
super.setObjectMapper(objectMapper);
72+
}
73+
74+
}

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

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131

3232
import com.fasterxml.jackson.annotation.JsonFilter;
3333
import com.fasterxml.jackson.annotation.JsonInclude;
34+
import com.fasterxml.jackson.core.JsonFactory;
3435
import com.fasterxml.jackson.core.JsonGenerator;
3536
import com.fasterxml.jackson.core.JsonParser;
3637
import com.fasterxml.jackson.databind.AnnotationIntrospector;
@@ -47,6 +48,8 @@
4748
import com.fasterxml.jackson.databind.jsontype.TypeResolverBuilder;
4849
import com.fasterxml.jackson.databind.module.SimpleModule;
4950
import com.fasterxml.jackson.databind.ser.FilterProvider;
51+
import com.fasterxml.jackson.dataformat.cbor.CBORFactory;
52+
import com.fasterxml.jackson.dataformat.smile.SmileFactory;
5053
import com.fasterxml.jackson.dataformat.xml.JacksonXmlModule;
5154
import com.fasterxml.jackson.dataformat.xml.XmlFactory;
5255
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
@@ -92,6 +95,8 @@ public class Jackson2ObjectMapperBuilder {
9295

9396
private boolean createXmlMapper = false;
9497

98+
private JsonFactory factory;
99+
95100
private DateFormat dateFormat;
96101

97102
private Locale locale;
@@ -143,6 +148,16 @@ public Jackson2ObjectMapperBuilder createXmlMapper(boolean createXmlMapper) {
143148
return this;
144149
}
145150

151+
/**
152+
* Define the {@link JsonFactory} to be used to create the {@link ObjectMapper}
153+
* instance.
154+
* @since 5.0
155+
*/
156+
public Jackson2ObjectMapperBuilder factory(JsonFactory factory) {
157+
this.factory = factory;
158+
return this;
159+
}
160+
146161
/**
147162
* Define the format for date/time with the given {@link DateFormat}.
148163
* <p>Note: Setting this property makes the exposed {@link ObjectMapper}
@@ -585,7 +600,7 @@ public <T extends ObjectMapper> T build() {
585600
new XmlObjectMapperInitializer().create());
586601
}
587602
else {
588-
mapper = new ObjectMapper();
603+
mapper = (this.factory != null ? new ObjectMapper(this.factory) : new ObjectMapper());
589604
}
590605
configure(mapper);
591606
return (T) mapper;
@@ -794,6 +809,24 @@ public static Jackson2ObjectMapperBuilder xml() {
794809
return new Jackson2ObjectMapperBuilder().createXmlMapper(true);
795810
}
796811

812+
/**
813+
* Obtain a {@link Jackson2ObjectMapperBuilder} instance in order to
814+
* build a Smile data format {@link ObjectMapper} instance.
815+
* @since 5.0
816+
*/
817+
public static Jackson2ObjectMapperBuilder smile() {
818+
return new Jackson2ObjectMapperBuilder().factory(new SmileFactoryInitializer().create());
819+
}
820+
821+
/**
822+
* Obtain a {@link Jackson2ObjectMapperBuilder} instance in order to
823+
* build a CBOR data format {@link ObjectMapper} instance.
824+
* @since 5.0
825+
*/
826+
public static Jackson2ObjectMapperBuilder cbor() {
827+
return new Jackson2ObjectMapperBuilder().factory(new CborFactoryInitializer().create());
828+
}
829+
797830

798831
private static class XmlObjectMapperInitializer {
799832

@@ -823,4 +856,16 @@ public Object resolveEntity(String publicID, String systemID, String base, Strin
823856
};
824857
}
825858

859+
private static class SmileFactoryInitializer {
860+
public JsonFactory create() {
861+
return new SmileFactory();
862+
}
863+
}
864+
865+
private static class CborFactoryInitializer {
866+
public JsonFactory create() {
867+
return new CBORFactory();
868+
}
869+
}
870+
826871
}

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525

2626
import com.fasterxml.jackson.annotation.JsonFilter;
2727
import com.fasterxml.jackson.annotation.JsonInclude;
28+
import com.fasterxml.jackson.core.JsonFactory;
2829
import com.fasterxml.jackson.databind.AnnotationIntrospector;
2930
import com.fasterxml.jackson.databind.DeserializationFeature;
3031
import com.fasterxml.jackson.databind.JsonDeserializer;
@@ -163,6 +164,15 @@ public void setCreateXmlMapper(boolean createXmlMapper) {
163164
this.builder.createXmlMapper(createXmlMapper);
164165
}
165166

167+
/**
168+
* Define the {@link JsonFactory} to be used to create the {@link ObjectMapper}
169+
* instance.
170+
* @since 5.0
171+
*/
172+
public void setFactory(JsonFactory factory) {
173+
this.builder.factory(factory);
174+
}
175+
166176
/**
167177
* Define the format for date/time with the given {@link DateFormat}.
168178
* <p>Note: Setting this property makes the exposed {@link ObjectMapper}

‎spring-web/src/main/java/org/springframework/http/converter/smile/MappingJackson2SmileHttpMessageConverter.java‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
/*
2+
* Copyright 2002-2016 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.http.converter.smile;
18+
19+
import com.fasterxml.jackson.databind.ObjectMapper;
20+
import com.fasterxml.jackson.dataformat.smile.SmileFactory;
21+
22+
import org.springframework.http.MediaType;
23+
import org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter;
24+
import org.springframework.http.converter.json.Jackson2ObjectMapperBuilder;
25+
import org.springframework.util.Assert;
26+
27+
/**
28+
* Implementation of {@link org.springframework.http.converter.HttpMessageConverter HttpMessageConverter}
29+
* that can read and write Smile data format ("binary JSON") using
30+
* <a href="https://github.com/FasterXML/jackson-dataformats-binary/tree/master/smile">
31+
* the dedicated Jackson 2.x extension</a>.
32+
*
33+
* <p>By default, this converter supports {@code "application/x-jackson-smile"} media type.
34+
* This can be overridden by setting the {@link #setSupportedMediaTypes supportedMediaTypes} property.
35+
*
36+
* <p>The default constructor uses the default configuration provided by {@link Jackson2ObjectMapperBuilder}.
37+
*
38+
* <p>Compatible with Jackson 2.6 and higher.
39+
*
40+
* @author Sebastien Deleuze
41+
* @since 5.0
42+
*/
43+
public class MappingJackson2SmileHttpMessageConverter extends AbstractJackson2HttpMessageConverter {
44+
45+
/**
46+
* Construct a new {@code MappingJackson2SmileHttpMessageConverter} using default configuration
47+
* provided by {@code Jackson2ObjectMapperBuilder}.
48+
*/
49+
public MappingJackson2SmileHttpMessageConverter() {
50+
this(Jackson2ObjectMapperBuilder.smile().build());
51+
}
52+
53+
/**
54+
* Construct a new {@code MappingJackson2SmileHttpMessageConverter} with a custom {@link ObjectMapper}
55+
* (must be configured with a {@code SmileFactory} instance).
56+
* You can use {@link Jackson2ObjectMapperBuilder} to build it easily.
57+
* @see Jackson2ObjectMapperBuilder#smile()
58+
*/
59+
public MappingJackson2SmileHttpMessageConverter(ObjectMapper objectMapper) {
60+
super(objectMapper, new MediaType("application", "x-jackson-smile"));
61+
Assert.isAssignable(SmileFactory.class, objectMapper.getFactory().getClass());
62+
}
63+
64+
/**
65+
* {@inheritDoc}
66+
* The {@code objectMapper} parameter must be configured with a {@code SmileFactory} instance.
67+
*/
68+
@Override
69+
public void setObjectMapper(ObjectMapper objectMapper) {
70+
Assert.isAssignable(SmileFactory.class, objectMapper.getFactory().getClass());
71+
super.setObjectMapper(objectMapper);
72+
}
73+
74+
}

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import org.springframework.http.converter.FormHttpMessageConverter;
2020
import org.springframework.http.converter.json.GsonHttpMessageConverter;
2121
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
22+
import org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter;
2223
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
2324
import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
2425
import org.springframework.http.converter.xml.SourceHttpMessageConverter;
@@ -44,6 +45,9 @@ public class AllEncompassingFormHttpMessageConverter extends FormHttpMessageConv
4445
private static final boolean jackson2XmlPresent =
4546
ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
4647

48+
private static final boolean jackson2SmilePresent =
49+
ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
50+
4751
private static final boolean gsonPresent =
4852
ClassUtils.isPresent("com.google.gson.Gson", AllEncompassingFormHttpMessageConverter.class.getClassLoader());
4953

@@ -65,6 +69,10 @@ else if (gsonPresent) {
6569
if (jackson2XmlPresent) {
6670
addPartConverter(new MappingJackson2XmlHttpMessageConverter());
6771
}
72+
73+
if (jackson2SmilePresent) {
74+
addPartConverter(new MappingJackson2SmileHttpMessageConverter());
75+
}
6876
}
6977

7078
}

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

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@
4040
import org.springframework.http.converter.HttpMessageConverter;
4141
import org.springframework.http.converter.ResourceHttpMessageConverter;
4242
import org.springframework.http.converter.StringHttpMessageConverter;
43+
import org.springframework.http.converter.cbor.MappingJackson2CborHttpMessageConverter;
4344
import org.springframework.http.converter.feed.AtomFeedHttpMessageConverter;
4445
import org.springframework.http.converter.feed.RssChannelHttpMessageConverter;
4546
import org.springframework.http.converter.json.GsonHttpMessageConverter;
4647
import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
48+
import org.springframework.http.converter.smile.MappingJackson2SmileHttpMessageConverter;
4749
import org.springframework.http.converter.support.AllEncompassingFormHttpMessageConverter;
4850
import org.springframework.http.converter.xml.Jaxb2RootElementHttpMessageConverter;
4951
import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter;
@@ -133,6 +135,12 @@ public class RestTemplate extends InterceptingHttpAccessor implements RestOperat
133135
private static final boolean jackson2XmlPresent =
134136
ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", RestTemplate.class.getClassLoader());
135137

138+
private static final boolean jackson2SmilePresent =
139+
ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", RestTemplate.class.getClassLoader());
140+
141+
private static final boolean jackson2CborPresent =
142+
ClassUtils.isPresent("com.fasterxml.jackson.dataformat.cbor.CBORFactory", RestTemplate.class.getClassLoader());
143+
136144
private static final boolean gsonPresent =
137145
ClassUtils.isPresent("com.google.gson.Gson", RestTemplate.class.getClassLoader());
138146

@@ -175,6 +183,13 @@ else if (jaxb2Present) {
175183
else if (gsonPresent) {
176184
this.messageConverters.add(new GsonHttpMessageConverter());
177185
}
186+
187+
if (jackson2SmilePresent) {
188+
this.messageConverters.add(new MappingJackson2SmileHttpMessageConverter());
189+
}
190+
if (jackson2CborPresent) {
191+
this.messageConverters.add(new MappingJackson2CborHttpMessageConverter());
192+
}
178193
}
179194

180195
/**

‎spring-web/src/test/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilderTests.java‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@
6363
import com.fasterxml.jackson.databind.ser.std.ClassSerializer;
6464
import com.fasterxml.jackson.databind.ser.std.NumberSerializer;
6565
import com.fasterxml.jackson.databind.type.SimpleType;
66+
import com.fasterxml.jackson.dataformat.cbor.CBORFactory;
67+
import com.fasterxml.jackson.dataformat.smile.SmileFactory;
6668
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
6769
import kotlin.ranges.IntRange;
6870
import org.joda.time.DateTime;
@@ -455,6 +457,27 @@ public void defaultUseWrapper() throws JsonProcessingException {
455457
assertThat(output, containsString("<list>foo</list><list>bar</list></ListContainer>"));
456458
}
457459

460+
@Test // SPR-14435
461+
public void smile() {
462+
ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.smile().build();
463+
assertNotNull(objectMapper);
464+
assertEquals(SmileFactory.class, objectMapper.getFactory().getClass());
465+
}
466+
467+
@Test // SPR-14435
468+
public void cbor() {
469+
ObjectMapper objectMapper = Jackson2ObjectMapperBuilder.cbor().build();
470+
assertNotNull(objectMapper);
471+
assertEquals(CBORFactory.class, objectMapper.getFactory().getClass());
472+
}
473+
474+
@Test // SPR-14435
475+
public void factory() {
476+
ObjectMapper objectMapper = new Jackson2ObjectMapperBuilder().factory(new SmileFactory()).build();
477+
assertNotNull(objectMapper);
478+
assertEquals(SmileFactory.class, objectMapper.getFactory().getClass());
479+
}
480+
458481

459482
public static class CustomIntegerModule extends Module {
460483

0 commit comments

Comments
 (0)