Skip to content

Commit

Permalink
Polish "Document RedisCacheManagerBuilderCustomizer"
Browse files Browse the repository at this point in the history
  • Loading branch information
snicoll committed Jan 20, 2020
1 parent 61d8bac commit 3dba4c8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -4771,19 +4771,20 @@ For instance, the following configuration creates `cache1` and `cache2` caches w
spring.cache.redis.time-to-live=600000
----

If you require more control over `RedisCacheManager` e.g. set _time to live_ for the particular caches, you can customize `org.springframework.data.redis.cache.RedisCacheManager$RedisCacheManagerBuilder`
programmatically by declaring `RedisCacheManagerBuilderCustomizer` bean(s) as shown in the following example:
NOTE: By default, a key prefix is added so that, if two separate caches use the same key, Redis does not have overlapping keys and cannot return invalid values.
We strongly recommend keeping this setting enabled if you create your own `RedisCacheManager`.

TIP: You can take full control of the default configuration by adding a `RedisCacheConfiguration` `@Bean` of your own.
This can be useful if you're looking for customizing the default serialization strategy.

If you need more control over the configuration, consider registering a `RedisCacheManagerBuilderCustomizer` bean.
The following example shows a customizer that configures a specific time to live for `cache1` and `cache2`:

[source,java,indent=0]
----
include::{code-examples}/cache/redis/RedisCacheManagerBuilderCustomizerConfiguration.java[tag=configuration]
include::{code-examples}/cache/RedisCacheManagerCustomizationExample.java[tag=configuration]
----

NOTE: By default, a key prefix is added so that, if two separate caches use the same key, Redis does not have overlapping keys and cannot return invalid values.
We strongly recommend keeping this setting enabled if you create your own `RedisCacheManager`.

TIP: You can take full control of the configuration by adding a `RedisCacheConfiguration` `@Bean` of your own.
This can be useful if you're looking for customizing the serialization strategy.



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
* limitations under the License.
*/

package org.springframework.boot.docs.cache;

import java.time.Duration;

import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer;
Expand All @@ -27,19 +29,19 @@
*
* @author Dmytro Nosan
*/
// tag::configuration[]
@Configuration(proxyBeanMethods = false)
public class RedisCacheManagerBuilderCustomizerConfiguration {
public class RedisCacheManagerCustomizationExample {

// tag::configuration[]
@Bean
public RedisCacheManagerBuilderCustomizer ttlRedisCacheManagerBuilderCustomizer() {
public RedisCacheManagerBuilderCustomizer myRedisCacheManagerBuilderCustomizer() {
return (builder) -> builder
.withCacheConfiguration("cache1",
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofSeconds(10)))
.withCacheConfiguration("cache2",
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofMinutes(1)));

}
// end::configuration[]

}
// end::configuration[]

0 comments on commit 3dba4c8

Please sign in to comment.