Use Threadlocal.remove() instead of .set(null) in documentation #32874
Conversation
This file contains 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
spring-projects-issues
added
the
status: waiting-for-triage
jhoeller
added
type: documentation
snicoll
pushed a commit
that referenced
this pull request
May 23, 2024
|
Good catch, thanks @Seungpang |
jhoeller
added a commit
that referenced
this pull request
May 28, 2024
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.
Hi Team,
This PR updates the Spring Framework documentation to recommend using
ThreadLocal.remove()instead ofThreadLocal.set(null)when unsetting aThreadLocalvalue.The current documentation suggests using
ThreadLocal.set(null)to unset aThreadLocalvalue. However, this approach can lead to memory leaks and other unexpected behaviors, particularly in multi-threaded and multi-classloader environments. UsingThreadLocal.set(null)does not completely remove theThreadLocalinstance, which means the associated memory may not be fully released. This can cause data inconsistencies and unexpected behaviors.In the Spring Framework itself,
ThreadLocal.remove()is used to ensure that theThreadLocalvalues are properly cleaned up, preventing potential memory leaks and ensuring consistent behavior across different environments.