Auto detect records for Jackson serialization#993
Merged
electrum merged 1 commit intoJun 13, 2022
Conversation
Contributor
Author
Randgalt
force-pushed
the
jordanz/auto-detect-records-for-jackson
branch
2 times, most recently
from
9c6748e to
7733c63
Compare
Contributor
Would it make sense to have a Java 17-based test module to verify Java 17-related Airlift behavior? |
Contributor
Author
Yes - I think it does. However, I would do it as a separate PR. It will make the CI more complicated. |
Randgalt
force-pushed
the
jordanz/auto-detect-records-for-jackson
branch
from
7733c63 to
c8e8355
Compare
electrum
approved these changes
Jun 10, 2022
| private static boolean isRecord(Class<?> clazz) | ||
| { | ||
| Class<?> superclass = (clazz != null) ? clazz.getSuperclass() : null; | ||
| return (superclass != null) && superclass.getName().equals("java.lang.Record") && ((clazz.getModifiers() & Modifier.FINAL) != 0); |
Member
There was a problem hiding this comment.
I think Modifier.isFinal(clazz.getModifiers()) is the preferred way
Randgalt
force-pushed
the
jordanz/auto-detect-records-for-jackson
branch
2 times, most recently
from
d6bb735 to
358d307
Compare
electrum
approved these changes
Jun 11, 2022
Randgalt
force-pushed
the
jordanz/auto-detect-records-for-jackson
branch
from
358d307 to
5d445a3
Compare
electrum
reviewed
Jun 13, 2022
| public class RecordAutoDetectModule | ||
| extends SimpleModule | ||
| { | ||
| private static final Optional<MethodHandle> isRecord; |
Member
There was a problem hiding this comment.
Make uppercase since this is a constant
| public Introspector() | ||
| { | ||
| recordVisibilityChecker = VisibilityChecker.Std.defaultInstance() | ||
| .withGetterVisibility(JsonAutoDetect.Visibility.PUBLIC_ONLY) |
Member
There was a problem hiding this comment.
Is it intended that this is duplicated below?
|
|
||
| public Introspector() | ||
| { | ||
| recordVisibilityChecker = VisibilityChecker.Std.defaultInstance() |
| { | ||
| try { | ||
| // TODO replace with real call to isRecord() when Airlift is on Java 14+ | ||
| return (Boolean) methodHandle.invoke(ac.getRawType()); |
Member
There was a problem hiding this comment.
You should be able to use invokeExact() here and cast to (boolean) to avoid boxing.
electrum
reviewed
Jun 13, 2022
| try { | ||
| //noinspection JavaLangInvokeHandleSignature | ||
| methodHandle = MethodHandles.lookup() | ||
| .findVirtual(Class.class, "isRecord", methodType(Boolean.TYPE)); |
Member
There was a problem hiding this comment.
One more nit: use boolean.class here for the primitive class reference
Currently, record serialization requires annotating records with `@JsonAutoDetect(getterVisibility = PUBLIC_ONLY)`. This is a nuisance and can be hard to debug when it's forgotten (Jackson serializes to an empty object when it's missing). Add a Jackson module that auto-detects Records and sets the visibility to match the annotation. Note: Airlift is currently at Java 11 so record detection is not ideal (though it mimics what the JDK does). Once Airlift is at Java 17 it can be updated and a test can be added.
Randgalt
force-pushed
the
jordanz/auto-detect-records-for-jackson
branch
from
5d445a3 to
d6dc459
Compare
electrum
approved these changes
Jun 13, 2022
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.
Currently, record serialization requires annotating records with
@JsonAutoDetect(getterVisibility = PUBLIC_ONLY). This is a nuisanceand can be hard to debug when it's forgotten (Jackson serializes
to an empty object when it's missing).
Add a Jackson module that auto-detects Records and sets
the visibility to match the annotation. Note: Airlift is
currently at Java 11 so record detection is not ideal (though it
mimics what the JDK does). Once Airlift is at Java 17 it can
be updated and a test can be added.
Note: I tested this in Java 17 project independently to verify that it works.