Springboot項目中使用redis的配置詳解

程序結構:

一、配置

 1. 在pom.xml中添加依賴

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>
 
    <groupId>com.lyy</groupId>
    <artifactId>redis-test</artifactId>
    <version>0.1-SNAPSHOT</version>
 
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.1.RELEASE</version>
        <!--始終從倉庫中獲取-->
        <!--<relativePath/>-->
    </parent>
 
    <dependencies>
        <!--web應用基本環境,如mvc-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
 
        <!--redis包-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
    </dependencies>
</project>

其中,spring-boot-starter-web包含springmvc。

2. 配置application.yml

application.yml文件如下:

server:
  port: 11011
  servlet:
    context-path: /api/v1
 
spring:
  redis:
    # Redis數據庫索引(默認為0)
    database: 0
    # Redis服務器地址
    host: 127.0.0.1
    # Redis服務器連接端口
    port: 6379
#     Redis服務器連接密碼(默認為空)
#    password: 123456

3. 通過配置類,設置redis

RedisConfig類如下:

package com.apollo.config;
 
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.EnableCaching;
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.GenericJackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;
 
/**
 * @author :apollo
 * @since :Created in 2019/2/22
 */
@Configuration
@EnableCaching
public class RedisConfig {
 
    @Autowired
    private ObjectMapper objectMapper;
 
    /**
     * 自定義springSessionDefaultRedisSerializer對象,將會替代默認的SESSION序列化對象。
     * 默認是JdkSerializationRedisSerializer,缺點是需要類實現Serializable接口。
     * 並且在反序列化時如果異常會拋出SerializationException異常,
     * 而SessionRepositoryFilter又沒有處理異常,故如果序列化異常時就會導致請求異常
     */
    @Bean(name = "springSessionDefaultRedisSerializer")
    public GenericJackson2JsonRedisSerializer getGenericJackson2JsonRedisSerializer() {
        return new GenericJackson2JsonRedisSerializer();
    }
 
    /**
     * JacksonJsonRedisSerializer和GenericJackson2JsonRedisSerializer的區別:
     * GenericJackson2JsonRedisSerializer在json中加入@class屬性,類的全路徑包名,方便反系列化。
     * JacksonJsonRedisSerializer如果存放瞭List則在反系列化的時候,
     * 如果沒指定TypeReference則會報錯java.util.LinkedHashMap cannot be cast。
     */
    @Bean
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory connectionFactory) {
        RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
        redisTemplate.setConnectionFactory(connectionFactory);
 
        // 使用Jackson2JsonRedisSerialize 替換默認序列化
        Jackson2JsonRedisSerializer jackson2JsonRedisSerializer =
                            new Jackson2JsonRedisSerializer(Object.class);
 
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        // 設置value的序列化規則和 key的序列化規則
        redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setKeySerializer(new StringRedisSerializer());
 
        redisTemplate.setHashKeySerializer(jackson2JsonRedisSerializer);
        redisTemplate.setHashValueSerializer(jackson2JsonRedisSerializer);
 
        redisTemplate.setDefaultSerializer(jackson2JsonRedisSerializer);
        redisTemplate.setEnableDefaultSerializer(true);
        redisTemplate.afterPropertiesSet();
        return redisTemplate;
    }
}

二、邏輯代碼

1. 程序入口

package com.apollo;
 
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
/**
 * @author :apollo
 * @since :Created in 2019/2/22
 */
@SpringBootApplication
public class Application  {
    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

2. 實體類

實體類Animal如下:

package com.apollo.bean;
 
/**
 * @author :apollo
 * @since :Created in 2019/2/22
 */
public class Animal {
    private Integer weight;
    private Integer height;
    private String name;
 
    public Animal(Integer weight, Integer height, String name) {
        this.weight = weight;
        this.height = height;
        this.name = name;
    }
 
    ……這裡是get、set方法
}

3. 公共返回類

package com.apollo.common;
 
/**
 * @author :apollo
 * @since :Created in 2019/2/22
 */
public class ApiResult {
    public static final Integer STATUS_SUCCESS = 0;
    public static final Integer STATUS_FAILURE = -1;
 
    public static final String DESC_SUCCESS = "操作成功";
    public static final String DESC_FAILURE = "操作失敗";
 
    private Integer status;
    private String desc;
    private Object result;
 
    private ApiResult() {}
 
    private ApiResult(Integer status, String desc, Object result) {
        this.status = status;
        this.desc = desc;
        this.result = result;
    }
 
    //這個方法和Builder設計模式二選一即可,功能是重復的
    public static ApiResult success(Object result) {
        return success(DESC_SUCCESS, result);
    }
 
    //同上
    public static ApiResult success(String desc, Object result) {
        return new ApiResult(STATUS_SUCCESS, desc, result);
    }
 
    //同上
    public static ApiResult failure(Integer status) {
        return failure(status, null);
    }
 
    //同上
    public static ApiResult failure(Integer status, String desc) {
        return failure(status, desc, null);
    }
 
    //同上
    public static ApiResult failure(Integer status, String desc, Object result) {
        return new ApiResult(status, desc, result);
    }
 
    public static Builder builder() {
        return new Builder();
    }
 
    //靜態內部類,這裡使用Builder設計模式
    public static class Builder {
        private Integer status;
        private String desc;
        private Object result;
 
        public Builder status(Integer status) {
            this.status = status;
            return this;
        }
 
        public Builder desc(String desc) {
            this.desc = desc;
            return this;
        }
 
        public Builder result(Object result) {
            this.result = result;
            return this;
        }
 
        public ApiResult build() {
            return new ApiResult(status, desc, result);
        }
    }
 
    ……這裡是get、set方法,這裡的方法一定不能少,否則返回時無法將對象序列化
}

4. 請求處理Controller

RedisController類如下:

package com.apollo.controller;
 
import com.apollo.bean.Animal;
import com.apollo.common.ApiResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.web.bind.annotation.*;
 
import java.util.HashMap;
import java.util.Map;
 
/**
 * @author :apollo
 * @since :Created in 2019/2/22
 */
@RestController
@RequestMapping(value = "/redis")
public class RedisController {
 
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;
 
    /**
     * 測試向redis中添加數據
     * @param id
     * @return
     */
    @GetMapping(value = "/{id}")
    public ApiResult addData2Redis(@PathVariable("id") Integer id) {
 
        redisTemplate.opsForValue().set("first", id);
        redisTemplate.opsForValue().set("second", "hello world");
        redisTemplate.opsForValue().set("third",
                new Animal(100, 200, "二狗子"));
 
        return ApiResult.builder()
                        .status(ApiResult.STATUS_SUCCESS)
                        .desc("添加成功")
                        .build();
    }
 
    /**
     * 測試從redis中獲取數據
     * @return
     */
    @GetMapping("/redis-data")
    public ApiResult getRedisData() {
        Map<String, Object> result = new HashMap<>();
        result.put("first", redisTemplate.opsForValue().get("first"));
        result.put("second", redisTemplate.opsForValue().get("second"));
        result.put("third", redisTemplate.opsForValue().get("third"));
 
        return ApiResult.builder()
                .status(ApiResult.STATUS_SUCCESS)
                .desc("獲取成功")
                .result(result)
                .build();
    }
}

註意:這裡是返回ApiResult對象,需要將返回的對象序列化,所以ApiResult中的get/set方法是必須的,否則會報錯:HttpMessageNotWritableException: No converter found for return value of type: class com.apollo.common.ApiResult,找不到ApiResult類型的轉換器。

三、測試

1. 測試添加

使用postman請求http://localhost:11011/api/v1/redis/5,返回結果:

{
    "status": 0,
    "desc": "添加成功",
    "result": null
}

登錄到redis,使用命令dbsize查看存儲的數據量:

數據量為3,對應我們上邊程序中的3步操作。

2. 測試獲取

使用postman請求http://localhost:11011/api/v1/redis/redis-data,返回結果:

{
    "status": 0,
    "desc": "獲取成功",
    "result": {
        "third": {
            "weight": 100,
            "height": 200,
            "name": "二狗子"
        },
        "first": 5,
        "second": "hello world"
    }
}

與我們之前存入的數據對比,是正確的。

四、代碼地址

github地址:https://github.com/myturn0/redis-test.git

到此這篇關於Springboot項目中使用redis的配置詳解的文章就介紹到這瞭,更多相關Springboot redis配置內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!