SpringBoot2 整合 Redis 實例，實現寫入和讀取的操作

1. 啓動 Redis Server

啓動 redis server，如下圖所示，端口號 6379：

2. 工程實例

2.1 工程目錄

工程目錄如下圖所示：

2.2 pom.xml

引入依賴：

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

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

完整 pom.xml 如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.2.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.syrdbt</groupId>
    <artifactId>redis-study</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>redis-study</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>

        <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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2.3 Java 源文件

啓動類，RedisStudyApplication.java:

package com.syrdbt.redis.study;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class RedisStudyApplication {

    public static void main(String[] args) {
        SpringApplication.run(RedisStudyApplication.class, args);
    }

}

控制器，RedisStudyController.java：

這裏使用 SpringBoot 內置的與 Redis 的工具類：RedisTemplate；

除了 RedisTemplate，SpringBoot 還內置了 StringRedisTemplate ；

StringRedisTemplate 只能對 key=String，value=String 的鍵值對進行操作，RedisTemplate 可以對任何類型的 key-value 鍵值對操作；StringRedisTemplate 繼承了 RedisTemplate。

package com.syrdbt.redis.study.controller;

import com.sun.tools.javac.code.Attribute;
import com.syrdbt.redis.study.constant.Constant;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import java.io.Console;

/**
 * @author syrdbt
 */
@RestController
public class RedisStudyController {
    @Autowired
    private RedisTemplate redisTemplate;

    /**
     * 通過 key 獲取字符串
     */
    @GetMapping("/redis/get")
    public String visitStringByKey(@RequestParam String key) {
        return (String) redisTemplate.opsForValue().get(Constant.NAMESPACE + ":" + key);
    }

    /**
     * 在 redis 中設置 key/value
     */
    @GetMapping("/redis/set")
    public String visitStringByKey(@RequestParam String key, @RequestParam String value) {
        try {
            redisTemplate.opsForValue().set(Constant.NAMESPACE + ":" + key, value);
        } catch (Exception e) {
            return "error";
        }
        return "success";
    }
}

redis 配置類，RedisConfig.java :

package com.syrdbt.redis.study.config;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.GenericToStringSerializer;
import org.springframework.data.redis.serializer.RedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;

/**
 * redis 配置類
 *
 * @author syrdbt
 */
@Configuration
public class RedisConfig {

    private final RedisTemplate redisTemplate;

    @Autowired
    public RedisConfig(RedisTemplate redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    @Bean
    @SuppressWarnings("unchecked")
    public RedisTemplate<String, Object> redisTemplate() {
        RedisSerializer<String> stringSerializer = new StringRedisSerializer();
        RedisSerializer<Object> jsonString = new GenericToStringSerializer<>(Object.class);
        redisTemplate.setKeySerializer(stringSerializer);
        redisTemplate.setValueSerializer(jsonString);
        redisTemplate.setHashKeySerializer(stringSerializer);
        redisTemplate.setHashValueSerializer(jsonString);
        return redisTemplate;
    }
}

常量類用作 redis key 的前綴，Constant.java：

package com.syrdbt.redis.study.constant;

/**
 * @author syrdbt
 * @date 2019-12-10
 */
public class Constant {
    public static final String NAMESPACE = "REDIS-STUDY";
}

3. 測試

寫操作，訪問 http://localhost:8080/redis/set?key=name&value=syrdbt 。

讀操作，訪問http://localhost:8080/redis/get?key=name

4. 問題

整合 redis 的寫入和讀出的實例已經完成了。

不過還有 2 個問題：

1. 我沒並沒有設置主機號、端口號、用戶名、密碼就訪問了 redis，顯然 SpringBoot 默認配置了這些，我本機的redis下載之後沒有修改密碼等配置，所以纔可以訪問。
2. 正常境況下，不應該直接使用 redisTmplate，應該封裝成工具類，這樣方便大家使用。