Skip to content

Commit 94b1460

Browse files
committed
Merge pull request #19819 from nosan
* pr/19819: Polish "Document RedisCacheManagerBuilderCustomizer" Document RedisCacheManagerBuilderCustomizer Closes gh-19819
2 parents 7693d33 + 3dba4c8 commit 94b1460

File tree

2 files changed

+58
-2
lines changed

2 files changed

+58
-2
lines changed

spring-boot-project/spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4774,8 +4774,17 @@ For instance, the following configuration creates `cache1` and `cache2` caches w
47744774
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.
47754775
We strongly recommend keeping this setting enabled if you create your own `RedisCacheManager`.
47764776

4777-
TIP: You can take full control of the configuration by adding a `RedisCacheConfiguration` `@Bean` of your own.
4778-
This can be useful if you're looking for customizing the serialization strategy.
4777+
TIP: You can take full control of the default configuration by adding a `RedisCacheConfiguration` `@Bean` of your own.
4778+
This can be useful if you're looking for customizing the default serialization strategy.
4779+
4780+
If you need more control over the configuration, consider registering a `RedisCacheManagerBuilderCustomizer` bean.
4781+
The following example shows a customizer that configures a specific time to live for `cache1` and `cache2`:
4782+
4783+
[source,java,indent=0]
4784+
----
4785+
include::{code-examples}/cache/RedisCacheManagerCustomizationExample.java[tag=configuration]
4786+
----
4787+
47794788

47804789

47814790

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
/*
2+
* Copyright 2012-2020 the original author or authors.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* https://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package org.springframework.boot.docs.cache;
18+
19+
import java.time.Duration;
20+
21+
import org.springframework.boot.autoconfigure.cache.RedisCacheManagerBuilderCustomizer;
22+
import org.springframework.context.annotation.Bean;
23+
import org.springframework.context.annotation.Configuration;
24+
import org.springframework.data.redis.cache.RedisCacheConfiguration;
25+
26+
/**
27+
* An example how to customize {@code RedisCacheManagerBuilder} via
28+
* {@code RedisCacheManagerBuilderCustomizer}.
29+
*
30+
* @author Dmytro Nosan
31+
*/
32+
@Configuration(proxyBeanMethods = false)
33+
public class RedisCacheManagerCustomizationExample {
34+
35+
// tag::configuration[]
36+
@Bean
37+
public RedisCacheManagerBuilderCustomizer myRedisCacheManagerBuilderCustomizer() {
38+
return (builder) -> builder
39+
.withCacheConfiguration("cache1",
40+
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofSeconds(10)))
41+
.withCacheConfiguration("cache2",
42+
RedisCacheConfiguration.defaultCacheConfig().entryTtl(Duration.ofMinutes(1)));
43+
44+
}
45+
// end::configuration[]
46+
47+
}

0 commit comments

Comments
 (0)