Skip to content

Cacheable key collision with DefaultKeyGenerator [SPR-10237] #14870

Closed

Description

@spring-projects-issues

Morten Haraldsen opened SPR-10237 and commented

The default is to use the hashcode of each parameter and create another (32-bit) hash code. Obviously this can easily generate collisions. This should be clearly documented as it feels like a pretty serious issue, if not a bug. We have come to expect that Spring defaults are "safe" :-)


Affects: 3.2 GA

Reference URL: http://blog.ethlo.com/2013/01/30/spring-defaultkeygenerator-gotcha

Issue Links:

Referenced from: commits f1a18d2

3 votes, 8 watchers

Activity

  1. spring-projects-issues commented on Feb 1, 2013

    @spring-projects-issues
    CollaboratorAuthor

    Tomasz Nurkiewicz commented

    Looks like a duplicate of #13675 and #14013.

  2. spring-projects-issues commented on Jun 21, 2013

    @spring-projects-issues
    CollaboratorAuthor

    Phil Webb commented

    Spring 4.0 will now use the SimpleKeyGenerator class to generate cache keys if no specific KeyGenerator is configured. The DefaultKeyGenerator remains available for applications that do not wish to migrate.

    I have stopped sort of including the target object or method name inside the key (as suggested in #13675). The primary reason for this is that the same key needs to be generated for @Cacheable, @CachePut and @CacheEvict annotated method, which will most likely be on different methods and potentially different beans.

    For any method with a single non-null parameter, the result of SimpleKeyGenerator is identical to DefaultKeyGenerator. In other cases it is possible that the SimpleKey type might not be compatible with all Cache implementations. Given the number of times that this bug has been raised I think this restriction is acceptable, however, since this is a potentially breaking change I do not intend to back-port to 3.2.x

  3. added this to the 4.0 M2 milestone on Jan 11, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

in: coreIssues in core modules (aop, beans, core, context, expression)type: bugA general bug

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions