开发者社区> libin9iOak> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

Spring Boot demo系列 :Redis缓存

简介: 目录 Spring Boot demo系列 :Redis缓存 12.2.1 手动添加`@class` 12.2.2 将实体类设置为`open`
+关注继续查看

Spring Boot demo系列 :Redis缓存


本文演示了如何在Spring Boot中将Redis作为缓存使用,具体的内容包括:

  • 环境搭建
  • 项目搭建
  • 测试
  • Redis
  • MySQL
  • MyBatis Plus


Redis安装非常简单,以笔者的Manjaro为例,直接paru安装:

paru -S redis


UbuntuCentOS之类的都提供了软件包安装:


sudo apt install redis
sudo yum install redis


如果想从源码编译安装:


wget http://download.redis.io/redis-stable.tar.gz
tar xvzf redis-stable.tar.gz
cd redis-stable
make


Windows以及其他系统的安装可以参考此处

新建项目,加入如下依赖:

Maven


<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version>
</dependency>


Gradle


implementation("com.baomidou:mybatis-plus-boot-starter:3.4.2")
implementation("mysql:mysql-connector-java:8.0.23")


项目结构:


9.png


MyBatis Plus+Redis配置类:


@Configuration
@MapperScan("com.example.demo.dao")
public class MyBatisPlusConfig {
}
@Configuration
@AutoConfigureAfter(RedisAutoConfiguration.class)
@EnableCaching
public class RedisConfig {
    @Bean
    public RedisTemplate<String, Object> redisTemplate(LettuceConnectionFactory factory) {
        RedisTemplate<String, Object> template = new RedisTemplate<>();
        template.setKeySerializer(new StringRedisSerializer());
        template.setValueSerializer(new GenericJackson2JsonRedisSerializer());
        template.setConnectionFactory(factory);
        return template;
    }

    @Bean
    public CacheManager cacheManager(RedisConnectionFactory factory) {
        RedisCacheConfiguration configuration = RedisCacheConfiguration.defaultCacheConfig()
        .serializeKeysWith(
            RedisSerializationContext.SerializationPair.fromSerializer(new StringRedisSerializer())
        ).serializeValuesWith(
            RedisSerializationContext.SerializationPair.fromSerializer(new GenericJackson2JsonRedisSerializer())
        );
        return RedisCacheManager.builder(factory).cacheDefaults(configuration).build();
    }
}


重点说一下Redis配置类,这个类主要生成两个Bean:


RedisTemplate:简化Redis操作的数据访问类

CacheManager:Spring的中央缓存管理器

其中RedisTemplate是一个模板类,第一个参数的类型是该template使用的键的类型,通常是String,第二个参数的类型是该template使用的值的类型,通常为Object或Seriazable。


setKeySerializer和setValueSerializer分别设置键值的序列化器。键一般为String类型,可以使用自带的StringRedisSerializer。对于值,可以使用自带的GenericJackson2RedisSerializer。


CacheManager的配置类似,就不重新说了。


@Getter
@Setter
@ToString
@AllArgsConstructor
@NoArgsConstructor
public class User {
    private Integer id;
    private String name;
}


public interface UserMapper extends BaseMapper<User> {
}


@org.springframework.stereotype.Service
@Transactional
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
public class Service {
    private final UserMapper mapper;

    @CachePut(value = "user",key = "#user.id")
    public User save(User user){
        User oldUser = mapper.selectById(user.getId());
        if(oldUser == null){
            mapper.insert(user);
            return user;
        }
        if(mapper.updateById(user) == 1)
            return user;
        return oldUser;
    }

    @CacheEvict(value = "user",key = "#id")
    public boolean delete(Integer id){
        return mapper.deleteById(id) == 1;
    }

    @Cacheable(value = "user",key = "#id")
    public User select(Integer id){
        return mapper.selectById(id);
    }

    @Cacheable(value="allUser",key = "#root.target+#root.methodName")
    //root.target是目标类,这里是com.example.demo.Service,root.methodName是方法名,这里是selectAll
    public List<User> selectAll(){
        return mapper.selectList(null);
    }
}


注解说明如下:

  • @CachePut:执行方法体再将返回值缓存,一般用于更新数据
  • @CacheEvict:删除缓存,一般用于删除数据
  • @Cacheable:查询缓存,如果有缓存就直接返回,没有缓存的话执行方法体并将返回值存入缓存,一般用于查询数据


三个注解都涉及到了key以及value属性,实际上,真正的存入Rediskey是两者的组合,比如:


@Cacheable(value="user",key="#id")


则存入的Redis中的key为:


10.png


而存入对应的值为方法返回值序列化后的结果,比如如果返回值为User,则会被序列化为:


11.png


spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
  redis:
    database: 0
    host: 127.0.0.1
    port: 6379
logging:
  level:
    com.example.demo: debug


spring.redis.database指定数据库的索引,默认为0,hostport分别指定主机(默认本地)以及端口(默认6379)。

也就是说,简单配置的话可以完全省略Redis相关配置,仅指定数据库连接url、用户名以及密码:


spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test
    username: root
    password: 123456
logging:
  level:
    com.example.demo: debug


Redis服务器启动需要一个配置文件,默认位置为/etc/redis.conf(源码编译安装的话在源文件夹内),建议先复制一份:


cp /etc/redis.conf ~/Desktop/


默认的配置文件为单机Redis配置,端口6379redis-server可以直接运行:


sudo redis-server redis.conf


连接可以通过自带的redis-cli命令:


redis-cli -h localhost -p 6379


默认情况下可以直接使用


redis-cli


连接。

基本操作:

  • keys *:查询所有键
  • get key:查询key所对应的值
  • flushall:清空所有键


12.png


@SpringBootTest
@RequiredArgsConstructor(onConstructor = @__(@Autowired))
class DemoApplicationTests {

    private final Service service;

    @Test
    void select() {
        service.select(1);
        service.select(1);
    }

    @Test
    void selectAll(){
        service.selectAll();
        service.selectAll();
    }

    @Test
    void delete(){
        service.delete(1);
    }

    @Test
    void save(){
        User user = new User(1,"name1");
        service.save(user);
        service.select(user.getId());
        user.setName("name2");
        service.save(user);
        service.select(user.getId());
    }
}


执行其中的select,会发现MyBatis Plus只有一次select的输出,证明缓存生效了:


13.png


而把缓存注解去掉后,会有两次select输出:


14.png


其它测试方法就不截图了,原理类似。

其实@Cacheable/@CacheEvict/@CachePut中的value都是String [],在Java中可以直接写上value,在Kotlin中需要[value]

序列化到Redis时,实体类会被加上一个@class字段:


15.png


这个标识供Jackson反序列化时使用,笔者一开始的实体类实现是:


data class User(var id:Int?=null, var name:String="")


但是序列化后不携带@class字段:


16.png


在反序列化时直接报错:

Could not read JSON: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]: missing type id property '@class'
 at [Source: (byte[])"{"id":1,"name":"name2"}"; line: 1, column: 23]; nested exception is com.fasterxml.jackson.databind.exc.InvalidTypeIdException: Missing type id when trying to resolve subtype of [simple type, class java.lang.Object]: missing type id property '@class'
 at [Source: (byte[])"{"id":1,"name":"name2"}"; line: 1, column: 23]


解决方法有两个:

  • 手动添加@class字段
  • 将实体类设为open


12.2.1 手动添加@class


准确来说并不是手动添加,而是让注解添加,需要添加一个类注解@JsonTypeInfo


@JsonTypeInfo(use = JsonTypeInfo.Id.CLASS)
data class User(var id:Int?=null, var name:String="")


该注解的use用于指定类型标识码,该值只能为JsonTypeInfo.Id.CLASS


12.2.2 将实体类设置为open


在Java中,实体类没有任何额外配置,Redis序列化/反序列化一样没有问题,是因为值序列化器GenericJackson2JsonRedisSerializer,该类会自动添加一个@class字段,因此不会出现上面的问题。


但是在Kotlin中,类默认不是open的,也就是无法添加@class字段,因此便会反序列化失败,解决方案是将实体类设置为open:


open class User(var id:Int?=null, var name:String="")

但是缺点是不能使用data class了。

Java版:

Kotlin版:


版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Spring Boot 2.3.0发布:优雅停机等新特性一览(下)
Spring Boot 2.3.0发布:优雅停机等新特性一览(下)
54 0
Spring Boot 2.5.4 发布,Spring Boot 2.2.x 正式结束使命……
距离 Spring Boot 2.5.3 发布一个月不到,Spring Boot 2.5.4 又来了!
50 0
Spring Boot 2.5.5 发布,2.6.0 也要来了!
距离 Spring Boot 2.5.4 发布一个月不到,Spring Boot 2.5.5 又来了!
58 0
Spring Boot 2.5.1 发布!我真跟不上了。。。
距离上次的 Spring Boot 2.5.0 版本刚发布 20 天左右,Spring Boot 又连续发新版本了!
56 0
Spring Boot 2.5 重磅发布,黑暗模式太炸了!
距离上次的 Spring Boot 2.4.5 版本发布刚好一个月左右,Spring Boot 又发新版本了!
77 0
Spring Boot 2.3.3 正式发布!
Spring Boot 2.3.3 正式发布!
37 0
Spring Boot 2.0正式发布,升还是不升呢?
Spring Boot 2.0正式发布,升还是不升呢?
35 0
Spring Boot 2.5.1 发布
Spring Boot 2.5.1 发布
45 0
重磅:Spring Boot 2.0 正式发布!
image Spring Boot 2.0 正式发布! 2018/03/01最新消息,传得沸沸扬扬的Spring Boot 2.0 正式发布了。
1197 0
+关注
322
文章
0
问答
文章排行榜
最热
最新
相关电子书
更多
低代码开发师(初级)实战教程
立即下载
阿里巴巴DevOps 最佳实践手册
立即下载
冬季实战营第三期:MySQL数据库进阶实战
立即下载