HHH-19711 Improve mapped-by + join-column exception message with the full property path #10760
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
mbellade
reviewed
Aug 14, 2025
hibernate-core/src/main/java/org/hibernate/boot/model/internal/AnnotatedJoinColumn.java
Outdated
Show resolved
Hide resolved
mbellade
approved these changes
Aug 14, 2025
gavinking
requested changes
Aug 14, 2025
| throw new AnnotationException( | ||
| String.format( | ||
| Locale.ROOT, | ||
| "Association '%s' is 'mappedBy=%s' a different entity and may not explicitly specify the '@JoinColumn'", |
There was a problem hiding this comment.
Folks, I definitely appreciate the desire to improve error messages, but I think this change makes the message worse:
... is 'mappedBy=%s' a different entitydoesn't read like a well-formed English sentence, and it's not even correct Java (it has missing quotes). If you really think it's important to include the name of the mapping attribute, it should be... is 'mappedBy' the attribute '%s' of a different entity.- If I'm not mistaken, I used
getRelativePath()here very deliberately because I didn't want a long-ass qualified name right at the start of the exception message. That really harms readability of the message. When we include full-qualified names, we usually try to put them at the end of the error message.
Yes, I'm aware I'm being super-anal here.
There was a problem hiding this comment.
Perhaps:
"Association '%s' of entity '%s' is 'mappedBy' a different entity and may not explicitly specify the '@JoinColumn'"
where the second %s is the (unqualified) entity name.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
https://hibernate.atlassian.net/browse/HHH-19711
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.