Skip to content

chore: upgrade jackson to version 3 #1221

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
DarkAtra wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore: upgrade jackson to version 3 #1221

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 1 addition & 6 deletions nitrite-jackson-mapper/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<groupId>tools.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
</dependency>
<dependency>
Expand Down Expand Up @@ -95,11 +95,6 @@
<artifactId>snakeyaml</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.datatype</groupId>
<artifactId>jackson-datatype-jsr310</artifactId>
<scope>test</scope>
</dependency>
</dependencies>


Expand Down
160 changes: 82 additions & 78 deletions nitrite-jackson-mapper/src/main/java/org/dizitart/no2/mapper/jackson/JacksonMapper.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,31 +16,37 @@

package org.dizitart.no2.mapper.jackson;

import static org.dizitart.no2.common.util.ValidationUtils.notNull;
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.Module;
import com.fasterxml.jackson.databind.*;
import org.dizitart.no2.NitriteConfig;
import org.dizitart.no2.collection.Document;
import org.dizitart.no2.common.mapper.NitriteMapper;
import org.dizitart.no2.mapper.jackson.modules.NitriteIdModule;
import org.dizitart.no2.exceptions.ObjectMappingException;
import org.dizitart.no2.exceptions.ValidationException;

import java.io.IOException;
import java.util.*;

import static org.dizitart.no2.common.util.ValidationUtils.notNull;
import org.dizitart.no2.mapper.jackson.modules.NitriteIdModule;
import tools.jackson.core.json.JsonReadFeature;
import tools.jackson.databind.DatabindException;
import tools.jackson.databind.JacksonModule;
import tools.jackson.databind.JsonNode;
import tools.jackson.databind.ObjectMapper;
import tools.jackson.databind.json.JsonMapper;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

/**
* A {@link org.dizitart.no2.common.mapper.NitriteMapper} implementation that uses Jackson ObjectMapper to
* convert objects to and from Nitrite document.
*
* @since 4.0
* @see org.dizitart.no2.common.mapper.NitriteMapper
*
* @author Anindya Chatterjee
* @see org.dizitart.no2.common.mapper.NitriteMapper
* @since 4.0
*/
public class JacksonMapper implements NitriteMapper {
private final List<JacksonModule> modules = new ArrayList<>();
private ObjectMapper objectMapper;

/**
Expand All @@ -50,30 +56,37 @@ public class JacksonMapper implements NitriteMapper {
*/
protected ObjectMapper getObjectMapper() {
if (objectMapper == null) {
objectMapper = new ObjectMapper();
objectMapper.setVisibility(
objectMapper.getSerializationConfig().getDefaultVisibilityChecker()
.withFieldVisibility(JsonAutoDetect.Visibility.ANY)
.withGetterVisibility(JsonAutoDetect.Visibility.NONE)
.withIsGetterVisibility(JsonAutoDetect.Visibility.NONE));
objectMapper.configure(JsonParser.Feature.ALLOW_UNQUOTED_FIELD_NAMES, true);
objectMapper.configure(JsonParser.Feature.ALLOW_SINGLE_QUOTES, true);
objectMapper.configure(JsonParser.Feature.ALLOW_COMMENTS, true);
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
objectMapper.registerModule(new NitriteIdModule());
objectMapper = JsonMapper.builder()
.changeDefaultVisibility(visibilityChecker -> visibilityChecker
.withFieldVisibility(JsonAutoDetect.Visibility.ANY)
.withGetterVisibility(JsonAutoDetect.Visibility.NONE)
.withIsGetterVisibility(JsonAutoDetect.Visibility.NONE)
)
.configure(JsonReadFeature.ALLOW_UNQUOTED_PROPERTY_NAMES, true)
.configure(JsonReadFeature.ALLOW_SINGLE_QUOTES, true)
.configure(JsonReadFeature.ALLOW_JAVA_COMMENTS, true)
.addModule(new NitriteIdModule())
.addModules(modules)
.build();
modules.clear();
}
return objectMapper;
}

/**
* Registers a Jackson module with the object mapper.
* Can only register modules as long as the underlying ObjectMapper is still un-initialized.
*
* @param module the Jackson module to register
*
* @throws ValidationException if the module is null
*/
public void registerJacksonModule(Module module) {
public void registerJacksonModule(JacksonModule module) {
Copy link
Contributor Author

@DarkAtra DarkAtra Mar 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it would proabably make sense to get rid of this method since the ObjectMapper is immutable after construction in jackson 3. passing the JacksonModules as constructor parameters and initializing the ObjectMapper in the constructor would probably be better - similar to how it's already done in KNO2JacksonMapper

if (objectMapper != null) {
throw new IllegalStateException("Can not register modules after object mapper initialization.");
}
notNull(module, "module cannot be null");
getObjectMapper().registerModule(module);
modules.add(module);
}

/**
Expand All @@ -86,11 +99,13 @@ public void registerJacksonModule(Module module) {
* already a Document, converts it to the target type. If the conversion fails,
* throws an ObjectMappingException.
*
* @param source the source object to convert
* @param type the target type to convert to
* @param source the source object to convert
* @param type the target type to convert to
* @param <Source> the type of the source object
* @param <Target> the type of the target object
*
* @return the converted object of the target type
*
* @throws ObjectMappingException if the conversion fails
*/
@Override
Expand All @@ -101,8 +116,9 @@ public <Source, Target> Object tryConvert(Source source, Class<Target> type) {

try {
JsonNode node = getObjectMapper().convertValue(source, JsonNode.class);
if (node == null)
if (node == null) {
return null;
}

if (node.isValueNode()) {
return getNodeValue(node);
Expand All @@ -115,11 +131,11 @@ public <Source, Target> Object tryConvert(Source source, Class<Target> type) {
}
} catch (Exception e) {
throw new ObjectMappingException("Failed to convert object of type "
+ source.getClass() + " to type " + type, e);
+ source.getClass() + " to type " + type, e);
}

throw new ObjectMappingException("Can't convert object to type " + type
+ ", try registering a jackson Module for it.");
+ ", try registering a jackson Module for it.");
}

@Override
Expand All @@ -130,21 +146,23 @@ public void initialize(NitriteConfig nitriteConfig) {
* Converts a Nitrite Document to an object of the specified class type using
* Jackson ObjectMapper.
*
* @param source the Nitrite Document to be converted
* @param type the class type of the object to be converted to
* @param source the Nitrite Document to be converted
* @param type the class type of the object to be converted to
* @param <Target> the type of the object to be converted to
*
* @return the converted object of the specified class type
*
* @throws ObjectMappingException if there is an error in the object mapping
* process
* process
*/
protected <Target> Target convertFromDocument(Document source, Class<Target> type) {
try {
return getObjectMapper().convertValue(source, type);
} catch (IllegalArgumentException iae) {
if (iae.getCause() instanceof JsonMappingException) {
JsonMappingException jme = (JsonMappingException) iae.getCause();
if (jme.getMessage().contains("Cannot construct instance")) {
throw new ObjectMappingException(jme.getMessage());
if (iae.getCause() instanceof DatabindException) {
DatabindException cause = (DatabindException) iae.getCause();
if (cause.getMessage().contains("Cannot construct instance")) {
throw new ObjectMappingException(cause.getMessage());
}
}
throw iae;
Expand All @@ -155,8 +173,9 @@ protected <Target> Target convertFromDocument(Document source, Class<Target> typ
* Converts the given source object to a Nitrite {@link Document} using
* Jackson's {@link ObjectMapper}.
*
* @param source the source object to convert
* @param source the source object to convert
* @param <Source> the type of the source object
*
* @return the converted Nitrite {@link Document}
*/
protected <Source> Document convertToDocument(Source source) {
Expand All @@ -170,7 +189,7 @@ private <T> T getNodeValue(JsonNode node) {
case NUMBER:
return (T) node.numberValue();
case STRING:
return (T) node.textValue();
return (T) node.stringValue();
case BOOLEAN:
return (T) Boolean.valueOf(node.booleanValue());
default:
Expand All @@ -180,9 +199,7 @@ private <T> T getNodeValue(JsonNode node) {

private Document readDocument(JsonNode node) {
Map<String, Object> objectMap = new LinkedHashMap<>();
Iterator<Map.Entry<String, JsonNode>> fields = node.fields();
while (fields.hasNext()) {
Map.Entry<String, JsonNode> entry = fields.next();
for (Map.Entry<String, JsonNode> entry : node.properties()) {
String name = entry.getKey();
JsonNode value = entry.getValue();
Object object = readObject(value);
Expand All @@ -193,47 +210,34 @@ private Document readDocument(JsonNode node) {
}

private Object readObject(JsonNode node) {
if (node == null)
return null;
try {
switch (node.getNodeType()) {
case ARRAY:
return readArray(node);
case BINARY:
return node.binaryValue();
case BOOLEAN:
return node.booleanValue();
case MISSING:
case NULL:
return null;
case NUMBER:
return node.numberValue();
case OBJECT:
case POJO:
return readDocument(node);
case STRING:
return node.textValue();
}
} catch (IOException e) {
if (node == null) {
return null;
}
return null;

switch (node.getNodeType()) {
case ARRAY:
return readArray(node);
case BINARY:
return node.binaryValue();
case BOOLEAN:
return node.booleanValue();
case NUMBER:
return node.numberValue();
case OBJECT:
case POJO:
return readDocument(node);
case STRING:
return node.stringValue();
default:
return null;
}
}

@SuppressWarnings({ "unchecked", "rawtypes" })
private List readArray(JsonNode array) {
private List<Object> readArray(JsonNode array) {
if (array.isArray()) {
List list = new ArrayList();
Iterator iterator = array.elements();
while (iterator.hasNext()) {
Object element = iterator.next();
if (element instanceof JsonNode) {
list.add(readObject((JsonNode) element));
} else {
list.add(element);
}
}
return list;
return array.valueStream()
.map(this::readObject)
.collect(Collectors.toList());
}
return null;
}
Expand Down
9 changes: 4 additions & 5 deletions ...ite-jackson-mapper/src/main/java/org/dizitart/no2/mapper/jackson/JacksonMapperModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,13 @@

package org.dizitart.no2.mapper.jackson;

import com.fasterxml.jackson.databind.Module;
import static org.dizitart.no2.common.util.Iterables.setOf;
import org.dizitart.no2.common.module.NitriteModule;
import org.dizitart.no2.common.module.NitritePlugin;
import tools.jackson.databind.JacksonModule;

import java.util.Set;

import static org.dizitart.no2.common.util.Iterables.setOf;

/**
* A Nitrite module that provides a jackson based {@link org.dizitart.no2.common.mapper.NitriteMapper}
* implementation for object to document conversion.
Expand All @@ -49,9 +48,9 @@ public JacksonMapperModule() {
*
* @param jacksonModules the jackson modules
*/
public JacksonMapperModule(Module... jacksonModules) {
public JacksonMapperModule(JacksonModule... jacksonModules) {
jacksonMapper = new JacksonMapper();
for (Module jacksonModule : jacksonModules) {
for (JacksonModule jacksonModule : jacksonModules) {
jacksonMapper.registerJacksonModule(jacksonModule);
}
}
Expand Down
10 changes: 4 additions & 6 deletions ...n-mapper/src/main/java/org/dizitart/no2/mapper/jackson/modules/NitriteIdDeserializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,10 @@

package org.dizitart.no2.mapper.jackson.modules;

import com.fasterxml.jackson.core.JsonParser;
import com.fasterxml.jackson.databind.DeserializationContext;
import com.fasterxml.jackson.databind.deser.std.StdScalarDeserializer;
import org.dizitart.no2.collection.NitriteId;

import java.io.IOException;
import tools.jackson.core.JsonParser;
import tools.jackson.databind.DeserializationContext;
import tools.jackson.databind.deser.std.StdScalarDeserializer;

/**
* @since 4.0
Expand All @@ -34,7 +32,7 @@ class NitriteIdDeserializer extends StdScalarDeserializer<NitriteId> {
}

@Override
public NitriteId deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
public NitriteId deserialize(JsonParser p, DeserializationContext ctxt) {
return NitriteId.createId(p.getValueAsString());
}
}
2 changes: 1 addition & 1 deletion ...jackson-mapper/src/main/java/org/dizitart/no2/mapper/jackson/modules/NitriteIdModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@

package org.dizitart.no2.mapper.jackson.modules;

import com.fasterxml.jackson.databind.module.SimpleModule;
import org.dizitart.no2.collection.NitriteId;
import tools.jackson.databind.module.SimpleModule;

/**
* Class that registers capability of serializing {@link NitriteId} with the Jackson core.
Expand Down
12 changes: 5 additions & 7 deletions ...son-mapper/src/main/java/org/dizitart/no2/mapper/jackson/modules/NitriteIdSerializer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,14 @@

package org.dizitart.no2.mapper.jackson.modules;

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.ser.std.StdScalarSerializer;
import org.dizitart.no2.collection.NitriteId;

import java.io.IOException;
import tools.jackson.core.JsonGenerator;
import tools.jackson.databind.SerializationContext;
import tools.jackson.databind.ser.std.StdScalarSerializer;

/**
* @since 4.0
* @author Anindya Chatterjee
* @since 4.0
*/
class NitriteIdSerializer extends StdScalarSerializer<NitriteId> {

Expand All @@ -34,7 +32,7 @@ protected NitriteIdSerializer() {
}

@Override
public void serialize(NitriteId value, JsonGenerator gen, SerializerProvider provider) throws IOException {
public void serialize(NitriteId value, JsonGenerator gen, SerializationContext context) {
gen.writeString(Long.toString(value.getIdValue()));
}
}
Loading
Loading