SpringBoot缓存注解介绍+实战

声明

1、介绍SpringBoot注解

1.1 @Cacheable

  • 运行流程:
    1. 方法运行之前,先去查询Cache(缓存组件),按照cacheNames指定的名字获取;如果没有找到就创建一个cache组件,这里的获取是由CacheManager来完成的.
    2. 在找到的cache组件中,使用一个参数key来获取缓存的内容,默认是按照@Cacheable注解所在的方法的参数。

1.1.1 Cacheable属性

  • cacheNames/value
    指定缓存组件的名字,将方法的返回值存放在哪个缓存中,是数组的方式,可以指定多个缓存.
  • key
    缓存数据时使用的key,可以用这个属性来指定,默认使用方法参数的值.可以使用SqEL表达式来指定,比如#id方法参数id的值,#a0 #p0 #root.args[0]代表第一个参数.
  • keyGenerator
    key的生成器,可以自己指定key的生成器的组件id
//自定义配置类配置keyGenerator
@Configuration
public class MyCacheConfig {
    @Bean("myKeyGenerator")
    public KeyGenerator keyGenerator(){
        return new KeyGenerator() {
            @Override
            public Object generate(Object target, Method method, Object... params) {
                return method.getName()+"["+ Arrays.asList(params).toString() +"]";
            }
        };
    }
}
  • cacheManager
    指定缓存管理器;或者cacheResolver获取指定解析器
    ​- condition
    指定符合条件的情况下才缓存;如condition="#id>0"
  • unless
    否定缓存,当unless指定的条件为true,方法的返回值不会被缓存,可以获取到结果进行判断;如unless="#result==null";
  • sync
    是否使用异步模式
@Cacheable(cacheNames = "user",keyGenerator = "myKeyGenerator")
    public User getUser(Integer id) {
        System.out.println("查询" + id + "号用户");
        User user = userMapper.getUserId(id);
        return user;
    }

1.2 @CachePut

  • 既调用方法,又更新缓存.
  • 运行流程:
    先调用目标方法,将方法结果添加到缓存中,如果已经存在,则更新.
    1、先调用运行方法;
    2、将目标方法的结果缓存起来
    value:缓存名
    key:缓存的key其中#result表示方法返回的结果(确保更新的key和查询一致即可做到同时更新数据库数据和缓存中的数据)
@CachePut(value="user",key = "#result.id")
    public User updateUser(User user){
        System.out.println("updateUser:"+user);
        userMapper.updateUser(user);
        return user;
    }

1.3 @CacheEvict 清除缓存

  • 属性:
    key: 指定要删除的缓存的key
    allEntries: 指定清除这个缓存中的所有数据,默认是false.
    beforeInvocation : 清除缓存的在方法执行之前还是之后. 默认是false,代表在方法执行后清除.(如果方法在执行过程中出现了异常,就不会删除缓存数据)
@CacheEvict(value = "user",key = "#id")
    public void deleteUser(Integer id){
        System.out.println("deleteUser:"+id);
        userMapper.deleteUserById(id);
    }

1.4 @Caching

  • 定义复杂的缓存规则
@Caching(
            cacheable = {
                    @Cacheable()
            },
            put = {
                    @CachePut(),
                    @CachePut()
            },
            evict = {
                    @CacheEvict()
            }
    )
    public 返回值 方法名(参数类型 参数){
        return 返回结果;
    }

1.5 @EnableCaching

  • 开启缓存注解驱动,否则后面使用的缓存都是无效的

1.6 @CacheConfig

  • 这个注解的作用就是全局配置缓存,比如配置缓存的名字(cacheNames),只需要在类上配置一次,下面的方法就默认以全局的配置为主,不需要进行第二次配置,节省了部分代码。

2、缓存实战

  • 简介
    该项目是基于SSM开发的,工具采用的是idea+mysql+postman。

2.1 项目搭建

搭建一个SpringBoot+Mybatis环境,这个就不多说了。


项目结构.png

2.2 pom.xml

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.0</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </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>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
    </dependencies>

2.3 Dao层

@Mapper
public interface ArtileDao {
   
    /**
     * 通过ID查询单条数据
     *
     * @param id 主键
     * @return 实例对象
     */
    Artile queryById(Integer id);

    /**
     * 新增数据
     *
     * @param artile 实例对象
     * @return 影响行数
     */
    int insert(Artile artile);

    /**
     * 修改数据
     *
     * @param artile 实例对象
     * @return 影响行数
     */
    int update(Artile artile);

    /**
     * 通过主键删除数据
     *
     * @param id 主键
     * @return 影响行数
     */
    int deleteById(Integer id);

}

2.4 ServiceImpl层

  • 这里的话,我就省略了Service。
  • 我们在service层配置了 @CacheConfig,,并且指定了key,这样的话,我们出了第一次之外,我们都会吧结果混存起来,以后的结果,都会吧这个缓存直接返回。当我们进行更新数据的时候,使用@ CacheEvict来清除缓存,防止调用@Cacheable的时候没有更新缓存。
@Service("artileService")
@CacheConfig(cacheNames = "articleCache")
public class ArtileServiceImpl implements ArtileService {
    @Resource
    private ArtileDao artileDao;

    /**
    * @Description: 根据主键查询
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:57 AM
    */ 
    @Cacheable(value = "articleCache")
    @Override
    public Artile queryById(int id) {
        try {
            //模拟耗时操作
            Thread.sleep(5000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        return this.artileDao.queryById(id);
    }

    /**
    * @Description: 新增数据
    * @params: [artile]
    * @return: int
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:57 AM
    */ 
    @CachePut
    @Override
    public int insert(Artile artile) {
        return this.artileDao.insert(artile);
    }

    /**
    * @Description: 修改数据
    * @params: [artile]
    * @return: com.ustcinfo.cache.entity.Artile
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:57 AM
    */ 
    @CacheEvict(key = "#artile.id")
    @Override
    public int update(Artile artile) {
        return  this.artileDao.update(artile);
    }

    /**
    * @Description: 根据主键删除
    * @params: [id]
    * @return: boolean
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:58 AM
    */ 
    @CacheEvict(key = "#id")
    @Override
    public boolean deleteById(Integer id) {
        return this.artileDao.deleteById(id) > 0;
    }
}

2.5 Controller层

@RestController
@RequestMapping("artile")
public class ArtileController {
    /**
     * 服务对象
     */
    @Resource
    private ArtileService artileService;
    
  /**
    * @Description: 根据主键查询
    * @params: [id]
    * @return: java.util.Map<java.lang.String,java.lang.Object>
    * @Author: wangxianlin
    * @Date: 2020/3/17 1:48 PM
    */ 
    @GetMapping("queryById")
    public Map<String,Object> queryById(@RequestParam("id") int id) {
        Map<String,Object> map = new HashMap<>();
        Long start = System.currentTimeMillis();
        map.put("data",this.artileService.queryById(id));
        Long end = System.currentTimeMillis();
        map.put("time",(end-start));
        return map;
    }

    /**
    * @Description: 新增
    * @params: [artile]
    * @return: int
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:55 AM
    */
    @PostMapping("insert")
    public int insert(@RequestBody Artile artile) {
        return this.artileService.insert(artile);
    }

    /**
    * @Description: 修改
    * @params: [artile]
    * @return: com.ustcinfo.cache.entity.Artile
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:55 AM
    */
    @PostMapping("update")
    public int update(@RequestBody Artile artile) {
        return this.artileService.update(artile);
    }

    /**
    * @Description: 根据主键删除
    * @params: [id]
    * @return: boolean
    * @Author: wangxianlin
    * @Date: 2020/3/17 10:56 AM
    */
    @GetMapping("deleteById")
    public boolean deleteById(@RequestParam("id") Integer id) {
        return this.artileService.deleteById(id);
    }
}

2.6 启动类

@MapperScan("com.ustcinfo.cache.dao")
@SpringBootApplication
//开启缓存注解驱动,否则后面使用的缓存都是无效的
@EnableCaching
public class CacheApplication {
    public static void main(String[] args) {
        SpringApplication.run(CacheApplication.class, args);
    }
}

3、postman测试

3.1 根据主键查询

  • 第一次进行查询:


    image.png
  • 第二次进行查询:


    image.png

3.2 添加

image.png
  • 在查询一次:


    image.png

    image.png

3.3 修改

image.png
  • 在查询一次:


    在查询一次

3.3 删除

image.png
  • 在查询一次:


    image.png

    image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
禁止转载,如需转载请通过简信或评论联系作者。
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 156,907评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,546评论 1 289
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 106,705评论 0 238
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,624评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,940评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,371评论 1 210
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,672评论 2 310
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,396评论 0 195
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,069评论 1 238
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,350评论 2 242
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,876评论 1 256
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,243评论 2 251
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,847评论 3 231
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,004评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,755评论 0 192
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,378评论 2 269
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,266评论 2 259

推荐阅读更多精彩内容

  • 前言:缓存在开发中是一个必不可少的优化点,近期在公司的项目重构中,关于缓存优化了很多点,比如在加载一些数据比较多的...
    程序员BUG阅读 860评论 0 0
  • 默认的缓存配置[#] 在诸多的缓存自动配置类中, SpringBoot默认装配的是SimpleCacheConfi...
    扯淡巴阅读 369评论 0 0
  • 1、Spring缓存 1.1、缓存依赖 1.2、缓存注解 @EnableCaching:在主入口类上添加该注解,用...
    木石前盟Caychen阅读 796评论 0 6
  • 本文为转载,原文地址:http://www.cnblogs.com/yueshutong/p/9381540.ht...
    吟风者阅读 36,516评论 2 22
  • 又到了星期二通话的时间了,林江拨通了文清的电话,果然没有以前的一拨即通,响了许久,电话才被接起来。也没有了以前那声...
    云中燕2018阅读 210评论 0 1