Spring Boot 整合 Redis示例代碼步驟詳解

更新時(shí)間：2025年11月21日 09:24:39 作者：g***7270

本文介紹了如何在SpringBoot應(yīng)用中整合Redis,并通過示例代碼展示了具體實(shí)現(xiàn)步驟,包括添加依賴、配置連接信息、創(chuàng)建操作服務(wù)類、使用RedisTemplate或ReactiveRedisTemplate以及測試功能,感興趣的朋友跟隨小編一起看看吧

Redis 是一個(gè)高性能的鍵值存儲系統(tǒng)，常用于緩存、消息隊(duì)列等多種場景。將 Redis 與 Spring Boot 結(jié)合使用可以極大提升應(yīng)用的性能和響應(yīng)速度。本文將詳細(xì)介紹如何在 Spring Boot 應(yīng)用中整合 Redis，并通過示例代碼展示具體實(shí)現(xiàn)步驟。

1. 引言

隨著互聯(lián)網(wǎng)應(yīng)用對快速讀寫數(shù)據(jù)的需求日益增長，傳統(tǒng)的數(shù)據(jù)庫已經(jīng)難以滿足某些特定場景下的性能要求。Redis 憑借其內(nèi)存級的數(shù)據(jù)訪問速度、豐富的數(shù)據(jù)結(jié)構(gòu)支持以及簡單易用的 API，成為了許多開發(fā)者的首選。接下來，我們將一步步介紹如何在 Spring Boot 中集成 Redis。

2. 添加依賴

首先，在 pom.xml 文件中添加 Spring Data Redis 和 Jedis（或 Lettuce）客戶端的 Maven 依賴：

<dependencies>
	<dependency>
	     <groupId>org.springframework.boot</groupId>
	     <artifactId>spring-boot-starter-web</artifactId>
	 </dependency>
	 <dependency>
	     <groupId>org.springframework.boot</groupId>
	     <artifactId>spring-boot-starter-test</artifactId>
	     <scope>test</scope>
	 </dependency>
	 <!-- Spring Boot Starter for Redis -->
	 <dependency>
	     <groupId>org.springframework.boot</groupId>
	     <artifactId>spring-boot-starter-data-redis</artifactId>
	 </dependency>
	 <dependency>
	     <groupId>org.projectlombok</groupId>
	     <artifactId>lombok</artifactId>
	 </dependency>
	 <dependency>
	     <groupId>com.alibaba</groupId>
	     <artifactId>fastjson</artifactId>
	     <version>1.2.83</version>
	 </dependency>
    <!-- Jedis or Lettuce client -->
    <!-- Choose one of the following two dependencies -->
    <!-- For Jedis -->
    <dependency>
        <groupId>redis.clients</groupId>
        <artifactId>jedis</artifactId>
    </dependency>
    <!-- Or for Lettuce -->
    <dependency>
        <groupId>io.lettuce</groupId>
        <artifactId>lettuce-core</artifactId>
    </dependency>
</dependencies>

3. 配置 Redis 連接信息

接下來，在 application.properties 或 application.yml 文件中配置 Redis 的連接參數(shù)。這里以 .yml 文件為例：

server:
  port: 8082
spring:
  data:
    redis:
      host: localhost
      port: 6379
      password: 123456

4. 創(chuàng)建 Redis 操作服務(wù)類

Java實(shí)體

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 23:41
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Long id;
    private String username;
    private int age;
}

用戶接口類

import org.hbin.redis.entity.User;
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 23:44
 */
public interface UserService {
    User query(Long id);
    Boolean expired(Long id);
}

接口實(shí)現(xiàn)類

import com.alibaba.fastjson.JSON;
import lombok.RequiredArgsConstructor;
import org.hbin.redis.entity.User;
import org.hbin.redis.service.UserService;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 23:46
 */
@Service
@RequiredArgsConstructor
public class UserServiceImpl implements UserService {
    private final RedisTemplate<String, String> redisTemplate;
    private final String REDIS_PREFIX_KEY = "User::";
    @Override
    public User query(Long id) {
        Object obj = redisTemplate.opsForValue().get("User::" + id);
        if(obj != null) {
            return JSON.parseObject(obj.toString(), User.class);
        }
        // 模擬從DB查詢
        User user = new User(id, "user" + id, 20);
        redisTemplate.opsForValue().set(REDIS_PREFIX_KEY + id, JSON.toJSONString(user));
        return user;
    }
    @Override
    public Boolean expired(Long id) {
        return redisTemplate.delete(REDIS_PREFIX_KEY + id);
    }
}

Controller代碼

import lombok.RequiredArgsConstructor;
import org.hbin.redis.entity.User;
import org.hbin.redis.service.UserService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
/**
 * @Description
 * @Author HaleyHu
 * @Date 2024/12/5 23:46
 */
@RequiredArgsConstructor
@RestController
public class UserController {
    private final UserService userService;
    @GetMapping("/query")
    public User query(@RequestParam Long id) {
        return userService.query(id);
    }
    @GetMapping("/expired")
    public String expired(@RequestParam Long id) {
        return userService.expired(id).toString();
    }
}

如果你想處理更復(fù)雜的數(shù)據(jù)類型（如對象），則需要使用 RedisTemplate 并配置序列化器。例如，使用 Jackson JSON 序列化器：

import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
@Configuration
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setConnectionFactory(factory);
        Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<>(Object.class);
        ObjectMapper objectMapper = new ObjectMapper();
        serializer.setObjectMapper(objectMapper);
        template.setValueSerializer(serializer);
        template.setKeySerializer(new StringRedisSerializer());
        template.setHashKeySerializer(new StringRedisSerializer());
        template.setHashValueSerializer(serializer);
        template.afterPropertiesSet();
        return template;
    }
}

5. 使用 RedisTemplate 或 ReactiveRedisTemplate

Spring Data Redis 提供了兩種主要的方式來與 Redis 進(jìn)行交互：同步方式 (RedisTemplate) 和響應(yīng)式編程方式 (ReactiveRedisTemplate)。根據(jù)你的需求選擇合適的方式。

同步方式 (RedisTemplate)
這是最常見的方式，適用于大多數(shù)應(yīng)用場景。

響應(yīng)式編程方式 (ReactiveRedisTemplate)
如果你的應(yīng)用采用了響應(yīng)式編程模型（如 WebFlux），那么 ReactiveRedisTemplate 可能更適合你。它允許你以非阻塞的方式與 Redis 進(jìn)行通信。

6. 測試 Redis 功能

最后，我們可以通過編寫單元測試來驗(yàn)證 Redis 的基本功能是否正常工作。也可以部署運(yùn)行上述程序來驗(yàn)證。訪問路徑：
http://localhost:8082/query?id=1
http://localhost:8082/expired?id=1

7. 注意事項(xiàng)

生產(chǎn)環(huán)境配置：在生產(chǎn)環(huán)境中部署時(shí)，請確保正確配置 Redis 的安全設(shè)置（如密碼保護(hù)、網(wǎng)絡(luò)限制等），并考慮啟用持久化選項(xiàng)以防止數(shù)據(jù)丟失。
性能優(yōu)化：合理調(diào)整連接池參數(shù)，避免過多的連接消耗資源；同時(shí)也可以根據(jù)業(yè)務(wù)特點(diǎn)選用合適的序列化器來提高性能。
監(jiān)控和維護(hù)：定期檢查 Redis 的運(yùn)行狀態(tài)，及時(shí)清理過期數(shù)據(jù)，保持系統(tǒng)的穩(wěn)定性和高效性。