feat: Infer discriminator mapping#4983
Open
PatrickFeiring wants to merge 1 commit into
Open
Conversation
PatrickFeiring
force-pushed
the
feat/infer-discriminator-mapping
branch
2 times, most recently
from
ccfd386 to
f744259
Compare
PatrickFeiring
force-pushed
the
feat/infer-discriminator-mapping
branch
3 times, most recently
from
4458fd5 to
0e36b96
Compare
Author
|
I've rebased the PR on master, made it a bit more conservative about when discriminator mappings are added, added support for default property names, and made the finding of subtype match the resolveSubtypes method. I've tested it on older Jackson versions as well to make it is compatible. Let me know if there is anything missing for it to be reviewed |
PatrickFeiring
force-pushed
the
feat/infer-discriminator-mapping
branch
from
0e36b96 to
c13f6fc
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
This PR adds inference of discriminator mappings when an explicit mapping is not present, which should greatly reduce the need for explicit
@DiscriminatorMappingannotations and make it easier to keep the mapping in sync.The basic theme of the approach is to leave as much resolving to Jackson as possible. This is done by instantiating a type serializer for the class, and letting Jackson compute the ids used in the mapping. This means that type ids from all the following sources are supported
@JsonSubTypes.Typeannotations@JsonTypeNameannotationsJsonTypeInfo.Idin@JsonTypeInfoannotationsIt also means we support things such as default property names when no property value is set on the
@JsonTypeInfoannotation (@type) and the fallback toJsonTypeInfo.As.PROPERTYwhenJsonTypeInfo.As.EXTERNAL_PROPERTYis used on a class.It tries to be conservative and add only a discriminator mapping when it is applicable, e.g. not for
JsonTypeInfo.As.WRAPPER_ARRAY. It keeps the old behaviour of using an explicit discriminator mapping if present.The main
resolveDiscriminatordo have a new signature, which is a breaking change for those subclassing and overriding. The new signature should be sensible as it matches that ofresolveSubtypes, and resolving subtypes is similar to determining the discriminator mappings. It is tricky to keep this backwards compatible while still making it handle the more general cases, but migration path is super easy and hopefully most overriding is not needed any more.I've also tested that it works on the Jackson 2.8 version. Despite the readme mentioning support from 2.4 and newer, the model resolver uses functionality in Jackson only available from 2.8, so I assumed that sufficed.
Closes: #3411
Type of Change
Checklist
Screenshots / Additional Context