Add custom Gson type adapter factories during runtime
#10437
Conversation
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
oracle-contributor-agreement
bot
added
the
OCA Verified
|
@eiselems maybe this is of interest to you. |
|
@tomas-langer sounds like something that I missed, maybe you can also have a look |
|
@Verdent @tomas-langer do you have feedback about this change request? I would appreciate if this get merged soon. |
It is not currently possible to add custom Gson type adapters in a modular way at runtime. Adding them requires manually instantiating GsonSupport, which undermines the modular approach of extending Helidon with media type implementations. To resolve this, I have added the ability to add custom TypeAdapterFactory instances as service providers. These providers are loaded during the initialization of GsonSupport by the GsonMediaSupportProvider using Java's ServiceLoader API. This allows for a more flexible and modular way to extend Gson's functionality within Helidon.
arouel
force-pushed
the
gson-register
branch
from
eadc816 to
6d4b3fe
Compare
|
|
||
| GsonBuilder gsonBuilder = new GsonBuilder(); | ||
| // Enable the registering of custom type adapters by using service providers for TypeAdapterFactory. | ||
| for (var factory : ServiceLoader.load(TypeAdapterFactory.class)) { |
There was a problem hiding this comment.
- there must be a
uses com.google.gson.TypeAdapterFactorystatement inmodule-info.java, otherwise this would fail on module path - we never use Java service loader directly, please use
io.helidon.common.HelidonServiceLoader#create(java.lang.Class<T>)- this supports@Weightto order providers - the
gsoninstance you create is lost
How to do this to align with current implementation:
- add the following method to
GsonSupportConfigBlueprintto allow users to register them programmatically:
/**
* Additional type adapter factories.
*
* @returns type adapter factories
*/
@Option.Singular("typeAdapterFactory")
List<TypeAdapterFactory> typeAdapterFactories();
- add the discovered factories to the builder created on line 85 (in the original code)
- update method
io.helidon.http.media.gson.GsonSupport.Decorator#decorate- add the factories from thetargetbuilder to theGsonBuilderinstance.
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
It is currently not possible to add custom
Gsontype adapters in a modular way at runtime. Adding them requires manually instantiatingGsonSupport, which undermines the modular approach of extending Helidon with media type implementations.To resolve this, I have added the ability to add custom
TypeAdapterFactoryinstances as service providers. These providers are loaded during the initialization ofGsonSupportby theGsonMediaSupportProviderusing Java'sServiceLoaderAPI. This allows in a modular way to extend Gson's functionality within Helidon.More details how to use it can be found in issue #10435.