Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-11 07:55:47 +01:00
Code Issues Packages Projects Releases Activity

improve default configuration for json serialization/deserialization

Browse Source
This commit is contained in:
Sebastian Sdorra
2017-06-28 21:59:49 +02:00
parent 3637a8de20
commit 97abf3de0e
2 changed files with 217 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

75
scm-webapp/src/main/java/sonia/scm/api/rest/JSONContextResolver.java Normal file
View File

@@ -0,0 +1,75 @@
/**
* Copyright (c) 2010, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.api.rest;
import com.fasterxml.jackson.databind.AnnotationIntrospector;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.introspect.AnnotationIntrospectorPair;
import com.fasterxml.jackson.databind.introspect.JacksonAnnotationIntrospector;
import com.fasterxml.jackson.databind.type.TypeFactory;
import com.fasterxml.jackson.module.jaxb.JaxbAnnotationIntrospector;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
/**
* Configures the way objects are marshaled to json.
*
* @author Sebastian Sdorra
* @since 2.0.0
*/
@Provider
@Produces(MediaType.APPLICATION_JSON)
public final class JSONContextResolver implements ContextResolver<ObjectMapper> {
private final ObjectMapper mapper;
public JSONContextResolver() {
mapper = new ObjectMapper();
mapper.setAnnotationIntrospector(createAnnotationIntrospector());
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
}
private AnnotationIntrospector createAnnotationIntrospector() {
return new AnnotationIntrospectorPair(
new JaxbAnnotationIntrospector(TypeFactory.defaultInstance()),
new JacksonAnnotationIntrospector()
);
}
@Override
public ObjectMapper getContext(Class<?> type) {
return mapper;
}
}

142
scm-webapp/src/test/java/sonia/scm/api/rest/JSONContextResolverTest.java Normal file
View File

@@ -0,0 +1,142 @@
/**
* Copyright (c) 2010, Sebastian Sdorra
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
* 3. Neither the name of SCM-Manager; nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* http://bitbucket.org/sdorra/scm-manager
*
*/
package sonia.scm.api.rest;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import java.io.IOException;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import org.junit.Test;
import static org.junit.Assert.*;
/**
* Unit tests for {@link JSONContextResolver}.
*
* @author Sebastian Sdorra
*/
public class JSONContextResolverTest {
private final ObjectMapper mapper = new JSONContextResolver().getContext(Object.class);
/**
* Tests json unmarshalling with unknown properties.
*
* @throws IOException
*/
@Test
public void testUnmarshalWithUnknownPropertery() throws IOException {
SampleOne one = mapper.readValue("{\"title\": \"super title\", \"body\": \"super body\"}", SampleOne.class);
assertEquals("super title", one.title);
}
private static class SampleOne {
private String title;
public void setTitle(String title) {
this.title = title;
}
}
/**
* Tests json marshaling with JAXB annotations.
*
* @throws JsonProcessingException
*/
@Test
public void testMarshalWithJAXBAnnotations() throws JsonProcessingException {
SampleTwo two = new SampleTwo();
two.label = "super title";
assertEquals("{\"title\":\"super title\"}", mapper.writeValueAsString(two));
}
/**
* Tests json unmarshalling with JAXB annotations.
*
* @throws JsonProcessingException
*/
@Test
public void testUnmarshalWithJAXBAnnotations() throws IOException {
SampleTwo two = mapper.readValue("{\"title\": \"super title\"}", SampleTwo.class);
assertEquals("super title", two.label);
}
@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
private static class SampleTwo {
@XmlElement(name = "title")
private String label;
}
/**
* Tests json marshaling with jackson annotations.
*
* @throws JsonProcessingException
*/
@Test
public void testMarshalWithJacksonAnnotations() throws JsonProcessingException {
SampleThree two = new SampleThree();
two.setLabel("super title");
assertEquals("{\"title\":\"super title\"}", mapper.writeValueAsString(two));
}
/**
* Tests json unmarshalling with jackson annotations.
*
* @throws JsonProcessingException
*/
@Test
public void testUnmarshalWithJacksonAnnotations() throws IOException {
SampleThree three = mapper.readValue("{\"title\": \"super title\"}", SampleThree.class);
assertEquals("super title", three.getLabel());
}
private static class SampleThree {
@JsonProperty(value = "title")
private String label;
public void setLabel(String label) {
this.label = label;
}
public String getLabel() {
return label;
}
}
}