展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > SpringBoot下集成缓存工具类CacheManager怎么使用

SpringBoot下集成缓存工具类CacheManager怎么使用

一.自定义工具类定义packagecom.demo.utils;importorg.springframework.util.StringUtils;importjava.util.LinkedList;importjava.util.List;importjava.util.Map;importjava.util.concurrent.*;importjava.util.concurrent.atomic.AtomicInteger;/***Description:缓存工具类*1.部分方法未验证,如有问

本文目录

    一.自定义工具类定义

    package com.demo.utils;
    
    import org.springframework.util.StringUtils;
    
    import java.util.LinkedList;
    import java.util.List;
    import java.util.Map;
    import java.util.concurrent.*;
    import java.util.concurrent.atomic.AtomicInteger;
    
    /**
     * Description: 缓存工具类
     * 1.部分方法未验证,如有问题请自行修改
     * 2.其他方法请自行添加
     *
     * @Author: zhx & moon hongxu_1234@163.com
     * @Date: 2022-04-07 20:54
     * @version: V1.0.0
     */
    public class Cache {
    
        /**
         * 屏蔽工具类的无参构造 避免工具类被实例化
         */
        private Cache(){}
    
        /**
         * 缓存留存期 30min 1H 24H
         */
        public static final long CACHE_HOLD_TIME_30M = 30 * 60 * 1000L;
        public static final long CACHE_HOLD_TIME_1H = 2 * CACHE_HOLD_TIME_30M;
        public static final long CACHE_HOLD_TIME_24H = 24 * CACHE_HOLD_TIME_1H;
        public static final long CACHE_HOLD_TIME_FOREVER = -1L;
    
        /**
         * 缓存容量、最少使用容量
         */
        private static final int CACHE_MAX_CAP = 1000;
        private static final int CLEAN_LRU_CAP = 800;
    
        /**
         * 缓存当前大小
         */
        private static AtomicInteger CACHE_CURRENT_SIZE = new AtomicInteger(0);
    
        /**
         * 缓存对象
         */
        private static final Map CACHE_MAP = new ConcurrentHashMap<>(CACHE_MAX_CAP);
    
        /**
         * 最少使用记录
         */
        private static final List LRU_LIST = new LinkedList<>();
    
        /**
         * 自动清理标志位
         */
        private static volatile boolean CLEAN_RUN_FLAG = false;
    
        /**
         * 默认30MIN
         * @param key
         * @param val
         */
        public static void put(String key,Object val){
            put(key,val,CACHE_HOLD_TIME_30M);
        }
    
        /**
         * 添加永久缓存
         * @param key
         * @param val
         */
        public static void putForever(String key,Object val){
            put(key,val,CACHE_HOLD_TIME_FOREVER);
        }
    
        /**
         * 添加缓存
         * @param key
         * @param val
         * @param ttlTime
         */
        public static void put(String key,Object val,long ttlTime){
            if (!StringUtils.hasLength(key) || null == val){
                return;
            }
            checkSize();
            updateCacheLru(key);
            CACHE_MAP.put(key,new Node(val,ttlTime));
        }
    
        /**
         * 获取缓存信息
         * @param key
         * @param clazz
         * @param 
         * @return
         */
        public static  T get(String key,Class clazz){
            if (!StringUtils.hasLength(key) || !CACHE_MAP.containsKey(key)){
                return null;
            }
            updateCacheLru(key);
            return (T) CACHE_MAP.get(key).getVal();
        }
    
        /**
         * 更新最近使用位置
         * @param key
         */
        private static void updateCacheLru(String key){
            synchronized (LRU_LIST){
                LRU_LIST.remove(key);
                LRU_LIST.add(0,key);
            }
        }
    
        /**
         * 删除,成功则容量-1
         * @param key
         */
        private static boolean remove(String key){
            Node node = CACHE_MAP.remove(key);
            if (null!=node){
                CACHE_CURRENT_SIZE.getAndDecrement();
                return true;
            }
            return false;
        }
    
        /**
         * 检查是否超过容量,先清理过期,在清理最少使用
         */
        private static void checkSize(){
            if (CACHE_CURRENT_SIZE.intValue() > CACHE_MAX_CAP){
                deleteTimeOut();
            }
            if (CACHE_CURRENT_SIZE.intValue() > CLEAN_LRU_CAP){
                deleteLru();
            }
        }
    
        /**
         * 删除最久未使用,尾部删除
         * 永久缓存不会被清除
         */
        private static void deleteLru(){
            synchronized (LRU_LIST){
                while (LRU_LIST.size() > CLEAN_LRU_CAP){
                    int lastIndex = LRU_LIST.size() - 1;
                    String key = LRU_LIST.get(lastIndex);
                    if (!CACHE_MAP.get(key).isForever() && remove(key)){
                        LRU_LIST.remove(lastIndex);
                    }
                }
            }
        }
    
        /**
         * 删除过期
         */
        private static void deleteTimeOut(){
            List del = new LinkedList<>();
            for (Map.Entry entry:CACHE_MAP.entrySet()){
                if (entry.getValue().isExpired()){
                    del.add(entry.getKey());
                }
            }
            for (String k:del){
                remove(k);
            }
        }
    
        /**
         * 缓存是否已存在,过期则删除返回False
         * @param key
         * @return
         */
        public static boolean contains(String key){
            if (CACHE_MAP.containsKey(key)){
                if (!CACHE_MAP.get(key).isExpired()){
                    return true;
                }
                if (remove(key)){
                    return false;
                }
                return true;
            }
            return false;
        }
    
        /**
         * 清空缓存
         */
        public static void clear(){
            CACHE_MAP.clear();
            CACHE_CURRENT_SIZE.set(0);
            LRU_LIST.clear();
        }
    
        /**
         * 重置自动清理标志
         * @param flag
         */
        public static void setCleanRunFlag(boolean flag){
            CLEAN_RUN_FLAG = flag;
        }
    
        /**
         * 自动清理过期缓存
         */
        private static void startAutoClean(){
    
            if (!CLEAN_RUN_FLAG){
                setCleanRunFlag(true);
                ScheduledExecutorService scheduledExecutor = new ScheduledThreadPoolExecutor(1);
                scheduledExecutor.scheduleAtFixedRate(()->{
                    try {
                        Cache.setCleanRunFlag(true);
                        while (CLEAN_RUN_FLAG){
                            Cache.deleteTimeOut();
                        }
                    } catch (Exception e) {
                        e.printStackTrace();
                    }
                },10,Cache.CACHE_HOLD_TIME_1H, TimeUnit.SECONDS);
            }
        }
    
        /**
         * 缓存对象类
         */
        public static class Node{
            /**
             * 缓存值
             */
            private Object val;
            /**
             * 过期时间
             */
            private long ttlTime;
    
            public Node(Object val,long ttlTime){
                this.val = val;
                if (ttlTime<0){
                    this.ttlTime = ttlTime;
                }else{
                    this.ttlTime = System.currentTimeMillis() + ttlTime;
                }
            }
    
            public Object getVal(){
                return this.val;
            }
    
            public boolean isExpired(){
                if (this.ttlTime<0){
                    return false;
                }
                return System.currentTimeMillis() > this.ttlTime;
            }
    
            public boolean isForever(){
                if (this.ttlTime<0){
                    return true;
                }
                return false;
            }
    
        }
    
    
    }

    二.SpringBoot 集成开源缓存组件

    1.开源缓存组件

    缓存组件类型
    HAZELCAST分布式缓存
    INFINISPAN分布式缓存
    COUCHBASE分布式缓存
    REDIS分布式缓存
    CAFFEINE本地缓存
    CACHE2K本地缓存

    随着硬件系统系统扩展和软件升级,缓存在应用中的地位和可应用性日渐提升,SpringBoot 为此设计了一套通用缓存机制(规范)
    此规范设计了两个顶层接口 Cache 和 CacheManager 即缓存和缓存管理,通过实现CacheManager 引入缓存组件,即可在SpringBoot项目内通过注解方便的设置缓存

    通过 SpringBoot 的缓存自动配置类,查看其可支持哪些缓存组件的使用,部分源码如下:

    //org.springframework.boot.autoconfigure.cache.CacheConfigurations
    static {
        Map mappings = new EnumMap<>(CacheType.class);
        mappings.put(CacheType.GENERIC, GenericCacheConfiguration.class.getName());
        mappings.put(CacheType.HAZELCAST, HazelcastCacheConfiguration.class.getName());
        mappings.put(CacheType.INFINISPAN, InfinispanCacheConfiguration.class.getName());
        mappings.put(CacheType.JCACHE, JCacheCacheConfiguration.class.getName());
        mappings.put(CacheType.COUCHBASE, CouchbaseCacheConfiguration.class.getName());
        mappings.put(CacheType.REDIS, RedisCacheConfiguration.class.getName());
        mappings.put(CacheType.CAFFEINE, CaffeineCacheConfiguration.class.getName());
        mappings.put(CacheType.CACHE2K, Cache2kCacheConfiguration.class.getName());
        mappings.put(CacheType.SIMPLE, SimpleCacheConfiguration.class.getName());
        mappings.put(CacheType.NONE, NoOpCacheConfiguration.class.getName());
        MAPPINGS = Collections.unmodifiableMap(mappings);
    }

    2.缓存注解

    注解功能
    @EenableCacheing启用注解式缓存的功能,一般加在项目启动类上
    @Cacheable如果存在缓存,则返回缓存信息;不存在则获取值并添加到缓存
    @CachePut添加缓存,可用于更新方法(强制将方法返回值添加到指定Key)
    @CacheEvict删除缓存
    @Caching打包操作,将上面几种注解打包在一起作用
    @CacheConfig通用配置注解,如果要对某个对象设置缓存,可以将此注解标注在类上设置缓存名、主键生成器等

    3.缓存测试(caffeine)

    通过 SpringBoot 集成 Caffeine 进行缓存注解演示,相关版本信息参考依赖

    1.Pom依赖
    
    
        4.0.0
    
        org.example
        LenovoTest
        1.0-SNAPSHOT
    
        
            19
            19
            UTF-8
            3.0.0
        
        
            
                org.springframework.boot
                spring-boot-starter-web
                ${spring.version}
                
                    
                        org.springframework.boot
                        spring-boot-starter-logging
                    
                
            
            
                org.springframework.boot
                spring-boot-starter-log4j2
                ${spring.version}
            
            
                org.springframework.boot
                spring-boot-starter-aop
                ${spring.version}
            
            
                org.springframework.boot
                spring-boot-starter-cache
                ${spring.version}
            
    
            
                com.github.ben-manes.caffeine
                caffeine
                3.1.2
            
            
            
                org.projectlombok
                lombok
                1.18.24
            
            
                com.alibaba
                fastjson
                2.0.14.graal
            
        
    
    2.Yml配置(指定缓存实现类型)
    server:
      port: 8088
    
    spring:
      cache:
       type: caffeine
    
    custom-caffeine:
      specs:
        ## 用户信息写入10S后过期
        userInfo: maximumSize=10,expireAfterWrite=10s
        ## 登陆信息写入5S后过期
        accessInfo: maximumSize=10,expireAfterWrite=5s
    3.项目启动类
    package com.demo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cache.annotation.EnableCaching;
    
    /**
     * @author 
     * @date 
     * @since 1.8
     */
    @EnableCaching
    @SpringBootApplication
    public class TestApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(TestApplication.class,args);
        }
    }
    4.自定义缓存配置

    如果不通过Yml指定缓存实现类型,则将使用默认实现

    package com.demo.comfig;
    
    import com.github.benmanes.caffeine.cache.Caffeine;
    import org.springframework.beans.factory.annotation.Qualifier;
    import org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration;
    import org.springframework.boot.context.properties.ConfigurationProperties;
    import org.springframework.cache.CacheManager;
    import org.springframework.cache.caffeine.CaffeineCacheManager;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.context.annotation.Primary;
    
    import java.util.HashMap;
    import java.util.Iterator;
    import java.util.Map;
    
    /**
     * @author 
     * @date 
     * @since 1.8
     */
    @Configuration
    public class CustomCaffeineConfig {
    
        /**
         * 加载 Caffeine 配置
         * @return
         */
        @Bean(name = "caffeineProperties")
        @ConfigurationProperties(prefix = "custom-caffeine.specs")
        public Map caffeineProperties(){
            return new HashMap(16);
        }
    
        /**
         * 自定义 CacheManager
         * @param properties
         * @return
         */
        @Bean
        @Primary
        public CacheManager caffeineManager(@Qualifier("caffeineProperties") Map properties){
    
            CaffeineCacheManager manager = new CaffeineCacheManager();
            Map.Entry entry;
            Iterator> iterator = properties.entrySet().iterator();
            while (iterator.hasNext()){
                entry = iterator.next();
                manager.registerCustomCache(entry.getKey(), Caffeine.from(entry.getValue()).build());
            }
            return manager;
        }
    }
    5.测试类

    定义一个 User 对象

    package com.demo.entity;
    
    import lombok.Data;
    
    /**
     * @author zhanghx19
     * @date 2023-01-28 15:53
     * @since 1.8
     */
    @Data
    public class UserInfo {
        private String name;
        private String account;
        private long age;
    }

    定义一个 Controller 类用于测试

    package com.demo.controller;
    
    import com.demo.entity.UserInfo;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.cache.Cache;
    import org.springframework.cache.CacheManager;
    import org.springframework.cache.annotation.CacheEvict;
    import org.springframework.cache.annotation.CachePut;
    import org.springframework.cache.annotation.Cacheable;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestParam;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author 
     * @date 2023-01-28 11:36
     * @since 1.8
     */
    
    @RestController
    @RequestMapping("/test")
    public class TestController {
    
        /**
         * 注入缓存管理器,所有注解操作也可以直接操作管理器实现
         */
        @Autowired
        CacheManager cacheManager;
    
        /**
         * CachePut 强制刷新缓存
         * @param id
         * @param val
         * @return
         */
        @GetMapping("/update")
        @CachePut(cacheNames = "test" ,key = "#id")
        public String update(String id,String val){
            //TODO Query Data By @{id}
            return val;
        }
    
    	/**
         * Cacheable 查看缓存,存在则直接返回;否则查询数据,添加缓存并返回
         * @param id
         * @param val
         * @return
         */
        @GetMapping("/query")
        @Cacheable(cacheNames = "test" ,key = "#id" )
        public String query(String id,String val){
            //TODO Query Data By @{id}
            return val;
        }
    
        /**
         * 删除注解内指定的 缓存名下的 Key
         * @param id
         */
        @GetMapping("/deleteTest")
        @CacheEvict(cacheNames = "test",key = "#id")
        public void deleteTest(String id){
        }
    
        /**
         * 通过 cacheManager 删除缓存
         * @param cacheNames
         * @param id
         */
        @GetMapping("/deleteByNameAndKet")
        public void deleteByNameAndKet(String cacheNames,String id){
            Cache cache = cacheManager.getCache(cacheNames);
            cache.evict(id);
        }
    
        /**
         * CachePut 强制缓存用户信息 且10秒后过期
         * @param id
         * @param val
         * @return
         */
        @GetMapping("/updateUser")
        @CachePut(cacheNames = "userInfo" ,key = "#id")
        public String updateUser(String id,String val){
            return val;
        }
    
        /**
         * Cacheable 10秒内缓存不更新,丢失后可刷新为当前值
         * @param id
         * @param val
         * @return
         */
        @GetMapping("/queryUser")
        @Cacheable(cacheNames = "userInfo" ,key = "#id")
        public String queryUser(String id,String val){
            return val;
        }
    
        /**
         * 缓存对象
         * @param id
         * @param val
         * @return
         */
        @GetMapping("/queryUserById")
        @Cacheable(cacheNames = "userInfo" ,key = "#id")
        public UserInfo getUserInfo(String id,String val){
            UserInfo info = new UserInfo();
            info.setAccount(id);
            info.setName(val);
            info.setAge(System.currentTimeMillis());
            return info;
        }
    
    }
    6.测试记录

    启动项目,添加强制缓存

    SpringBoot下集成缓存工具类CacheManager怎么使用

    利用 Cacheable 尝试刷新缓存(返回已存在值)

    SpringBoot下集成缓存工具类CacheManager怎么使用

    删除缓存

    SpringBoot下集成缓存工具类CacheManager怎么使用

    再次利用 Cacheable 尝试刷新缓存(上面清除后则可刷新)

    SpringBoot下集成缓存工具类CacheManager怎么使用

    自动过期测试,通过 CachePut 添加用户信息

    SpringBoot下集成缓存工具类CacheManager怎么使用

    尝试用 Cacheable 刷新缓存,则 10S 后可生效

    SpringBoot下集成缓存工具类CacheManager怎么使用

    10 秒后

    SpringBoot下集成缓存工具类CacheManager怎么使用

    缓存对象信息

    SpringBoot下集成缓存工具类CacheManager怎么使用

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。