spring-cloud/spring-cloud-gateway

Add customization options to ResponseCacheGatewayFilter

Open

#3,429 opened on Jun 12, 2024

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Java (4,284 stars) (3,204 forks)batch import
enhancementhelp wanted

Description

Is your feature request related to a problem? Please describe. I have a specfic kind of caching logic that should not use the header values. In the current implementation of the CacheKeyGenerator there is a static list of key generators that I cannot modify.

Describe the solution you'd like Add an api or spring mechanism to change the key generator.

Describe alternatives you've considered I tried to modify that static field at runtime but this approach is really hacky.

Additional context I have not used spring for a long time. Maybe there is already a way to change the CacheKeyGenerator or ResponseCache implementation.

Contributor guide

Tech stack
java
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic understanding of Spring Cloud GatewayJava
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Investigate the current implementation of CacheKeyGenerator in ResponseCacheGatewayFilter, which uses a static list of key generators. Explore ways to allow users to customize the key generator, such as introducing a Spring bean or a configuration property. Look at the source code in spring cloud gateway's filter package, specifically the ResponseCacheGatewayFilter and CacheKeyGenerator classes. Consider if a strategy pattern or an extension point via Spring's ApplicationContext can be used.