Spring Boot：使用Redis存儲技術

時間 2019-11-06

標籤 spring boot 使用 redis 存儲技術欄目 Spring 简体版

原文原文鏈接

綜合概述

Redis是一個開源免費的高性能key-value數據庫，讀取速度達110000次/s,寫入速度達81000次/s。Redis支持豐富的數據類型，如Lists, Hashes, Sets 及 Ordered Sets 數據類型。Redis的全部操做都是原子性的，要麼成功執行要麼失敗徹底不執行。另外還能夠經過MULTI和EXEC指令包起來支持事務。此外，Redis還具有豐富的特性，好比支持發佈/訂閱（publish/subscribe）模式,能夠充當簡單的消息中間件，還支持通知, key過時設置主從複製等等特性。html

Redis主要如下三個特色：java

1.支持數據的持久化，能夠將內存中的數據保存在磁盤中，重啓的時候能夠再次加載進行使用。git

2.支持豐富的數據類型，除了支持簡單的key-value類型，同時還提供list，set，zset，hash等數據結構的存儲。web

3.支持數據的備份，即主從（master-slave）模式模式的數據備份。redis

接下來，咱們就用一個簡單的案例來講明在Spring Boot中如何使用Redis技術。spring

實現案例

首先，須要安裝Redis，教程不少，這裏再也不贅述。能夠參考：Redis安裝教程。數據庫

生成項目模板

爲方便咱們初始化項目，Spring Boot給咱們提供一個項目模板生成網站。apache

1. 打開瀏覽器，訪問：https://start.spring.io/api

2. 根據頁面提示，選擇構建工具，開發語言，項目信息等。瀏覽器

3. 點擊 Generate the project，生成項目模板，生成以後會將壓縮包下載到本地。

4. 使用IDE導入項目，我這裏使用Eclipse，經過導入Maven項目的方式導入。

添加相關依賴

清理掉不須要的測試類及測試依賴，添加 Redis相關依賴。

<!-- spring boot redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<!-- lettuce pool -->
<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-pool2</artifactId>
</dependency>

Spring Boot框架中已經集成了redis，在1.x.x的版本中默認使用jedis客戶端，而在2.x.x版本中默認使用的lettuce客戶端。

兩種客戶端的區別以下：

Jedis和Lettuce都是Redis Client
Jedis 是直連模式，在多個線程間共享一個 Jedis 實例時是線程不安全的，
若是想要在多線程環境下使用 Jedis，須要使用鏈接池，
每一個線程都去拿本身的 Jedis 實例，當鏈接數量增多時，物理鏈接成本就較高了。
Lettuce的鏈接是基於Netty的，鏈接實例能夠在多個線程間共享，
因此，一個多線程的應用可使用同一個鏈接實例，而不用擔憂併發線程的數量。
固然這個也是可伸縮的設計，一個鏈接實例不夠的狀況也能夠按需增長鏈接實例。
經過異步的方式可讓咱們更好的利用系統資源，而不用浪費線程等待網絡或磁盤I/O。
Lettuce 是基於 netty 的，netty 是一個多線程、事件驅動的 I/O 框架，
因此 Lettuce 能夠幫助咱們充分利用異步的優點。

個人項目是使用的是Spring Boot 2.1.5.RELEASE，因此採用lettuce來進行配置。

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 http://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.1.5.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.louis.springboot</groupId>
    <artifactId>demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>demo</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</artifactId>
        </dependency>
        <!-- web -->
        <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
        <!-- swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        <!-- spring boot redis -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!-- lettuce pool -->
        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-pool2</artifactId>
        </dependency>
    </dependencies>

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

</project>

添加相關配置

1.添加swagger 配置

添加一個swagger 配置類，在工程下新建 config 包並添加一個 SwaggerConfig 配置類。

SwaggerConfig.java

package com.louis.springboot.demo.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Swagger API Doc")
                .description("This is a restful api document of Swagger.")
                .version("1.0")
                .build();
    }

}

2.修改application.properties文件名爲application.yml，在其中添加Redis配置信息。

application.yml

spring:
  redis:
    database: 0  # Redis數據庫索引（默認爲0）
    host: localhost # Redis服務器地址
    port: 6379  # Redis服務器鏈接端口
    password:   # Redis服務器鏈接密碼（默認爲空）
    lettuce:
      pool:
       max-active: 8  # 鏈接池最大鏈接數（使用負值表示沒有限制） 默認 8
       max-wait: -1   # 鏈接池最大阻塞等待時間（使用負值表示沒有限制） 默認 -1
       max-idle: 8    # 鏈接池中的最大空閒鏈接 默認 8
       min-idle: 0    # 鏈接池中的最小空閒鏈接 默認 0

3.添加一個Redis配置類，使用@EnableCaching註解來開啓緩存。

RedisConfig.java

package com.louis.springboot.demo.config;

import java.lang.reflect.Method;

import org.springframework.cache.annotation.CachingConfigurerSupport;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport{
    
    @Bean
    public KeyGenerator keyGenerator() {
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                StringBuilder sb = new StringBuilder();
                sb.append(target.getClass().getName());
                sb.append(method.getName());
                for (Object obj : params) {
                    sb.append(obj.toString());
                }
                return sb.toString();
            }
        };
    }
}

編寫業務邏輯

編寫一個簡單的用戶實體類，包含用戶名和密碼。

User.java

package com.louis.springboot.demo.model;

import java.io.Serializable;

public class User implements Serializable {

    private static final long serialVersionUID = 1L;
    
    private String username;
    private String password;
    
    public User(String username, String password) {
        super();
        this.username = username;
        this.password = password;
    }
    
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    
    @Override
    public String toString() {
        return "{username:" + getUsername() + ", password:" +getPassword() + "}";
    }
}

編寫一個業務控制器，分別編寫測試字符串和對象的存取接口，另外還經過@Cacheable(value="user-key")註解給方法開啓緩存，這樣就能夠緩存方法返回的結果，只有當緩存不存在的時候採用執行方法返回新的用戶對象。

RedisController.java

package com.louis.springboot.demo.controller;

import java.util.concurrent.TimeUnit;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.data.redis.core.ValueOperations;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import com.louis.springboot.demo.model.User;

@RestController
public class RedisController {

    @Autowired
    private StringRedisTemplate stringRedisTemplate;
    @Autowired
    private RedisTemplate redisTemplate;

    @GetMapping("/testString")
    public String testString()  {
        stringRedisTemplate.opsForValue().set("name", "louis");
        String name = stringRedisTemplate.opsForValue().get("name");
        return "the value of key 'name' is : " + name ;
    }
    
    @GetMapping("/testObject")
    public String testObject()  {
        StringBuilder result = new StringBuilder();
        User user = new User("louis", "123");
        ValueOperations<String, User> operations = redisTemplate.opsForValue();
        operations.set("sys.user", user);
        operations.set("sys.user.timeout", user, 1, TimeUnit.SECONDS);    // 設置1秒後過時
        result.append("過時前：").append("\n");
        result.append("sys.user=" + operations.get("sys.user")).append("\n");
        result.append("sys.user.timeout=" + operations.get("sys.user.timeout"));
        try {
            Thread.sleep(1000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        result.append("\n").append("過時後：").append("\n");
        result.append("sys.user=" + operations.get("sys.user")).append("\n");
        result.append("sys.user.timeout=" + operations.get("sys.user.timeout"));
        return result.toString();
    }
    
    @GetMapping("/getUser")
    @Cacheable(value="user-key")
    public User getUser() {
        User user = new User("louis", "123");
        System.out.println("用戶對象緩存不存在，返回一個新的用戶對象。");
        return user;
    }
}

編譯運行測試

1. 右鍵項目 -> Run as -> Maven install，開始執行Maven構建，第一次會下載Maven依賴，可能須要點時間，若是出現以下信息，就說明項目編譯打包成功了。

2. 右鍵文件 DemoApplication.java -> Run as -> Java Application，開始啓動應用，當出現以下信息的時候，就說明應用啓動成功了，默認啓動端口是8080。

3. 打開瀏覽器，訪問：http://localhost:8080/swagger-ui.html，進入swagger接口文檔界面。

4.調用testString接口，若是能出現以下圖所示結果就說明成功了。

5.調用testObject接口，若是能出現以下圖所示結果就說明成功了。

6.調用getUser接口，此時由於是第一次調用此方法，因此沒有key值爲「user-key」的緩存，因此會執行方法並將返回結果進行緩存。在執行getUser方法的時候控制檯輸出了咱們添加的提示信息以下。

用戶對象緩存不存在，返回一個新的用戶對象。

7.而後再次調用getUser接口，發現getUser沒有再次被執行，控制檯也沒有輸出上一步的提示信息，那是由於在方法調用以前，應用從key值爲「user-key」的緩存中獲取成功，因此並不須要繼續執行getUser方法的內容了。

參考資料

官方網站：https://redis.io/documentation

百度百科：https://baike.baidu.com/item/Redis/6549233?fr=aladdin

菜鳥教程：https://www.runoob.com/redis/redis-tutorial.html

源碼下載

碼雲：https://gitee.com/liuge1988/spring-boot-demo.git

做者：朝雨憶輕塵
出處：https://www.cnblogs.com/xifengxiaoma/
版權全部，歡迎轉載，轉載請註明原文做者及出處。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。