[POC] A draft version for the search serializer to collect feedback #13218
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,14 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| import com.azure.core.serializer.json.jackson.JacksonSearchJsonSerializerProvider; | ||
|
|
||
| module com.azure.core.serializer.json.jackson { | ||
| requires transitive com.azure.core; | ||
| requires transitive com.azure.core.experimental; | ||
|
|
||
| exports com.azure.core.serializer.json.jackson; | ||
|
|
||
| provides com.azure.core.experimental.serializer.JsonSerializerProvider | ||
| with JacksonSearchJsonSerializerProvider; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| com.azure.core.serializer.json.jackson.JacksonSearchJsonSerializerProvider |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| <!-- | ||
| ~ Copyright (c) Microsoft Corporation. All rights reserved. | ||
| ~ Licensed under the MIT License. | ||
| --> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-client-sdk-parent</artifactId> | ||
| <version>1.7.0</version> <!-- {x-version-update;com.azure:azure-client-sdk-parent;current} --> | ||
| <relativePath>../../parents/azure-client-sdk-parent</relativePath> | ||
| </parent> | ||
|
|
||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-search-documents-serializer-jackson</artifactId> | ||
| <packaging>jar</packaging> | ||
| <version>1.0.0-beta.1</version> <!-- {x-version-update;com.azure:azure-search-documents-serializer-json-jackson;current} --> | ||
|
|
||
| <name>Microsoft Azure Search Jackson JSON Serializer Library</name> | ||
| <description>This package contains the Jackson JSON serializer client plugin for azure-search-documents.</description> | ||
| <url>https://github.com/Azure/azure-sdk-for-java</url> | ||
|
|
||
| <licenses> | ||
| <license> | ||
| <name>The MIT License (MIT)</name> | ||
| <url>http://opensource.org/licenses/MIT</url> | ||
| <distribution>repo</distribution> | ||
| </license> | ||
| </licenses> | ||
|
|
||
| <distributionManagement> | ||
| <site> | ||
| <id>azure-java-build-docs</id> | ||
| <url>${site.url}/site/${project.artifactId}</url> | ||
| </site> | ||
| </distributionManagement> | ||
|
|
||
| <scm> | ||
| <url>https://github.com/Azure/azure-sdk-for-java</url> | ||
| <connection>scm:git:https://github.com/Azure/azure-sdk-for-java.git</connection> | ||
| <developerConnection>scm:git:https://github.com/Azure/azure-sdk-for-java.git</developerConnection> | ||
| </scm> | ||
|
|
||
| <properties> | ||
| <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
| <legal><![CDATA[[INFO] Any downloads listed may be third party software. Microsoft grants you no rights for third party software.]]></legal> | ||
| </properties> | ||
|
|
||
| <developers> | ||
| <developer> | ||
| <id>microsoft</id> | ||
| <name>Microsoft</name> | ||
| </developer> | ||
| </developers> | ||
|
|
||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-core-experimental</artifactId> | ||
| <version>1.0.0-beta.2</version> <!-- {x-version-update;com.azure:azure-core;dependency} --> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-search-documents-serializer</artifactId> | ||
| <version>1.0.0-beta.1</version> | ||
| </dependency> | ||
|
|
||
| <!-- Test dependencies --> | ||
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
| <artifactId>junit-jupiter-api</artifactId> | ||
| <version>5.6.2</version> <!-- {x-version-update;org.junit.jupiter:junit-jupiter-api;external_dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
| <artifactId>junit-jupiter-engine</artifactId> | ||
| <version>5.6.2</version> <!-- {x-version-update;org.junit.jupiter:junit-jupiter-engine;external_dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.junit.jupiter</groupId> | ||
| <artifactId>junit-jupiter-params</artifactId> | ||
| <version>5.6.2</version> <!-- {x-version-update;org.junit.jupiter:junit-jupiter-params;external_dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>org.mockito</groupId> | ||
| <artifactId>mockito-core</artifactId> | ||
| <version>3.0.0</version><!-- {x-version-update;org.mockito:mockito-core;external_dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>io.projectreactor</groupId> | ||
| <artifactId>reactor-test</artifactId> | ||
| <version>3.3.5.RELEASE</version> <!-- {x-version-update;io.projectreactor:reactor-test;external_dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> | ||
|
|
||
| <profiles> | ||
| <profile> | ||
| <id>java-lts</id> | ||
| <activation> | ||
| <jdk>[11,)</jdk> | ||
| </activation> | ||
| <build> | ||
| <plugins> | ||
| <plugin> | ||
| <groupId>org.apache.maven.plugins</groupId> | ||
| <artifactId>maven-surefire-plugin</artifactId> | ||
| <version>3.0.0-M3</version> <!-- {x-version-update;org.apache.maven.plugins:maven-surefire-plugin;external_dependency} --> | ||
| <configuration> | ||
| <argLine> | ||
| --add-exports com.azure.search.documents.serializer.json.jackson/com.azure.search.documents.serializer.json.jackson=com.fasterxml.jackson.databind | ||
| --add-opens com.azure.search.documents.serializer.json.jackson/com.azure.search.documents.serializer.json.jackson=ALL-UNNAMED | ||
| </argLine> | ||
| </configuration> | ||
| </plugin> | ||
| </plugins> | ||
| </build> | ||
| </profile> | ||
| </profiles> | ||
|
|
||
| </project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.search.documents.serializer.jackson; | ||
|
|
||
| import com.azure.core.util.logging.ClientLogger; | ||
| import com.azure.search.documents.serializer.SearchSerializer; | ||
| import com.azure.search.documents.serializer.SearchType; | ||
| import com.azure.search.documents.serializer.SerializationInclusion; | ||
| import com.fasterxml.jackson.annotation.JsonInclude; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.type.TypeFactory; | ||
|
|
||
| import java.io.IOException; | ||
| import java.io.Reader; | ||
|
|
||
| public class SearchJacksonSerializer implements SearchSerializer { | ||
| private final ClientLogger logger = new ClientLogger(SearchJacksonSerializer.class); | ||
| private final ObjectMapper mapper; | ||
| private final TypeFactory typeFactory; | ||
|
|
||
| SearchJacksonSerializer(ObjectMapper mapper) { | ||
| this.mapper = mapper; | ||
| this.typeFactory = mapper.getTypeFactory(); | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T convertValue(Object o, SearchType<T> type) { | ||
| return mapper.convertValue(o, typeFactory.constructType(type.getType())); | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T convertValue(Object o, SearchType<T> type, SerializationInclusion inclusion) { | ||
| if (inclusion == SerializationInclusion.ALWAYS) { | ||
| mapper.setSerializationInclusion(JsonInclude.Include.ALWAYS); | ||
| } | ||
| return mapper.convertValue(o, typeFactory.constructType(type.getType())); | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T convertValue(Object o, Class<T> clazz) { | ||
| return mapper.convertValue(o, clazz); | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T convertValue(Object o, Class<T> clazz, SerializationInclusion inclusion) { | ||
| if (inclusion == SerializationInclusion.ALWAYS) { | ||
| mapper.setSerializationInclusion(JsonInclude.Include.ALWAYS); | ||
| } | ||
| return mapper.convertValue(o, clazz); | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T readValue(Reader reader, SearchType<T> type) { | ||
| try { | ||
| return mapper.readValue(reader, typeFactory.constructType(type.getType())); | ||
| } catch (IOException ex) { | ||
| throw logger.logExceptionAsError(new RuntimeException(ex)); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public <T> T readValue(String jsonString, SearchType<T> type) { | ||
| try { | ||
| return mapper.readValue(jsonString, typeFactory.constructType(type.getType())); | ||
| } catch (IOException ex) { | ||
| throw logger.logExceptionAsError(new RuntimeException(ex)); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,42 @@ | ||
| // Copyright (c) Microsoft Corporation. All rights reserved. | ||
| // Licensed under the MIT License. | ||
|
|
||
| package com.azure.search.documents.serializer.jackson; | ||
|
|
||
| import com.azure.core.util.serializer.JacksonAdapter; | ||
| import com.azure.search.documents.serializer.SearchSerializer; | ||
| import com.azure.search.documents.serializer.jackson.implementation.SerializationUtil; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
||
| public class SearchJacksonSerializerBuilder { | ||
| private ObjectMapper objectMapper; | ||
| private static final ObjectMapper DEFAULT_MAPPER; | ||
| static { | ||
| DEFAULT_MAPPER = new JacksonAdapter().serializer(); | ||
| SerializationUtil.configureMapper(DEFAULT_MAPPER); | ||
| } | ||
|
|
||
| /** | ||
| * Constructs a new instance of {@link SearchSerializer} with the configurations set in this builder. | ||
| * | ||
| * @return A new instance of {@link SearchSerializer}. | ||
| */ | ||
| public SearchSerializer build() { | ||
| return (objectMapper == null) | ||
| ? new SearchJacksonSerializer(DEFAULT_MAPPER) | ||
| : new SearchJacksonSerializer(objectMapper); | ||
| } | ||
|
|
||
| /** | ||
| * Sets the {@link ObjectMapper} that will be used during serialization. | ||
| * <p> | ||
| * If this is set to {@code null} the default {@link ObjectMapper} will be used. | ||
| * | ||
| * @param objectMapper {@link ObjectMapper} that will be used during serialization. | ||
| * @return The updated JacksonJsonSerializerBuilder class. | ||
| */ | ||
| public SearchJacksonSerializerBuilder serializer(ObjectMapper objectMapper) { | ||
| this.objectMapper = objectMapper; | ||
| return this; | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is fine for testing this, in the future when this work is merged into Azure Core it'll become package private again.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Right, I think it doesn't hurt to public the serializer before we move back Azure Core.