[LOG4J2-2948] Use IdentityHashMap for ParameterFormatter deja vu

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Fix Version/s: 2.14.1
• Assignee: Volkan Yazici
• Reporter: Marcono1234
• Created: 18/Oct/20 21:08
• Updated: 04/Mar/21 12:28
• Resolved: 04/Mar/21 12:28

Description

org.apache.logging.log4j.message.ParameterFormatter currently uses its identityToString(Object) method to create identifier strings for detecting recursive objects.

However, as noted by the description of that method, this approach is not completely foolproof:

     * As much as is reasonably practical, the hashCode method defined by
     * class {@code Object} does return distinct integers for distinct
     * objects. (This is typically implemented by converting the internal
     * address of the object into an integer, but this implementation
     * technique is not required by the Java™ programming language.)

Would it make sense to switch to JDK's java.util.IdentityHashMap (converted to Set using Collections.newSetFromMap)? I would assume, but have not tested it, that performance will also be better because it simply tests for equality by checking for reference equality whereas the current approach needs to compare strings.

Issue Links

• links to: GitHub Pull Request #471