Spring 学习笔记读取 JSON文件 + Cach缓存

旧城等待， 2022-11-13 04:27 199阅读 0赞

### Spring 学习笔记 Cach缓存 ###

*  工具类
 *  缓存注解
 *   *  1. 启动类
     *  2. 开启缓存
     *  3. 更新缓存
     *  4. 清理缓存
     *  5. 过期时间
 *  参考资料

# 工具类 #

加载 JSON 文件

import com.fasterxml.jackson.databind.JsonNode;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.stereotype.Component;
    
    import java.io.File;
    
    /** * @author jerryjin */
    @Component
    public class LoadJsonUtil { 
    
        private static final Logger log = LoggerFactory.getLogger(LoadJsonUtil.class);
        
        private static ObjectMapper objectMapper = new ObjectMapper();
        
        public static JsonNode load(String filePath){ 
            try { 
                File file = new File(filePath);
                JsonNode jsonNode = objectMapper.readTree(file);
                return jsonNode;
            }
            catch (Exception e) { 
                log.info("读取JSON文件失败： {}", e.getMessage());
            }
            return objectMapper.createObjectNode();        
        }
        
    }

# 缓存注解 #

## 1. 启动类 ##

添加 `@EnableCaching`

## 2. 开启缓存 ##

控制器方法上添加 `@Cacheable(value = "缓存名")` 或 `@Cacheable("缓存名")`  
`缓存名`自己取。

@Cacheable(value = "cacheName")
        @RequestMapping("hi")
        public JsonNode hi(@RequestParam(defaultValue = "") String jsonFilePath){ 
            return LoadJsonUtil.load(String.format(jsonFilePath));
        }

## 3. 更新缓存 ##

控制器方法上添加`@CachePut(value = "缓存名称")`  
`"缓存名称`与`@Cacheable`中的保持一至。

@CachePut(value = "cacheName")
        @RequestMapping("hi")
        public JsonNode hi(@RequestParam(defaultValue = "") String jsonFilePath){ 
            return LoadJsonUtil.load(String.format(jsonFilePath));
        }

## 4. 清理缓存 ##

控制器方法上添加`@CacheEvict(value="缓存名称", allEntries=true)`  
`"缓存名称`与`@Cacheable`中的保持一至。  
`allEntries=true`表示清除此名称下的所有缓存。（比如分页查询接口）

@CacheEvict(value="cacheName", allEntries=true)
        @GetMapping("hi/clear")
        public String hiClear(){ 
            return "缓存清理成功！";
        }

## 5. 过期时间 ##

`@Cacheable`默认没有过期时间设置。  
我们只能通过`@CacheEvict`配合定时任务`@Scheduled`曲线求国。  
为了方便管理，将有效期配置在`application.yml`中。

jerry:
      cache:
      	# 每隔10分钟执行一次
        expires: 0 0/10 * * * ?

/** * 配合定时任务，每过10分钟清理一次缓存 */
        @Scheduled(cron="${jerry.cache.expires}")
        @CacheEvict(value="缓存名称", allEntries=true)
        @GetMapping("hi/clear")
        public String hiClear(){ 
            return "缓存清理成功！";
        }

@Scheduled(cron="$\{jerry.cache.expires\}")

# 参考资料 #

[SpringBoot 学习笔记 【定时任务】][SpringBoot _]

[Caching Data with Spring][]  
[官方文档：8. Cache Abstraction][8. Cache Abstraction]

[spring cache 学习 —— @Cacheable 使用详解][spring cache _ _ _Cacheable]  
[SpringBoot @Cacheable注解的属性使用][SpringBoot _Cacheable]

[SpringBoot _]: https://blog.csdn.net/jx520/article/details/109728076
[Caching Data with Spring]: https://spring.io/guides/gs/caching/
[8. Cache Abstraction]: https://docs.spring.io/spring-framework/docs/current/reference/html/integration.html#cache
[spring cache _ _ _Cacheable]: https://www.cnblogs.com/coding-one/p/12401630.html
[SpringBoot _Cacheable]: https://blog.csdn.net/nihui123/article/details/89055629