docs: Improve SpringQueryMap documentation #1163
Open
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.
Problem
When using the
@SpringQueryMap
annotation, it was difficult to discover the existence of theQueryMapEncoder
class.The reference path is as follows:
@SpringQueryMap -> @QueryMap -> @Param Usage All
Additionally, when using
@SpringQueryMap
, the default injected implementation isFieldQueryMapEncoder
.However, in
FeignClientsConfiguration
, the injected bean can change depending on the@ConditionalOnClass
condition.Although
FieldQueryMapEncoder
is marked as deprecated inQueryMapEncoder
, it still functions as the default implementation.Solution
I have explicitly specified this behavior in the annotation documentation.
I encountered this issue while debugging, and it took me a long time to identify the cause.
By adding this information, I hope others can find the relevant details more quickly.
Consideration
I initially considered adding the note:
However, since this behavior is subject to change, I decided not to include it.
If necessary, I am open to adding this detail.