-
Notifications
You must be signed in to change notification settings - Fork 59
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Support jackson @JsonUnwrapped annotation (#362)
- Loading branch information
1 parent
5965fdd
commit baea9b6
Showing
8 changed files
with
169 additions
and
16 deletions.
There are no files selected for viewing
This file contains 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 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 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
122 changes: 122 additions & 0 deletions
122
...n/java/com/github/victools/jsonschema/module/jackson/JsonUnwrappedDefinitionProvider.java
This file contains 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,122 @@ | ||
| /* | ||
| * Copyright 2023 VicTools. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.github.victools.jsonschema.module.jackson; | ||
|
|
||
| import com.fasterxml.classmate.ResolvedType; | ||
| import com.fasterxml.classmate.ResolvedTypeWithMembers; | ||
| import com.fasterxml.classmate.members.RawMember; | ||
| import com.fasterxml.classmate.members.ResolvedMember; | ||
| import com.fasterxml.jackson.annotation.JsonUnwrapped; | ||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.node.ArrayNode; | ||
| import com.fasterxml.jackson.databind.node.ObjectNode; | ||
| import com.github.victools.jsonschema.generator.CustomDefinition; | ||
| import com.github.victools.jsonschema.generator.CustomDefinitionProviderV2; | ||
| import com.github.victools.jsonschema.generator.SchemaGenerationContext; | ||
| import com.github.victools.jsonschema.generator.SchemaKeyword; | ||
| import java.lang.annotation.Annotation; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Optional; | ||
| import java.util.stream.Stream; | ||
|
|
||
| /** | ||
| * Definition provider handling the integration of properties with the {@link JsonUnwrapped} annotation. | ||
| * | ||
| * @since 4.32.0 | ||
| */ | ||
| public class JsonUnwrappedDefinitionProvider implements CustomDefinitionProviderV2 { | ||
|
|
||
| @Override | ||
| public CustomDefinition provideCustomSchemaDefinition(ResolvedType javaType, SchemaGenerationContext context) { | ||
| if (javaType.getMemberFields().stream().noneMatch(this::hasJsonUnwrappedAnnotation) | ||
| && javaType.getMemberMethods().stream().noneMatch(this::hasJsonUnwrappedAnnotation)) { | ||
| // no need for custom handling here, if no relevant annotation is present | ||
| return null; | ||
| } | ||
| // include the target type itself (assuming the annotated members are being ignored then) | ||
| ObjectNode definition = context.createStandardDefinition(javaType, this); | ||
| ArrayNode allOf = definition.withArray(context.getKeyword(SchemaKeyword.TAG_ALLOF)); | ||
| // include each annotated member's type considering the optional prefix and/or suffix | ||
| ResolvedTypeWithMembers typeWithMembers = context.getTypeContext().resolveWithMembers(javaType); | ||
|
|
||
| Stream.concat(Stream.of(typeWithMembers.getMemberFields()), Stream.of(typeWithMembers.getMemberMethods())) | ||
| .filter(member -> Optional.ofNullable(member.getAnnotations().get(JsonUnwrapped.class)) | ||
| .filter(JsonUnwrapped::enabled).isPresent()) | ||
| .map(member -> this.createUnwrappedMemberSchema(member, context)) | ||
| .forEachOrdered(allOf::add); | ||
|
|
||
| return new CustomDefinition(definition); | ||
| } | ||
|
|
||
| /** | ||
| * Check whether the given field/method's type should be "unwrapped", i.e., elevating their properties to this member's type. | ||
| * | ||
| * @param member field/method to check | ||
| * @return whether the given member has an {@code enabled} {@link JsonUnwrapped @JsonUnwrapped} annotation | ||
| */ | ||
| private boolean hasJsonUnwrappedAnnotation(RawMember member) { | ||
| for (Annotation annotation : member.getAnnotations()) { | ||
| if (annotation instanceof JsonUnwrapped && ((JsonUnwrapped) annotation).enabled()) { | ||
| return true; | ||
| } | ||
| } | ||
| return false; | ||
| } | ||
|
|
||
| /** | ||
| * Create a schema representing an unwrapped member's type. Contained properties may get a certain prefix and/or suffix applied to their names. | ||
| * | ||
| * @param member field/method of which to unwrap the associated type | ||
| * @param context generation context | ||
| * @return created schema | ||
| */ | ||
| private ObjectNode createUnwrappedMemberSchema(ResolvedMember<?> member, SchemaGenerationContext context) { | ||
| ObjectNode definition = context.createStandardDefinition(member.getType(), null); | ||
| JsonUnwrapped annotation = member.getAnnotations().get(JsonUnwrapped.class); | ||
| if (!annotation.prefix().isEmpty() || !annotation.suffix().isEmpty()) { | ||
| this.applyPrefixAndSuffixToPropertyNames(definition, annotation.prefix(), annotation.suffix(), context); | ||
| } | ||
| return definition; | ||
| } | ||
|
|
||
| /** | ||
| * Rename the properties defined in the given schema by prepending the given suffix and appending the given suffix. | ||
| * | ||
| * @param definition schema in which to alter contained properties' names | ||
| * @param prefix prefix to prepend to all contained properties' names (may be an empty string) | ||
| * @param suffix suffix to append to all contained properties' names (may be an empty string) | ||
| * @param context generation context | ||
| */ | ||
| private void applyPrefixAndSuffixToPropertyNames(JsonNode definition, String prefix, String suffix, SchemaGenerationContext context) { | ||
| JsonNode properties = definition.get(context.getKeyword(SchemaKeyword.TAG_PROPERTIES)); | ||
| if (properties instanceof ObjectNode && !properties.isEmpty()) { | ||
| List<String> fieldNames = new ArrayList<>(); | ||
| properties.fieldNames().forEachRemaining(fieldNames::add); | ||
| for (String fieldName : fieldNames) { | ||
| JsonNode propertySchema = ((ObjectNode) properties).remove(fieldName); | ||
| ((ObjectNode) properties).set(prefix + fieldName + suffix, propertySchema); | ||
| } | ||
| } | ||
| JsonNode allOf = definition.get(context.getKeyword(SchemaKeyword.TAG_ALLOF)); | ||
| if (allOf instanceof ArrayNode) { | ||
| // this only considers inlined parts and not any to-be-referenced subschema | ||
| allOf.forEach(allOfEntry -> this.applyPrefixAndSuffixToPropertyNames(allOfEntry, prefix, suffix, context)); | ||
| } | ||
| // keeping it simple for now (version 4.32.0) and not considering all potential nested properties | ||
| } | ||
| } |
This file contains 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 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 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 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