Skip to content

Commit 034a9b0

Browse files
author
codeba
committed
docs: Add the necessary note descriptions
1 parent ccba8f1 commit 034a9b0

File tree

4 files changed

+36
-12
lines changed

4 files changed

+36
-12
lines changed

redis-keeper-spring-boot-starter/src/main/java/org/codeba/redis/keeper/spring/boot/RedisDatasourceProperties.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,16 +33,19 @@
3333
public class RedisDatasourceProperties implements DisposableBean {
3434

3535
/**
36-
* The Lazy refresh.
36+
* The Lazy refresh, when a configuration change occurs, the bean initialized immediately or when the bean is first invoked
37+
* <p>
38+
* true: the bean initialized when the bean is first invoked
39+
* false: the bean initialized immediately
3740
*/
3841
private boolean lazyRefresh = true;
3942
/**
40-
* The Datasource.
43+
* The Datasource. One-to-one redis data source
4144
*/
4245
private Map<String, RedisKeeperProperties> datasource;
4346

4447
/**
45-
* The Datasources.
48+
* The Datasources. One-to-many redis data sources
4649
*/
4750
private Map<String, List<RedisKeeperProperties>> datasources;
4851

redis-keeper-spring-boot-starter/src/main/java/org/codeba/redis/keeper/spring/boot/RedisKeeperProperties.java

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,20 @@
3131
@EqualsAndHashCode(callSuper = true)
3232
public class RedisKeeperProperties extends RedisProperties {
3333
/**
34-
* The Status.
34+
* The Status is the identity of the data source, you can specify the identity through the cacheProvider class to get the corresponding data source
35+
* <p>
36+
* Value range: RO, WO, RW, SKIP
37+
* RO: Read-only cache datasource status
38+
* WO: Write-only cache datasource status.
39+
* RW: Read-write cache datasource status.
40+
* SKIP: Skip cache datasource status.
3541
*/
3642
private String status = CacheDatasourceStatus.RW.name();
3743
/**
38-
* The Invoke params print.
44+
* The Invoke params print, means whether to print an entry log when executing the methods of the cacheTemplate class.
45+
* <p>
46+
* true : print entry log
47+
* false: not print entry log
3948
*/
4049
private boolean invokeParamsPrint;
4150
}

redis-keeper-spring-boot-starter/src/main/java/org/codeba/redis/keeper/spring/boot/RedissonDatasourceProperties.java

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,19 @@
3232
@ConfigurationProperties(prefix = "redis-keeper.redisson")
3333
public class RedissonDatasourceProperties implements DisposableBean {
3434
/**
35-
* The Lazy refresh.
35+
* The Lazy refresh, when a configuration change occurs, the bean initialized immediately or when the bean is first invoked
36+
* <p>
37+
* true: the bean initialized when the bean is first invoked
38+
* false: the bean initialized immediately
3639
*/
3740
private boolean lazyRefresh = true;
3841
/**
39-
* The Datasource.
42+
* The Datasource. One-to-one redis data source
4043
*/
4144
private Map<String, RedissonKeeperProperties> datasource;
4245

4346
/**
44-
* The Datasources.
47+
* The Datasources. One-to-many redis data sources
4548
*/
4649
private Map<String, List<RedissonKeeperProperties>> datasources;
4750

redis-keeper-spring-boot-starter/src/main/java/org/codeba/redis/keeper/spring/boot/RedissonKeeperProperties.java

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,19 +28,28 @@
2828
@Data
2929
public class RedissonKeeperProperties {
3030
/**
31-
* The Status.
31+
* The Status is the identity of the data source, you can specify the identity through the cacheProvider class to get the corresponding data source
32+
* <p>
33+
* Value range: RO, WO, RW, SKIP
34+
* RO: Read-only cache datasource status
35+
* WO: Write-only cache datasource status.
36+
* RW: Read-write cache datasource status.
37+
* SKIP: Skip cache datasource status.
3238
*/
3339
private String status = CacheDatasourceStatus.RW.name();
3440
/**
35-
* The Invoke params print.
41+
* The Invoke params print, means whether to print an entry log when executing the methods of the cacheTemplate class.
42+
* <p>
43+
* true : print entry log
44+
* false: not print entry log
3645
*/
3746
private boolean invokeParamsPrint;
3847
/**
39-
* The Config.
48+
* The Config, the same as redisson properties.
4049
*/
4150
private String config;
4251
/**
43-
* The File.
52+
* The File, the same as redisson properties.
4453
*/
4554
private String file;
4655
}

0 commit comments

Comments
 (0)