{"id":20355257,"url":"https://github.com/liushuixiaoxia/springcachedemo","last_synced_at":"2026-05-09T05:32:35.608Z","repository":{"id":72228986,"uuid":"111273184","full_name":"LiushuiXiaoxia/SpringCacheDemo","owner":"LiushuiXiaoxia","description":"SpringCacheDemo","archived":false,"fork":false,"pushed_at":"2017-11-19T07:22:03.000Z","size":1071,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-10-20T17:56:09.287Z","etag":null,"topics":["cache","redis","spring"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LiushuiXiaoxia.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-11-19T07:15:41.000Z","updated_at":"2019-06-25T07:52:38.000Z","dependencies_parsed_at":"2023-02-23T13:31:33.041Z","dependency_job_id":null,"html_url":"https://github.com/LiushuiXiaoxia/SpringCacheDemo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/LiushuiXiaoxia/SpringCacheDemo","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiushuiXiaoxia%2FSpringCacheDemo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiushuiXiaoxia%2FSpringCacheDemo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiushuiXiaoxia%2FSpringCacheDemo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiushuiXiaoxia%2FSpringCacheDemo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LiushuiXiaoxia","download_url":"https://codeload.github.com/LiushuiXiaoxia/SpringCacheDemo/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LiushuiXiaoxia%2FSpringCacheDemo/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32808427,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cache","redis","spring"],"created_at":"2024-11-14T23:11:51.538Z","updated_at":"2026-05-09T05:32:35.575Z","avatar_url":"https://github.com/LiushuiXiaoxia.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Spring Cache与Redis结合使用\n\u003c!-- TOC --\u003e\n\n- [Spring Cache与Redis结合使用](#spring-cache与redis结合使用)\n    - [Redis](#redis)\n    - [创建Spring项目](#创建spring项目)\n    - [集成Redis](#集成redis)\n    - [Cache部分代码](#cache部分代码)\n\n\u003c!-- /TOC --\u003e\n\n---\n\n前不久做了一个需要查询多，更新少的功能，老司机同事建议用Redis来做缓存，同时结合Spring Cache来做，特来总结下。\n\n\n## Redis\n\nRedis 是一个高性能key-value数据库，个人感觉就像java中的Map，不过比它更加强大。\n\n由于我用的是Mac，下面介绍如何安装Redis。\n\n\n```bash\nbrew update\n\nbrew install redis\n```\n\n开启服务\n\n```bash\nbrew services start redis\n\nbrew services list\n```\n\n下面是我本机的运行截图\n\n![](https://raw.githubusercontent.com/LiushuiXiaoxia/SpringCacheDemo/master/doc/1.png)\n\n## 创建Spring项目\n\n我这边为了简单方便，直接使用了Spring Boot，直接用IntelJ Idea，需要添加`Redis`、`Cache`和`Lombok`库。\n\n![](https://raw.githubusercontent.com/LiushuiXiaoxia/SpringCacheDemo/master/doc/2.png)\n\n![](https://raw.githubusercontent.com/LiushuiXiaoxia/SpringCacheDemo/master/doc/3.png)\n\n![](https://raw.githubusercontent.com/LiushuiXiaoxia/SpringCacheDemo/master/doc/4.png)\n\n## 集成Redis\n\n集成Redis，直接在配置文件配置即可。\n\napplication.properties\n\n```\n#redis\nspring.redis.host=localhost\nspring.redis.port=6379\nspring.redis.password=\nspring.redis.timeout=0\n```\n\n然后测试下Redis是否集成功。\n\n```java\n@Slf4j\n@RunWith(SpringRunner.class)\n@SpringBootTest\npublic class SpringcacheApplicationTests {\n\n    @Autowired\n    StringRedisTemplate redisTemplate;\n\n    @Test\n    public void contextLoads() {\n        Assert.assertNotNull(redisTemplate);\n\n        redisTemplate.opsForValue().set(\"hello\", \"world\");\n        String value = redisTemplate.opsForValue().get(\"hello\");\n        log.info(\"value = \" + value);\n\n        redisTemplate.delete(\"hello\");\n\n        value = redisTemplate.opsForValue().get(\"hello\");\n        log.info(\"value = \" + value);\n    }\n}\n```\n\n运行结果如下，如果没有出错，则表示集成功。\n\n```\n2017-11-19 14:56:10.075  INFO 73896 --- [           main] c.m.s.SpringcacheApplicationTests        : value = world\n2017-11-19 14:56:10.076  INFO 73896 --- [           main] c.m.s.SpringcacheApplicationTests        : value = null\n```\n\n## Cache部分代码\n\n配置CacheManager，它的实现部分是由RedisCacheManager来实现的，我们先设置缓存时间为3s，超过这个时间，缓存自动失效。\n\n```\n@Configuration\n@EnableCaching\npublic class CachingConfig {\n\n    @Bean\n    public CacheManager cacheManager(RedisTemplate redisTemplate) {\n        RedisCacheManager redisCacheManager = new RedisCacheManager(redisTemplate);\n        redisCacheManager.setDefaultExpiration(3);\n        return redisCacheManager;\n    }\n\n    @Bean\n    public CacheErrorHandler errorHandler() {\n        return new RedisCacheErrorHandler();\n    }\n\n    @Slf4j\n    private static class RedisCacheErrorHandler extends SimpleCacheErrorHandler {\n\n        @Override\n        public void handleCacheGetError(RuntimeException exception, Cache cache, Object key) {\n            log.error(\"handleCacheGetError key = {}, value = {}\", key, cache);\n            log.error(\"cache get error\", exception);\n        }\n\n        @Override\n        public void handleCachePutError(RuntimeException exception, Cache cache, Object key, Object value) {\n            log.error(\"handleCachePutError key = {}, value = {}\", key, cache);\n            log.error(\"cache put error\", exception);\n        }\n\n        @Override\n        public void handleCacheEvictError(RuntimeException exception, Cache cache, Object key) {\n            log.error(\"handleCacheEvictError key = {}, value = {}\", key, cache);\n            log.error(\"cache evict error\", exception);\n        }\n\n        @Override\n        public void handleCacheClearError(RuntimeException exception, Cache cache) {\n            log.error(\"handleCacheClearError value = {}\", cache);\n            log.error(\"cache clear error\", exception);\n        }\n    }\n}\n```\n\n添加一个简单的实体，然后添加服务接口和实现类。\n\n`@Data`是lombok提供的，可以减少简洁代码。注意实体必须实现`Serializable`接口。\n\n```java\n@Data\npublic class User implements Serializable {\n\n    private int id;\n\n    private String name;\n\n    private String email;\n}\n```\n\n```java\npublic interface UserService {\n\n    void addUser(User user);\n\n    User findById(int id);\n\n    void delete(int id);\n}\n\n```\n\n```java\n@Slf4j\n@Service\npublic class UserServiceImpl implements UserService {\n\n    private final Map\u003cInteger, User\u003e db = new HashMap\u003c\u003e();\n\n    @Override\n    public void addUser(User user) {\n        log.info(\"addUser.user = \" + user);\n        db.put(user.getId(), user);\n    }\n\n    @Cacheable(cacheNames = \"user_cache\", key = \"#id\")\n    @Override\n    public User findById(int id) {\n        log.info(\"findById.id = \" + id);\n\n        return db.get(id);\n    }\n\n    @CacheEvict(cacheNames = \"user_cache\", key = \"#id\")\n    @Override\n    public void delete(int id) {\n        log.info(\"delete.id = \" + id);\n\n        db.remove(id);\n    }\n}\n```\n\n上面`Cacheable`和`CacheEvict`就是Spring Cache提供的注解。具体说明如下。\n\n* @Cacheable 作用和配置方法\n\n    - value、cacheNames\n    缓存的名称，在 spring 配置文件中定义，必须指定至少一个\n    例如: @Cacheable(value=”mycache”) @Cacheable(value={”cache1”,”cache2”}\n\n    - key\n    缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合\n    例如: @Cacheable(value=”testcache”,key=”#userName”)\n\n    - condition\n    缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存\n    例如：@Cacheable(value=”testcache”,condition=”#userName.length()\u003e2”)\n\n* @CacheEvict 作用和配置方法\n\n    - value\n    缓存的名称，在 spring 配置文件中定义，必须指定至少一个\n    例如: @CacheEvict(value=”my cache”)\n\n    - key\n    缓存的 key，可以为空，如果指定要按照 SpEL 表达式编写，如果不指定，则缺省按照方法的所有参数进行组合\n    例如: @CacheEvict(value=”testcache”,key=”#userName”)\n\n    - condition\n    缓存的条件，可以为空，使用 SpEL 编写，返回 true 或者 false，只有为 true 才进行缓存\n    例如: @CacheEvict(value=”testcache”,condition=”#userName.length()\u003e2”)\n\n    - allEntries\n    是否清空所有缓存内容，缺省为 false，如果指定为 true，则方法调用后将立即清空所有缓存\n    例如: @CachEvict(value=”testcache”,allEntries=true)\n\n    - beforeInvocation\n    是否在方法执行前就清空，缺省为 false，如果指定为 true，则在方法还没有执行的时候就清空缓存，缺省情况下，如果方法执行抛出异常，则不会清空缓存\n    例如: @CachEvict(value=”testcache”，beforeInvocation=true)\n\n\n测试用例：\n\n\n```java\n@Slf4j\n@RunWith(SpringRunner.class)\n@SpringBootTest\npublic class CacheTest {\n\n    @Autowired\n    UserService userService;\n\n    @Test\n    public void contextLoads() {\n        Assert.assertNotNull(userService);\n\n        // 创建一个实体\n        User user = new User();\n        user.setId(100);\n        user.setName(\"admin\");\n        user.setEmail(\"admin@123.com\");\n\n        // 添加一个\n        userService.addUser(user);\n\n        // 根据Id查询\n        log.info(\"user1 = \" + userService.findById(100));\n        sleep(1);\n        // 等1s再次查询\n        log.info(\"user2 = \" + userService.findById(100));\n        sleep(5);\n        // 等5s再次查询\n        log.info(\"user3 = \" + userService.findById(100));\n\n        // 添加一个\n        userService.addUser(user);\n        // 根据Id查询\n        log.info(\"user4 = \" + userService.findById(100));\n        // 删除\n        userService.delete(100);\n        // 根据Id查询\n        log.info(\"user5 = \" + userService.findById(100));\n    }\n\n    private void sleep(int i) {\n        try {\n            Thread.sleep(i * 1000);\n        } catch (InterruptedException e) {\n            e.printStackTrace();\n        }\n    }\n}\n```\n\n测试结果\n\n```\n2017-11-19 15:08:35.732  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : addUser.user = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:35.921  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : findById.id = 100\n2017-11-19 15:08:35.951  INFO 76558 --- [           main] cn.mycommons.springcache.CacheTest       : user1 = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:37.016  INFO 76558 --- [           main] cn.mycommons.springcache.CacheTest       : user2 = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:42.019  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : findById.id = 100\n2017-11-19 15:08:42.021  INFO 76558 --- [           main] cn.mycommons.springcache.CacheTest       : user3 = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:42.021  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : addUser.user = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:42.022  INFO 76558 --- [           main] cn.mycommons.springcache.CacheTest       : user4 = User(id=100, name=admin, email=admin@123.com)\n2017-11-19 15:08:42.023  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : delete.id = 100\n2017-11-19 15:08:42.025  INFO 76558 --- [           main] c.m.s.service.impl.UserServiceImpl       : findById.id = 100\n2017-11-19 15:08:42.025  INFO 76558 --- [           main] cn.mycommons.springcache.CacheTest       : user5 = null\n```\n\n从结果来看，添加一个数据后，第一次，查询是从UserServiceImpl中获取，再次查询，则没有直接调用UserServiceImpl，直接返回了缓存结果。\n\n当超过缓存时间后，再次去查询，我们这边设置缓存时间为3s，等待5s后，再次查询，发现又从UserServiceImpl中获取数据。\n\n当我们主动调用删除记录，同时同步清楚缓存数据后，发现查询是没有数据的。说明删除和清楚缓存操作实现了同步。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliushuixiaoxia%2Fspringcachedemo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fliushuixiaoxia%2Fspringcachedemo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fliushuixiaoxia%2Fspringcachedemo/lists"}