spring-data-redis

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Spring Data Redis - Quick Reference

Spring Data Redis - 快速参考

Full Reference: See advanced.md for hash/list/set operations, sorted sets, @RedisHash repository pattern, pub/sub configuration, and distributed lock patterns.

Deep Knowledge: Use
mcp__documentation__fetch_docs
with technology:
spring-data-redis
for comprehensive documentation.

完整参考：查看 advanced.md 了解哈希/列表/集合操作、有序集合、@RedisHash仓库模式、发布/订阅配置以及分布式锁模式。

深度知识：使用
mcp__documentation__fetch_docs
工具，指定技术为
spring-data-redis
获取完整文档。

Dependencies

依赖

xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- For reactive -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

xml

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- 响应式依赖 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
</dependency>

Configuration

配置

yaml

spring:
  data:
    redis:
      host: localhost
      port: 6379
      password: ${REDIS_PASSWORD:}
      database: 0
      timeout: 2000ms
      lettuce:
        pool:
          max-active: 8
          max-idle: 8
          min-idle: 2

  cache:
    type: redis
    redis:
      time-to-live: 3600000  # 1 hour
      cache-null-values: false
      key-prefix: "myapp:"

yaml

spring:
  data:
    redis:
      host: localhost
      port: 6379
      password: ${REDIS_PASSWORD:}
      database: 0
      timeout: 2000ms
      lettuce:
        pool:
          max-active: 8
          max-idle: 8
          min-idle: 2

  cache:
    type: redis
    redis:
      time-to-live: 3600000  # 1小时
      cache-null-values: false
      key-prefix: "myapp:"

RedisTemplate Configuration

RedisTemplate 配置

java

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);

        Jackson2JsonRedisSerializer<Object> jsonSerializer =
            new Jackson2JsonRedisSerializer<>(Object.class);

        template.setKeySerializer(new StringRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(jsonSerializer);
        template.setHashValueSerializer(jsonSerializer);

        template.afterPropertiesSet();
        return template;
    }
}

java

@Configuration
public class RedisConfig {

    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(connectionFactory);

        Jackson2JsonRedisSerializer<Object> jsonSerializer =
            new Jackson2JsonRedisSerializer<>(Object.class);

        template.setKeySerializer(new StringRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(jsonSerializer);
        template.setHashValueSerializer(jsonSerializer);

        template.afterPropertiesSet();
        return template;
    }
}

Basic String Operations

基础字符串操作

java

@Service
@RequiredArgsConstructor
public class RedisService {

    private final RedisTemplate<String, Object> redisTemplate;

    public void set(String key, Object value, Duration ttl) {
        redisTemplate.opsForValue().set(key, value, ttl);
    }

    public Object get(String key) {
        return redisTemplate.opsForValue().get(key);
    }

    public boolean setIfAbsent(String key, Object value, Duration ttl) {
        return Boolean.TRUE.equals(
            redisTemplate.opsForValue().setIfAbsent(key, value, ttl));
    }

    public Long increment(String key) {
        return redisTemplate.opsForValue().increment(key);
    }

    public void delete(String key) {
        redisTemplate.delete(key);
    }
}

java

@Service
@RequiredArgsConstructor
public class RedisService {

    private final RedisTemplate<String, Object> redisTemplate;

    public void set(String key, Object value, Duration ttl) {
        redisTemplate.opsForValue().set(key, value, ttl);
    }

    public Object get(String key) {
        return redisTemplate.opsForValue().get(key);
    }

    public boolean setIfAbsent(String key, Object value, Duration ttl) {
        return Boolean.TRUE.equals(
            redisTemplate.opsForValue().setIfAbsent(key, value, ttl));
    }

    public Long increment(String key) {
        return redisTemplate.opsForValue().increment(key);
    }

    public void delete(String key) {
        redisTemplate.delete(key);
    }
}

Spring Cache Integration

Spring 缓存集成

java

@SpringBootApplication
@EnableCaching
public class Application { }

@Configuration
@EnableCaching
public class CacheConfig {

    @Bean
    public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory) {
        RedisCacheConfiguration defaultConfig = RedisCacheConfiguration.defaultCacheConfig()
            .entryTtl(Duration.ofMinutes(30))
            .disableCachingNullValues()
            .serializeKeysWith(RedisSerializationContext.SerializationPair
                .fromSerializer(new StringRedisSerializer()))
            .serializeValuesWith(RedisSerializationContext.SerializationPair
                .fromSerializer(new GenericJackson2JsonRedisSerializer()));

        Map<String, RedisCacheConfiguration> cacheConfigs = Map.of(
            "users", defaultConfig.entryTtl(Duration.ofHours(1)),
            "products", defaultConfig.entryTtl(Duration.ofMinutes(15))
        );

        return RedisCacheManager.builder(connectionFactory)
            .cacheDefaults(defaultConfig)
            .withInitialCacheConfigurations(cacheConfigs)
            .build();
    }
}

java

@SpringBootApplication
@EnableCaching
public class Application { }

@Configuration
@EnableCaching
public class CacheConfig {

    @Bean
    public RedisCacheManager cacheManager(RedisConnectionFactory connectionFactory) {
        RedisCacheConfiguration defaultConfig = RedisCacheConfiguration.defaultCacheConfig()
            .entryTtl(Duration.ofMinutes(30))
            .disableCachingNullValues()
            .serializeKeysWith(RedisSerializationContext.SerializationPair
                .fromSerializer(new StringRedisSerializer()))
            .serializeValuesWith(RedisSerializationContext.SerializationPair
                .fromSerializer(new GenericJackson2JsonRedisSerializer()));

        Map<String, RedisCacheConfiguration> cacheConfigs = Map.of(
            "users", defaultConfig.entryTtl(Duration.ofHours(1)),
            "products", defaultConfig.entryTtl(Duration.ofMinutes(15))
        );

        return RedisCacheManager.builder(connectionFactory)
            .cacheDefaults(defaultConfig)
            .withInitialCacheConfigurations(cacheConfigs)
            .build();
    }
}

Cache Annotations

缓存注解

java

@Service
public class UserService {

    @Cacheable(value = "users", key = "#id")
    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    @CachePut(value = "users", key = "#user.id")
    public User updateUser(User user) {
        return userRepository.save(user);
    }

    @CacheEvict(value = "users", key = "#id")
    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    @CacheEvict(value = "users", allEntries = true)
    public void clearUserCache() { }
}

java

@Service
public class UserService {

    @Cacheable(value = "users", key = "#id")
    public User getUserById(Long id) {
        return userRepository.findById(id).orElse(null);
    }

    @CachePut(value = "users", key = "#user.id")
    public User updateUser(User user) {
        return userRepository.save(user);
    }

    @CacheEvict(value = "users", key = "#id")
    public void deleteUser(Long id) {
        userRepository.deleteById(id);
    }

    @CacheEvict(value = "users", allEntries = true)
    public void clearUserCache() { }
}

When NOT to Use This Skill

不适用本技能的场景

Raw Redis commands - Use
```
redis
```
skill for low-level operations
Non-Spring applications - Use Jedis or Lettuce directly
Primary database - Redis is for caching, not primary storage
Complex queries - Use SQL databases for complex queries

原生Redis命令 - 如需底层操作请使用
```
redis
```
技能
非Spring应用 - 直接使用Jedis或Lettuce
主数据库 - Redis适用于缓存，而非主存储
复杂查询 - 复杂查询请使用SQL数据库

Anti-Patterns

反模式

Anti-Pattern	Problem	Solution
No TTL on cached data	Memory exhaustion	Always set expiration
Large objects in cache	Memory pressure	Keep values small
Cache stampede	Thundering herd	Use distributed locks
@Cacheable on void methods	No effect	Only cache return values
Caching mutable objects	Stale data	Cache immutable or clone
No connection pooling	Connection exhaustion	Configure Lettuce pool

反模式	问题	解决方案
缓存数据未设置TTL	内存耗尽	始终设置过期时间
缓存中存储大对象	内存压力	保持值的体积较小
缓存击穿	惊群效应	使用分布式锁
在无返回值方法上使用@Cacheable	无效果	仅缓存返回值
缓存可变对象	数据过期	缓存不可变对象或克隆对象
未配置连接池	连接耗尽	配置Lettuce连接池

Quick Troubleshooting

快速故障排查

Problem	Diagnostic	Fix
Connection refused	Check Redis running	Start Redis, check host/port
Cache not working	Check @EnableCaching	Add annotation, verify AOP proxy
Serialization error	Check object type	Configure proper serializer
Memory issues	`redis-cli INFO memory`	Set maxmemory, eviction policy

问题	诊断方法	修复方案
连接被拒绝	检查Redis是否运行	启动Redis，检查主机/端口
缓存不生效	检查@EnableCaching注解	添加注解，验证AOP代理
序列化错误	检查对象类型	配置合适的序列化器
内存问题	使用 `redis-cli INFO memory` 命令	设置最大内存，配置淘汰策略

spring-data-redis

Original

Translation

Spring Data Redis - Quick Reference

Spring Data Redis - 快速参考

Dependencies

依赖

Configuration

配置

RedisTemplate Configuration

RedisTemplate 配置

Basic String Operations

基础字符串操作

Spring Cache Integration

Spring 缓存集成

Cache Annotations

缓存注解

When NOT to Use This Skill

不适用本技能的场景

Anti-Patterns

反模式

Quick Troubleshooting

快速故障排查

Production Checklist

生产环境检查清单

Reference Documentation

参考文档