Give FieldNamingStrategy the ability to return multiple String names #2776

mfriesen · 2024-11-15T23:49:54Z

Purpose

This pull request enhances the FieldNamingStrategy in Gson to support returning multiple strings for a field name. This behavior aligns with the alternate names functionality provided by the @SerializedName annotation, allowing for greater flexibility in field mapping.

Description

The FieldNamingStrategy interface has been updated to allow implementations to return a list of potential field name mappings. This allows deserialization to succeed if any of the alternate names are present in the JSON data.

The changes include is to modifying the FieldNamingStrategy interface to support returning a collection of names. This allows the FieldNamingStrategy interface to behave like the @SerializedName annotation.

Checklist

[ X] New code follows the Google Java Style Guide
This is automatically checked by mvn verify, but can also be checked on its own using mvn spotless:check.
Style violations can be fixed using mvn spotless:apply; this can be done in a separate commit to verify that it did not cause undesired changes.
[X ] If necessary, new public API validates arguments, for example rejects null
[X ] New public API has Javadoc
- [ X] Javadoc uses @since $next-version$
  ( $next-version$ is a special placeholder which is automatically replaced during release)
[ X] If necessary, new unit tests have been added
- [ X] Assertions in unit tests use Truth, see existing tests
- [X ] No JUnit 3 features are used (such as extending class TestCase)
- [X ] If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
[X ] mvn clean verify javadoc:jar passes without errors

Marcono1234 · 2024-11-16T21:40:21Z

Thanks for this suggestion! It seems that would resolve #1002

However, we cannot change the return type of translateName from String to List<String> since that would be an incompatible change.
But what might be possible, similar to @SerializedName#alternate, is adding an additional method to FieldNamingStrategy, for example translateToAlternateNames(Field): List<String> (or a better name). The next Gson version will target Java 8, so we could provide a default implementation of this method which returns an empty list. This should preserve backward compatibility.

This is just an idea though, maybe there are other possible approaches.

mfriesen · 2024-11-16T21:55:31Z

@Marcono1234 Great idea. I wasn't sure what the best approach would be. I'll review your suggestion and see if I can get it to work.

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

Marcono1234

Thanks for the changes!

The build currently fails due to formatting violations. You can solve this by running mvn spotless:apply.

Also note that the commits are squashed on merge here, so you don't have to force-push / rewrite commits, but instead can incrementally make changes to this pull request.

@eamonnmcmanus what do you think about these proposed changes?

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

- Changed fieldName to be added first to the fieldName list - test which verifies that when 'alternate names' are configured they don't affect serialization, and only affect deserialization - Updated translateToAlternateNames JavaDoc to refer it works like SerializedName#alternate()

Check Android compatibility test fails when using Stream.concat, switched to traditional Java method.

Marcono1234

Thanks for your changes! A few more small points, but looks good besides that.

We will however have to wait for the opinion and review from a direct Gson maintainer then.

gson/src/test/java/com/google/gson/functional/NamingPolicyTest.java

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

1. Renamed badname to primary-name 2. Added test deserializing TranslateName with translateToAlternateNames

mfriesen · 2025-04-12T01:31:59Z

@Marcono1234 Is there anything else I need to do for this PR?

eamonnmcmanus

Sorry, I lost sight of this. I think it makes sense. Just a couple of suggestions.

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

+   * @return the list of possible translated field names.
+   * @since $next-version$
+   */
+  default List<String> alternateNames(Field f) {


eamonnmcmanus

Thanks! Just a couple of small things...

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java

Marcono1234

Thanks a lot for updating this pull request! I have also added some small suggestion comments, hopefully that is ok for you.

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java

gson/src/test/java/com/google/gson/functional/NamingPolicyTest.java

Co-authored-by: Marcono1234 <[email protected]>

…eAdapterFactory.java Co-authored-by: Marcono1234 <[email protected]>

….java Co-authored-by: Marcono1234 <[email protected]>

eamonnmcmanus

This looks good to me, but I will wait for @Marcono1234 before merging.

Marcono1234 · 2025-04-24T08:43:18Z

@eamonnmcmanus, I think if we strictly followed SemVer, the latest version should have been 2.14.0 (instead of 2.13.1) since this PR here added a new method. But hopefully that does not matter that much.

eamonnmcmanus · 2025-04-24T14:53:21Z

@eamonnmcmanus, I think if we strictly followed SemVer, the latest version should have been 2.14.0 (instead of 2.13.1) since this PR here added a new method. But hopefully that does not matter that much.

Yes, I realized that when it came time to draft the release notes, but I'd already published the release at that point. I agree that it doesn't matter very much.

mfriesen force-pushed the FieldNameStrategy branch from 3bc670e to 0d769c7 Compare November 17, 2024 05:27

Give FieldNamingStrategy the ability to return multiple String names

94c9ea2

mfriesen force-pushed the FieldNameStrategy branch from 0d769c7 to 94c9ea2 Compare November 17, 2024 05:29

github-advanced-security bot found potential problems Nov 17, 2024

View reviewed changes

gson/src/main/java/com/google/gson/FieldNamingStrategy.java Fixed Show resolved Hide resolved

Marcono1234 reviewed Nov 17, 2024

View reviewed changes

mfriesen added 3 commits November 17, 2024 09:43

Fixed formatting violations

4ebc2c7

Removed usage of Stream.concat

c9e39dd

Check Android compatibility test fails when using Stream.concat, switched to traditional Java method.

Marcono1234 reviewed Nov 20, 2024

View reviewed changes

gson/src/test/java/com/google/gson/functional/NamingPolicyTest.java Show resolved Hide resolved

gson/src/main/java/com/google/gson/FieldNamingStrategy.java Outdated Show resolved Hide resolved

gson/src/main/java/com/google/gson/FieldNamingStrategy.java Show resolved Hide resolved

mfriesen added 3 commits November 20, 2024 20:51

Code Review Changes

705e97b

1. Renamed badname to primary-name 2. Added test deserializing TranslateName with translateToAlternateNames

Fixed typo

5bab616

added @SInCE $next-version$ to translateToAlternateNames method

d88b415

Marcono1234 approved these changes Nov 29, 2024

View reviewed changes

Marcono1234 requested a review from eamonnmcmanus November 29, 2024 21:32

eamonnmcmanus requested changes Apr 12, 2025

View reviewed changes

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java Outdated Show resolved Hide resolved

gson/src/main/java/com/google/gson/FieldNamingStrategy.java Outdated Show resolved Hide resolved

mfriesen added 2 commits April 11, 2025 21:15

Renamed translateToAlternateNames to alternateNames

24591cb

Merged the code with and without the SerializedName annotation

8d4cda8

github-advanced-security bot found potential problems Apr 12, 2025

View reviewed changes

gson/src/main/java/com/google/gson/FieldNamingStrategy.java

* @return the list of possible translated field names.

* @since $next-version$

*/

default List<String> alternateNames(Field f) {

Check notice

Code scanning / CodeQL

Useless parameter Note

The parameter 'f' is never used.

eamonnmcmanus requested changes Apr 12, 2025

View reviewed changes

gson/src/main/java/com/google/gson/FieldNamingStrategy.java Outdated Show resolved Hide resolved

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java Show resolved Hide resolved

mfriesen added 2 commits April 12, 2025 10:09

Improved FieldNamingStrategy JavaDoc for the alternateNames method.

07e7535

Added special handling for annotation without alternate names

1b21c39

eamonnmcmanus requested changes Apr 12, 2025

View reviewed changes

gson/src/main/java/com/google/gson/internal/bind/ReflectiveTypeAdapterFactory.java Outdated Show resolved Hide resolved

Moved Collections.singletonList block to apply to both cases

b73490e

Marcono1234 reviewed Apr 13, 2025

View reviewed changes

mfriesen and others added 3 commits April 13, 2025 10:09

Update gson/src/main/java/com/google/gson/FieldNamingStrategy.java

f2b658e

Co-authored-by: Marcono1234 <[email protected]>

Update gson/src/main/java/com/google/gson/internal/bind/ReflectiveTyp…

73cd1a2

…eAdapterFactory.java Co-authored-by: Marcono1234 <[email protected]>

Update gson/src/test/java/com/google/gson/functional/NamingPolicyTest…

fdb0519

….java Co-authored-by: Marcono1234 <[email protected]>

mfriesen and others added 2 commits April 13, 2025 10:09

Update gson/src/test/java/com/google/gson/functional/NamingPolicyTest…

faf7409

….java Co-authored-by: Marcono1234 <[email protected]>

Update gson/src/test/java/com/google/gson/functional/NamingPolicyTest…

5de714d

….java Co-authored-by: Marcono1234 <[email protected]>

eamonnmcmanus approved these changes Apr 13, 2025

View reviewed changes

Marcono1234 approved these changes Apr 13, 2025

View reviewed changes

eamonnmcmanus merged commit 4e65e6a into google:main Apr 13, 2025
11 checks passed

mfriesen mentioned this pull request May 19, 2025

lambda-java-events support seems to be limited formkiq/lambda-runtime-graalvm#19

Closed

Give FieldNamingStrategy the ability to return multiple String names #2776

Give FieldNamingStrategy the ability to return multiple String names #2776

Uh oh!

Conversation

mfriesen commented Nov 15, 2024

Purpose

Description

Checklist

Uh oh!

Marcono1234 commented Nov 16, 2024

Uh oh!

mfriesen commented Nov 16, 2024

Uh oh!

Uh oh!

Marcono1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Marcono1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mfriesen commented Apr 12, 2025

Uh oh!

eamonnmcmanus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Check notice

eamonnmcmanus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Marcono1234 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eamonnmcmanus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Marcono1234 commented Apr 24, 2025

Uh oh!

eamonnmcmanus commented Apr 24, 2025

Uh oh!

Uh oh!