Skip to content
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

Change how JavaType is resolved to support JsonSerializable better #40112

Merged
merged 1 commit into from
May 10, 2024
Merged

Change how JavaType is resolved to support JsonSerializable better #40112

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
28 changes: 26 additions & 2 deletions ...src/main/java/com/azure/core/serializer/json/jackson/implementation/ObjectMapperShim.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@
import com.azure.core.annotation.HeaderCollection;
import com.azure.core.http.HttpHeader;
import com.azure.core.http.HttpHeaders;
import com.azure.core.implementation.ReflectiveInvoker;
import com.azure.core.implementation.ReflectionSerializable;
import com.azure.core.implementation.ReflectionUtils;
import com.azure.core.implementation.ReflectiveInvoker;
import com.azure.core.implementation.TypeUtil;
import com.azure.core.util.logging.ClientLogger;
import com.azure.json.JsonSerializable;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand Down Expand Up @@ -264,6 +266,7 @@ public JsonNode readTree(byte[] content) throws IOException {
}
}

@SuppressWarnings("unchecked")
private JavaType createJavaType(Type type) {
if (type == null) {
return null;
Expand All @@ -280,7 +283,28 @@ private JavaType createJavaType(Type type) {
return getFromTypeCache(type, t -> mapper.getTypeFactory()
.constructParametricType((Class<?>) parameterizedType.getRawType(), javaTypeArguments));
} else {
return getFromTypeCache(type, t -> mapper.getTypeFactory().constructType(t));
return getFromTypeCache(type, t -> {
JavaType javaType = mapper.constructType(t);

// Need additional handling here so that the JavaType returned has the correct value handler for
// JsonSerializable types.
// While JsonSerializableDeserializer is registered with the ObjectMapper, and it mutates the
// JsonSerializer used by Jackson to handle as a JsonSerializable type, there have been cases where
// collection types (List, Map, etc) have not been handled correctly. So, additional handling is done
// here to ensure that the JavaType returned has the correct value handler.

if (!(t instanceof Class<?>)) {
// Not a Class, so can't be a JsonSerializable type.
return javaType;
}

if (ReflectionSerializable.supportsJsonSerializable((Class<?>) t)) {
// JsonSerializable type, so add the JsonSerializableDeserializer as the value handler.
return javaType.withValueHandler(new JsonSerializableDeserializer((Class<JsonSerializable<?>>) t));
}

return javaType;
});
}
}

Expand Down
26 changes: 25 additions & 1 deletion ...core/azure-core/src/main/java/com/azure/core/implementation/jackson/ObjectMapperShim.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@
import com.azure.core.annotation.HeaderCollection;
import com.azure.core.http.HttpHeader;
import com.azure.core.http.HttpHeaders;
import com.azure.core.implementation.ReflectionSerializable;
import com.azure.core.implementation.ReflectionUtils;
import com.azure.core.implementation.ReflectiveInvoker;
import com.azure.core.implementation.TypeUtil;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.logging.LogLevel;
import com.azure.core.util.serializer.MemberNameConverter;
import com.azure.json.JsonSerializable;
import com.fasterxml.jackson.databind.JavaType;
import com.fasterxml.jackson.databind.JsonNode;
import com.fasterxml.jackson.databind.ObjectMapper;
Expand Down Expand Up @@ -294,6 +296,7 @@ public JsonNode readTree(byte[] content) throws IOException {
}
}

@SuppressWarnings("unchecked")
private JavaType createJavaType(Type type) {
if (type == null) {
return null;
Expand All @@ -310,7 +313,28 @@ private JavaType createJavaType(Type type) {
return getFromTypeCache(type, t -> mapper.getTypeFactory()
.constructParametricType((Class<?>) parameterizedType.getRawType(), javaTypeArguments));
} else {
return getFromTypeCache(type, t -> mapper.getTypeFactory().constructType(t));
return getFromTypeCache(type, t -> {
JavaType javaType = mapper.constructType(t);

// Need additional handling here so that the JavaType returned has the correct value handler for
// JsonSerializable types.
// While JsonSerializableDeserializer is registered with the ObjectMapper, and it mutates the
// JsonSerializer used by Jackson to handle as a JsonSerializable type, there have been cases where
// collection types (List, Map, etc) have not been handled correctly. So, additional handling is done
// here to ensure that the JavaType returned has the correct value handler.

if (!(t instanceof Class<?>)) {
// Not a Class, so can't be a JsonSerializable type.
return javaType;
}

if (ReflectionSerializable.supportsJsonSerializable((Class<?>) t)) {
// JsonSerializable type, so add the JsonSerializableDeserializer as the value handler.
return javaType.withValueHandler(new JsonSerializableDeserializer((Class<JsonSerializable<?>>) t));
}

return javaType;
});
}
}

Expand Down
Loading