Custom ObjectMapper with Jersey 2.2 and Jackson 2.1
Solution 1
I found a solution. I had to instantiate the Jackson Provider by myself and set my custom ObjectMapper
. A working example can be found on GitHub: https://github.com/svenwltr/example-grizzly-jersey-jackson/tree/stackoverflow-answer
I deleted my ObjectMapperResolver
and modified my main
method:
public class Main {
public static void main(String[] args) {
try {
// create custom ObjectMapper
ObjectMapper mapper = new ObjectMapper();
mapper.enable(SerializationFeature.INDENT_OUTPUT);
// create JsonProvider to provide custom ObjectMapper
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider();
provider.setMapper(mapper);
// configure REST service
ResourceConfig rc = new ResourceConfig();
rc.register(ExampleResource.class);
rc.register(provider);
// create Grizzly instance and add handler
HttpHandler handler = ContainerFactory.createContainer(
GrizzlyHttpContainer.class, rc);
URI uri = new URI("http://0.0.0.0:8080/");
HttpServer server = GrizzlyHttpServerFactory.createHttpServer(uri);
ServerConfiguration config = server.getServerConfiguration();
config.addHttpHandler(handler, "/");
// start
server.start();
System.in.read();
} catch (ProcessingException | URISyntaxException | IOException e) {
throw new Error("Unable to create HTTP server.", e);
}
}
}
Solution 2
The following solution applies to the following stack (as in... this is the setup I've used to test it)
Jersey 2.12, Jackson 2.4.x
I'm adding my message w/ the solution I've come up with on this post since it was quite relevant for the many Google searches I've put in today... It is a cumbersome solution to what I believe to be an even more cumbersome problem.
1. Make sure your maven configuration CONTAINS the jackson-jaxrs-json-provider
dependency:
<dependency>
<groupId>com.fasterxml.jackson.jaxrs</groupId>
<artifactId>jackson-jaxrs-json-provider</artifactId>
<version>2.4.1</version>
</dependency>
2. Make sure your maven configuration DOESN'T CONTAIN the jersey-media-json-jackson
dependency:
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
</dependency>
3. Create a @Provider
component extending com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider
like so:
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.Provider;
@Provider
@Produces(MediaType.APPLICATION_JSON)
public class CustomJsonProvider extends JacksonJaxbJsonProvider {
private static ObjectMapper mapper = new ObjectMapper();
static {
mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
mapper.setSerializationInclusion(JsonInclude.Include.ALWAYS);
mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
mapper.enable(SerializationFeature.INDENT_OUTPUT);
}
public CustomJsonProvider() {
super();
setMapper(mapper);
}
}
As you can observe this is also where we define the custom instance of com.fasterxml.jackson.databind.ObjectMapper
4. Extend javax.ws.rs.core.Feature
via MarshallingFeature
like so:
import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.MessageBodyWriter;
public class MarshallingFeature implements Feature {
@Override
public boolean configure(FeatureContext context) {
context.register(CustomJsonProvider.class, MessageBodyReader.class, MessageBodyWriter.class);
return true;
}
}
5. You need to register this custom provider like so, provided you configure your application via org.glassfish.jersey.server.ResourceConfig
like so:
import org.glassfish.jersey.server.ResourceConfig;
...
public class MyApplication extends ResourceConfig {
public MyApplication() {
...
register(MarshallingFeature.class);
...
}
}
Other notes and observations:
- This solution applies whether you're using
javax.ws.rs.core.Response
to wrap your controller's responses or not. - Please make sure you carefully take into consideration (copy/paste) the following code snippets since the only "non-mandatory" so to speak bits are the ones regarding the custom configuration of the
com.fasterxml.jackson.databind.ObjectMapper
.
@jcreason
Sorry for dropping the ball on this one @jcreason, I hope you're still curios. So I checked out the code from last year and this is what I came up w/ to provide a custom mapper.
The problem was that during feature initalization any custom object mappers get disabled by some code in
org.glassfish.jersey.jackson.JacksonFeature:77 (jersey-media-json-jackson-2.12.jar)
// Disable other JSON providers.
context.property(PropertiesHelper.getPropertyNameForRuntime(InternalProperties.JSON_FEATURE, config.getRuntimeType()), JSON_FEATURE);
But this feature only gets registered by this component
org.glassfish.jersey.jackson.internal.JacksonAutoDiscoverable
if (!context.getConfiguration().isRegistered(JacksonFeature.class)) {
context.register(JacksonFeature.class);
}
So what I did was to register my own feature which registeres my own object mapper provider and drops in a trip wire stopping org.glassfish.jersey.jackson.JacksonFeature from being registered and overriding my object mapper...
import com.fasterxml.jackson.jaxrs.base.JsonMappingExceptionMapper;
import com.fasterxml.jackson.jaxrs.base.JsonParseExceptionMapper;
import org.glassfish.jersey.internal.InternalProperties;
import org.glassfish.jersey.internal.util.PropertiesHelper;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import javax.ws.rs.core.Configuration;
import javax.ws.rs.core.Feature;
import javax.ws.rs.core.FeatureContext;
import javax.ws.rs.ext.MessageBodyReader;
import javax.ws.rs.ext.MessageBodyWriter;
public class MarshallingFeature implements Feature {
private final static String JSON_FEATURE = MarshallingFeature.class.getSimpleName();
@Override
public boolean configure(FeatureContext context) {
context.register(JsonParseExceptionMapper.class);
context.register(JsonMappingExceptionMapper.class);
context.register(JacksonJsonProviderAtRest.class, MessageBodyReader.class, MessageBodyWriter.class);
final Configuration config = context.getConfiguration();
// Disables discoverability of org.glassfish.jersey.jackson.JacksonFeature
context.property(
PropertiesHelper.getPropertyNameForRuntime(InternalProperties.JSON_FEATURE,
config.getRuntimeType()), JSON_FEATURE);
return true;
}
}
And here is the custom object mapper provider...
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.Provider;
@Provider
@Produces(MediaType.APPLICATION_JSON)
public class JacksonJsonProviderAtRest extends JacksonJaxbJsonProvider {
private static ObjectMapper objectMapperAtRest = new ObjectMapper();
static {
objectMapperAtRest.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
objectMapperAtRest.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapperAtRest.configure(SerializationFeature.INDENT_OUTPUT, true); // Different from default so you can test it :)
objectMapperAtRest.setSerializationInclusion(JsonInclude.Include.ALWAYS);
}
public JacksonJsonProviderAtRest() {
super();
setMapper(objectMapperAtRest);
}
}
Solution 3
I figured this out, based on a bit of tinkering.
The issue appears to be in Jersey's feature autodetection mechanism. If you rely on Jersey to load the JacksonJaxbJsonProvider, then the custom context provider for your ObjectMapper is ignored. If, instead, you manually register the feature, it works. I hypothesize that this has to do with the autodetected provider being loaded into a different context scope, but as for a solution, here's what I ended up with. Note that I wrapped it into a feature, you should be able to register it directly with your application without a problem.
public final class RequestMappingFeature implements Feature {
@Override
public boolean configure(final FeatureContext context) {
context.register(ObjectMapperProvider.class);
// If you comment out this line, it stops working.
context.register(JacksonJaxbJsonProvider.class);
return true;
}
}
UPDATE November 2017: Things have changed a bit in the Jersey2 world. If the above doesn't work, try this:
The new method of providing your own ObjectMapper now looks like this:
public final class JacksonFeature implements Feature {
private static final ObjectMapper MAPPER;
static {
// Create the new object mapper.
MAPPER = new ObjectMapper();
// Enable/disable various configuration flags.
MAPPER.configure(
DeserializationFeature.READ_ENUMS_USING_TO_STRING, true);
// ... Add your own configurations here.
}
@Override
public boolean configure(final FeatureContext context) {
JacksonJaxbJsonProvider provider = new JacksonJaxbJsonProvider(
MAPPER, DEFAULT_ANNOTATIONS);
context.register(provider);
return true;
}
}
Solution 4
Please do this:
1) add pom.xml dependency
<dependency>
<groupId>org.glassfish.jersey.media</groupId>
<artifactId>jersey-media-json-jackson</artifactId>
<version>2.2</version>
</dependency>
2) register JacksonFeature in the Main.java
public class Main {
public static void main(String[] args) {
try {
ResourceConfig rc = new ResourceConfig();
rc.register(ExampleResource.class);
rc.register(ObjectMapperResolver.class);
rc.register(JacksonFeature.class);
HttpHandler handler = ContainerFactory.createContainer(
GrizzlyHttpContainer.class, rc);
URI uri = new URI("http://0.0.0.0:8080/");
HttpServer server = GrizzlyHttpServerFactory.createHttpServer(uri);
ServerConfiguration config = server.getServerConfiguration();
config.addHttpHandler(handler, "/");
server.start();
System.in.read();
} catch (ProcessingException | URISyntaxException | IOException e) {
throw new Error("Unable to create HTTP server.", e);
}
}
}
3) Use org.codehaus.jackson.map.ObjectMapper in your resource
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.SerializationConfig.Feature;
@Provider
@Produces(MediaType.APPLICATION_JSON)
public class ObjectMapperResolver implements ContextResolver<ObjectMapper> {
private final ObjectMapper mapper;
public ObjectMapperResolver() {
System.out.println("new ObjectMapperResolver()");
mapper = new ObjectMapper();
mapper.enable(Feature.INDENT_OUTPUT);
}
@Override
public ObjectMapper getContext(Class<?> type) {
System.out.println("ObjectMapperResolver.getContext(...)");
return mapper;
}
}
Solution 5
From the Jersey 2.17 docs: https://eclipse-ee4j.github.io/jersey.github.io/documentation/2.17/media.html#jackson-registration
In the application
@ApplicationPath("/")
public class MyApplication extends ResourceConfig {
public MyApplication() {
register(JacksonFeature.class);
// This is the class that you supply, Call it what you want
register(JacksonObjectMapperProvider.class);
//...
}
}
Edit, forgot to add the JacksonObjectMapperProvider that you supply in register(..):
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializationFeature;
import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
import javax.ws.rs.ext.ContextResolver;
import javax.ws.rs.ext.Provider;
@Provider
public class JacksonObjectMapperProvider implements ContextResolver<ObjectMapper>{
final ObjectMapper defaultObjectMapper;
public JacksonObjectMapperProvider() {
defaultObjectMapper = createDefaultMapper();
}
@Override
public ObjectMapper getContext(Class<?> type) {return defaultObjectMapper;}
public static ObjectMapper createDefaultMapper() {
final ObjectMapper jackson = new ObjectMapper();
// any changes to the ObjectMapper is up to you. Do what you like.
// The ParameterNamesModule is optional,
// it enables you to have immutable POJOs in java8
jackson.registerModule(new ParameterNamesModule());
jackson.enable(SerializationFeature.INDENT_OUTPUT);
jackson.disable(SerializationFeature.WRITE_EMPTY_JSON_ARRAYS);
jackson.disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
return jackson;
}
}
Comments
-
svenwltr over 3 years
I am struggling with a REST application with Grizzly, Jersey and Jackson, because Jersey ignores my custom ObjectMapper.
POM dependencies:
<dependencies> <dependency> <groupId>org.glassfish.jersey.containers</groupId> <artifactId>jersey-container-grizzly2-servlet</artifactId> <version>2.2</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.jaxrs</groupId> <artifactId>jackson-jaxrs-json-provider</artifactId> <version>2.1.4</version> </dependency> </dependencies>
Resulting versions are: Grizzly 2.3.3, Jackson 2.1.4 and Jersey 2.2.
Main class (I want explicit registration of Jersey components):
public class Main { public static void main(String[] args) { try { ResourceConfig rc = new ResourceConfig(); rc.register(ExampleResource.class); rc.register(ObjectMapperResolver.class); HttpHandler handler = ContainerFactory.createContainer( GrizzlyHttpContainer.class, rc); URI uri = new URI("http://0.0.0.0:8080/"); HttpServer server = GrizzlyHttpServerFactory.createHttpServer(uri); ServerConfiguration config = server.getServerConfiguration(); config.addHttpHandler(handler, "/"); server.start(); System.in.read(); } catch (ProcessingException | URISyntaxException | IOException e) { throw new Error("Unable to create HTTP server.", e); } } }
ContextResolver for ObjectMapper:
@Provider @Produces(MediaType.APPLICATION_JSON) public class ObjectMapperResolver implements ContextResolver<ObjectMapper> { private final ObjectMapper mapper; public ObjectMapperResolver() { System.out.println("new ObjectMapperResolver()"); mapper = new ObjectMapper(); mapper.enable(SerializationFeature.INDENT_OUTPUT); } @Override public ObjectMapper getContext(Class<?> type) { System.out.println("ObjectMapperResolver.getContext(...)"); return mapper; } }
Neither
ObjectMapperResolver
constructor norgetContext
get called. What am I missing? I would prefer to use Jersey 2.2 and Jackson 2.1, because it is a dependency for another lib.A full example can be found on GitHub: https://github.com/svenwltr/example-grizzly-jersey-jackson/tree/stackoverflow
-
svenwltr over 10 yearsThat's working, but than I have to downgrade to Jackson 1.9. I would prefer Jackson 2.1. Sorry, I didn't mention that.
-
Michael Iles over 10 yearsThis is very helpful, but it still has a problem: Jersey auto-discovers the Jackson provider so it creates a (presumably unconfigured) provider, and then this code explicitly registers a (properly configured) provider, so Jersey ends up with two providers. I've illustrated this at (github.com/svenwltr/example-grizzly-jersey-jackson/issues/1). I don't know how to fix this. Any ideas?
-
Giovanni Botta about 10 yearsI believe you can turn auto-discovery off but then you lose it for everything.
-
svenwltr about 10 yearsThe given example is working for me. Also, try user915662s solution.
-
mujimu almost 10 yearsFor those of us coming to this issue late - it still occurs in latest Jackson 2.x (v2.3). This answer uses an older Jersey/Jackson connector lib that relies on Jackson 1.x. Whole issue here is that what worked in Jackson 1.x does NOT work in 2.x. You must manually register the Jackson provider (turning off METAINF auto-discover) for now.
-
Montri M almost 10 years+1 for
map.put("jersey.config.disableMoxyJson.server", true);
, it got me struggling for hours. Thanks! -
Lorcan O'Neill about 9 yearsThis worked for me when I was trying to run some test cases with protos. Nice
-
GuiSim about 9 yearsI don't get why there's a
@Produces
annotation on this class. This is not a Jersey resource..! -
timmz almost 9 yearsThanks, this is what worked for me ( SDK8, Jersey 2.10.x ) just a remark, disabling Moxy is not required if it's not added in the first time.
-
Zero3 over 8 yearsThis is not an answer to the question. I think you missed the point that he is trying to register a custom mapper, not the default one.
-
fragorl over 8 years3. Does not compile - cannot find symbol "objectMapperAtRest". Was this just meant to be "mapper" ?
-
fragorl over 8 yearsI was unable to get this to work. Getting org.glassfish.jersey.message.internal.MessageBodyProviderNotFoundException: MessageBodyWriter not found for media type=application/json, type=class <Some Bean>.
-
Filip over 8 years@fragorl you're right, "objectMapperAtRest" was supposed to be "mapper"
-
Filip over 8 years@fragorl please add the maven dependency for jersey-media-json-jackson
-
Filip over 8 years@fragorl during the time that has passed since I wrote this answer I've managed to improve the solution for this particular problem... if the solution still doesn't work for you then I'll add a new answer with the effective solution I'm currently using
-
sytolk over 8 yearsIt works. What is have in
new ParameterNamesModule()
object ? -
jcreason over 8 yearsCurious, what's your new solution?
-
Filip about 8 years@jcreason I hope you're still curios, sorry for dropping the ball on this one. So I checked out the code from last year and this is what I came up w/ to provide a custom mapper.
-
snooze92 about 8 yearsReplacing {{jersey-media-json-jackson}} with {{jackson-jaxrs-json-provider}} is what fixed it for me...
-
jediz over 7 yearsyou can disable autodiscovery with
resourceConfig.addProperties(Collections.singletonMap(CommonProperties.FEATURE_AUTO_DISCOVERY_DISABLE, true))
-
Alkanshel over 6 yearsAdding this feature just gives me "WARNING: No resource methods have been found for resource class ... RequestMappingFeature"
-
Hank over 5 years"new method" works for me on Jersey 2.27 and Jackson 2.9
-
elhefe over 5 yearsWorks on Jersey 2.23.2 and Jackson 2.5.4, and is much simpler than the other solutions AFAICT. To make this dead simple for next time,
DEFAULT_ANNOTATIONS
is a field onJacksonJaxbJsonProvider
, and youResourceConfig.register(JacksonFeature.class)
. -
George over 4 yearsThe
createDefaultMapper()
method provides the custom objectmapper. Create whatever ObjectMapper and configure it the way you want it to work in that method. ParameterNamesModule (github.com/FasterXML/jackson-modules-java8/tree/master/…) is just an example of what you can configure. -
Clint Eastwood about 4 yearsI did not need to explicitly reference the
ObjectMapperContext
. Just make sure you have it under a package, saycom.yourcompany.a.b.c
and then ensure you have this instruction in yourResourceConfig
(or main):packages("com.yourcompany.a.b.c");