Document RedisCacheManagerBuilderCustomizer

See gh-19819
This commit is contained in:
Dmytro Nosan 2020-01-20 16:27:19 +02:00 committed by Stephane Nicoll
parent 7693d332fa
commit 61d8bacd23
2 changed files with 53 additions and 0 deletions

View File

@ -4771,6 +4771,14 @@ 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:
[source,java,indent=0]
----
include::{code-examples}/cache/redis/RedisCacheManagerBuilderCustomizerConfiguration.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`.

View File

@ -0,0 +1,45 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.time.Duration;
import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
/**
* An example how to customize {@code RedisCacheManagerBuilder} via
* {@code RedisCacheManagerBuilderCustomizer}.
*
* @author Dmytro Nosan
*/
// tag::configuration[]
@Configuration(proxyBeanMethods = false)
public class RedisCacheManagerBuilderCustomizerConfiguration {
@Bean
public RedisCacheManagerBuilderCustomizer ttlRedisCacheManagerBuilderCustomizer() {
return (builder) -> builder
.withCacheConfiguration("cache1",
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofSeconds(10)))
.withCacheConfiguration("cache2",
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofMinutes(1)));
}
}
// end::configuration[]