为 Spring Boot 应用添加 Redis Caching

最新推荐文章于 2024-06-14 06:00:00 发布
最新推荐文章于 2024-06-14 06:00:00 发布
阅读量218 收藏 1
点赞数
分类专栏： 草根Java之路
欢迎关注我的个人公众号：超级码里奥。如果这对您有帮助，欢迎点赞和分享，转载请注明出处
本文链接：https://blog.csdn.net/qq_28804275/article/details/89167838
版权

中大型应用开发中，缓存的重要性不言而喻，早期常用的进程式类的缓存，像 EhCache 或者是 ConcurrentHashMap 这样的容器，发展到如今，更流行的是那些分布式的独立缓存服务，如：Redis、Memcached。

对于 Java 应用开发者来说，Spring 提供了完善的缓存抽象机制，结合 Spring Boot 的使用，可以做到非常轻松的完成缓存实现和切换。下面通过简单的示例，展示下如何快速为你的 Spring Boot 应用添加 Redis Caching。

  1. 加入依赖
<dependencies>
        <!-- 添加该依赖后，将自动使用 Redis 作为 Cache Provider -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</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>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>
  1. 补充配置
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?useUnicode=true&zeroDateTimeBehavior=convertToNull&characterEncoding=utf-8&useSSL=false&serverTimezone=GMT%2B8&tinyInt1isBit=false
    username: root
    password: root
  jpa:
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    hibernate:
      ddl-auto: create
    # 开启 SQL 输出，方便查看结果是否走了缓存
    show-sql: true
    open-in-view: false
  redis:
    host: localhost
  cache:
    # 非必须，但如果配置了需补充相应的依赖，否则会出错
    #type: redis
    redis:
      # 过期时间5秒，默认单位：毫秒，等同于设置成 5s、5S
      time-to-live: 5000
      key-prefix: cn.mariojd.cache.
      cache-null-values: false
  1. 添加实体，实现 Serializable 接口
@Data
@Entity
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class User implements Serializable {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;

    private String name;

}

定义 Repository 接口：

public interface UserRepository extends JpaRepository<User, Integer> {
}
  1. 编写 Service，进行缓存规则配置，核心注解有：@CacheConfig、@Cacheable(缓存新增)、@CachePut(缓存更新)、@CacheEvict(缓存删除)
@Slf4j
@Service
@CacheConfig(cacheNames = "user")
public class UserService {

    @Resource
    private UserRepository userRepository;

    /**
     * Key name: key-prefix.classSimpleName.methodName?pn=xxx&ps=xxx&sort=xxx
     */
    @Cacheable(key = "#root.targetClass.simpleName+'.'+#root.methodName+'?pn='+#pageable.pageNumber+'&ps='+#pageable.pageSize+'&sort='+#pageable.sort.toString()")
    public Page<User> page(Pageable pageable) {
        return userRepository.findAll(pageable);
    }

    @Cacheable(key = "'user.'+#userId", unless = "#result == null")
    public Optional<User> get(int userId) {
        return userRepository.findById(userId);
    }

    @Transactional
    public User add(String name) {
        User user = User.builder().name(name).build();
        return userRepository.save(user);
    }

    @CachePut(key = "'user.'+#userId", unless = "#result == null")
    @Transactional
    public Optional<User> update(int userId, String name) {
        Optional<User> userOptional = userRepository.findById(userId);
        userOptional.ifPresent(user -> {
            user.setName(name);
            userRepository.save(user);
        });
        return userOptional;
    }

    @CacheEvict(key = "'user.'+#userId")
    @Transactional
    public void delete(int userId) {
        userRepository.findById(userId).ifPresent(user -> userRepository.delete(user));
    }

}
  1. 缓存测试，为启动类添加：@EnableCaching
@Slf4j
@EnableCaching
@SpringBootApplication
public class SpringBootCacheApplication implements ApplicationRunner {

    public static void main(String[] args) {
        new SpringApplicationBuilder()
                .sources(SpringBootCacheApplication.class)
                .bannerMode(Banner.Mode.OFF)
                .web(WebApplicationType.NONE)
                .run(args);
        log.info("\n");
    }

    @Resource
    private UserRepository userRepository;

    @PostConstruct
    public void init() {
        // 初始化数据
        for (int i = 0; i < 10; i++) {
            User user = User.builder().name("ZS" + i).build();
            userRepository.save(user);
        }
    }

    @Resource
    private UserService userService;

    @Resource
    private Environment environment;

    @Override
    public void run(ApplicationArguments args) throws InterruptedException {
        // 测试缓存，观察是否有SQL输出

        PageRequest pageable = PageRequest.of(0, 5);
        userService.page(pageable);
        for (int i = 0; i < 5; i++) {
            userService.page(pageable);
            log.info("Reading page cache...");
        }
        // 由于配置是5秒中后缓存失效，这里休眠后重新读取
        TimeUnit.MILLISECONDS.sleep(Integer.parseInt(environment.getProperty("spring.cache.redis.time-to-live", "5000")));
        log.warn("Page Cache expired : " + userService.page(pageable).getTotalElements());

        log.info("\n");

        // Test CRUD Cache![enter description here](http://image.mariojd.cn/happyjared/201949/20190409101855.png)
        User user = userService.add("李四");
        int userId = user.getId();
        userService.get(userId);
        log.info("Reading user cache..." + userService.get(userId));

        userService.update(userId, "王五");
        log.info("Reading new user cache..." + userService.get(userId));

        userService.delete(userId);
        log.warn("User Cache delete : " + userService.get(userId));
    }
    
}

从图中的红框部分输出可以看到，这些查询走了缓存，如果需要在 redis 中查看缓存内容，可以将配置中的 TTL 时间调大：

9709135-f60301cc0efc23bd.png

测试输出

扩展操作

Spring 允许开发者们通过自定义 KeyGenerator 来覆盖繁琐的 Key 定义（非必须），同时也允许我们配置自定义的 CacheManager，下面来看看如何编写 KeyGenerator：

9709135-757e61498521fcd2.png

@CacheConfig

@Slf4j
public class CustomKeyGenerator implements KeyGenerator {

    @Override
    public Object generate(Object target, Method method, Object... params) {
        // 类名.方法名.参数值
        String keySuffix = target.getClass().getSimpleName() + "." + method.getName() + "." + Arrays.toString(params);
        log.info("Cache key suffix : {}", keySuffix);
        return keySuffix;
    }

}

接着配置注册为 Bean：

@Configuration
public class CustomConfig {

    @Bean
    public CustomKeyGenerator customKeyGenerator() {
        return new CustomKeyGenerator();
    }

}

编写 Service 用于测试，具体的测试代码这里就不再贴出来了，有兴趣的可以自行尝试。

@Slf4j
@Service
@CacheConfig(cacheNames = "user")
public class UserSupportService {

    @Resource
    private UserRepository userRepository;

    /**
     * 使用了自定义的KeyGenerator
     * 缓存生效需满足：存在不为空的入参i、且返回值非空
     */
    @Cacheable(keyGenerator = "customKeyGenerator", condition = "#i!=null", unless = "#result.isEmpty()")
    public List<User> list(Integer i) {
        return userRepository.findAll();
    }

}

参考阅读

Spring-Boot-Caching

示例源码
欢迎关注我的个人公众号：超级码里奥
如果这对您有帮助，欢迎点赞和分享，转载请注明出处

happyJared
关注
专栏目录
Spring Boot 整合Redis :spring-boot-starter-data-redis
allen_csdns的博客
03-26 4747
1.添加maven依赖 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency> <!-- redis依赖co...
SpringBoot Redis Cache
qq_41505160的博客
05-30 835
官方支持的实现包括Generic、JCache(JSR-107)、（EhCache 3，Hazelcast，Infinispan，and others）、EhCache 2.x、Hazelcast、Infinispan、Couchbase、Redis、Caffeine、Simple等。：表示被调用的方法先要去缓存中查询，如果命中则返回缓存中的内容，否则调用方法返回并将返回结果存入缓存。：用来更新缓存，旧的值会被覆盖，方法一定会执行。：标注在类上，对类中的方法统一设置缓存操作。设置方法执行前删除缓存。
4. Spring Boot Caching Redis
lee_ccr的博客
10-22 139
文章目录说明例参考 说明 要启用缓存支持，只需要 @EnableCaching 注释，Spring 引导就会自动配置缓存基础设施 例 pom.xml（只粘贴部分内容） &amp;lt;dependencies&amp;gt; &amp;lt;dependency&amp;gt; &amp;lt;groupId&amp;gt;org.springframework.boot&amp;lt;/groupId&amp;gt;
SpringBoot缓存使用Redis与@CaChe注解整合 简洁使用
z12306z的博客
06-23 854
SpringBoot缓存使用Redis与@CaChe注解整合
分布式缓存Redis Cache
hacker_lli的博客
09-15 6688
本文设计技术点：spring cache, Lettuce, Spring Data Redis 开始之前，有个问题，知道什么是分布式部署吗，分布式部署都用在什么地方 现在的应用大都以微服务的方式进行分布式部署，因此如果仅仅使用本地缓存是满足不了需求的（Infinispan这样基于本地的内存实现的分布式缓存在这里暂不作讨论。。。）针对分布式场景下的缓存应用，我们急需要一个高可用的、快速的、中心化的、分布式的缓存产品。然后在众多此场景的实现产品中，Redis以它众多优秀的特性脱颖而出。 所以，本文集中讲的点都
SpringBoot(3):springboot集成redis和cache实现缓存
weixin_43700342的博客
05-14 773
Redis知识点 在项目中对数据的访问往往都是直接访问数据库的方式，但如果对数据的访问量很大或者访问很频繁的话，将会对数据库来很大的压力，甚至造成数据库崩溃。为了解决这类问题redis数据库脱颖而出，redis数据库出现时是以非关系数据库的光环展示在广大程序猿的面前的，后来redis的迭代版本支持了缓存数据、登录session状态（分布式session共享）等。所以又被作为内存缓存的形式应用到大型...
spring boot集成redis做为通用缓存的实战demo，帮助大家彻底掌握s-cache-practice.zip
01-29
1. **添加依赖**：在 `pom.xml` 文件中，我们需要引入 Spring Boot 的 Redis starter 和 Redisson（一个 Redis 客户端库）依赖。这将确保我们能够利用 Spring Boot 的自动配置特性来轻松设置 Redis 连接。 ```xml ...
35.[视频] Spring Boot集成Redis实现缓存机制【从零开始学Spring Boot】
08-13
- **添加依赖**：首先，我们需要在Spring Boot项目的`pom.xml`或`build.gradle`文件中添加Spring Data Redis和Redis客户端Jedis或Lettuce的相关依赖。 - **配置Redis连接**：在`application.properties`或`...
Spring Boot 注解式Redis缓存深度解析
通过这种方式，Spring Boot允许开发者在不改变业务逻辑的情况下，轻松地将常用数据或计算结果存储在Redis中，提高应用程序的性能和响应速度。理解和掌握这些注解的使用，对于在Spring Boot项目中有效地利用Redis缓存...
RedisCache
gmlic的博客
04-05 4694
/** Redis缓存管理类 @author Administrator */ public class RedisCache implements Cache{ private RedisTemplate<String, Object> redisTemplate; private String name; public RedisTemplate<S...
SpringBoot系列——使用Spring Cache和Redis实现查询数据缓存
最新发布
weixin_73588491的博客
06-14 4913
在现代应用程序中，查询缓存的使用已经变得越来越普遍。它不仅能够显著提高系统的性能，还能提升用户体验。缓存通过在内存中存储频繁访问的数据，减少对数据库或其他存储系统的访问，从而加快数据读取速度。在这篇文章中，我们将探讨缓存的基本概念、重要性以及如何使用Spring Cache和Redis实现查询数据缓存。缓存是一种临时存储机制，用于在内存中保存频繁访问的数据。它可以是硬件（如CPU缓存）或软件（如应用程序缓存）。缓存的主要目的是通过减少数据访问的延迟，提高系统的响应速度。临时性。
REDIS12_Spring Cache概述、@Cacheable、@CacheEvict、@Caching、@CachePut的使用
所得皆惊喜
09-01 1029
文章目录①. Spring Cache概述②. Spring cache入门案列@Cacheable③. JSON格式转换、空值缓存④. @CacheEvict、@Caching、@CachePut的使用⑤. SpringCache原理与不足 ①. Spring Cache概述 ①. 如何找到Spring Cache的官方文档 (https://docs.spring.io/spring-framework/docs/5.2.17.BUILD-SNAPSHOT/spring-framework-refe
springboot 缓存2_ cacheable的key属性
grow_的博客
04-08 1324
cacheNames给缓存一个名字，相当于定义了一个容器 cacheNames key1 value1 key2 value2 ...... ..... key的命名： 名字 描述 示例 methodName 当前被调用的方法名 #root.methodName target
springbootCache和Redis缓存机制
m0_48159893的博客
02-09 4039
简介 我想要开发一个社交网站，社交网站存储好友列表成为了开发过程中的一大难题。 如果我想要保存每一个用户的好友信息该怎么保存呢？ 用用户的id对应着好友的id，这样一条信息就是一个好友关系映射图，这张关系表可能长下面这样 id user_id friend_id 1 1 2 2 1 一个用户的好友由friend_id记录，1号用户和2号用户互为好友，这样的记录虽然冗余但是不得不记录下来。但是这样有很大的弊端。 假设我有200个用户，每个用户有300个好友，那么这样一张表就会有200
springboot 2.0.0.M7 之 h2 嵌入式数据库的使用
架构师的成长之路的博客
01-10 2582
h2 嵌入式数据库的使用更多干货spring-boot系列一 之restfull api与多环境配置springboot系列二之 日志SpringBoot系列三之 MVC 模版引擎SpringBoot 2.0.0.M7 系列四 异常处理springboot 2.0.0.M7之 注解 与 配置springboot 2.0.0.M7 配置mvcspringboot 2.0.0.M7 之 Servlet...
Springboot中Spring-cache与redis整合
热门推荐
u011521890的专栏
09-24 2万+
也是在整合redis的时候偶然间发现spring-cache的。这也是一个不错的框架，与spring的事务使用类似，只要添加一些注解方法，就可以动态的去操作缓存了，减少代码的操作。如果这些注解不满足项目的需求，我们也可以参考spring-cache的实现思想，使用AOP代理+缓存操作来管理缓存的使用。 在这个例子中我使用的是redis，当然，因为spring-cache的存在，我们可以整合多样的缓
SpringBoot中SpringCache整合redis实现
weixin_45962741的博客
10-11 542
结合上一篇博客来看： SpringBoot整合Redis 开始整合 SpringCache，这里只演示如何整合： 添加 maven 依赖： <!--redis操作--> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId>
为 Spring Boot 应用添加 Redis Caching，2024年最新Java面试经历
m0_57541068的博客
04-02 374
引领完成Docker的安装、部署、管理和扩展，让其经历从测试到生产的整个开发生命周期，深入了解Docker适用于什么场景。并且这本Docker的学习权威指南介绍了其组件的基础知识，然后用Docker构建容器和服务来完成各种任务：利用Docker为新项目建立测试环境，演示如何使用持续集成的工作流集成Docker，如何构建应用程序服务和平台，如何使用Docker的API，如何扩展Docker。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值