基于Springboot开发后台缓存管理

前言：前段时间公司让我开发一个缓存管理，然后现在简洁版功能已经实现半个多月了，今天稍微有点时间就来写下这篇文章~~

话不多说，直接放一版界面当前的功能页面

目前实现了EhCache集群查看状态、清除缓存和Redis状态以及清除缓存。
然后下面分Ehcache和Redis两块放一下关键代码吧：

Ehcache

先走一下固定流程

项目用springboot，所以这块还是很简单的。

pom.xml

        <!-- 缓存配置开始 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-cache</artifactId>
        </dependency>
        <!-- 基于 ehcache 的缓存，速度快 ，适合于单机、数据量大的对象。 -->
        <dependency>
            <groupId>net.sf.ehcache</groupId>
            <artifactId>ehcache</artifactId>
        </dependency>

ehcache.xml

ps：把ehcache.xml放在application.properties同级目录下，好像不用去application.properties中添加cache配置。

<?xml version="1.0" encoding="UTF-8"?>
<ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" updateCheck="false">
    <diskStore path="java.io.tmpdir"/>
    <defaultCache
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="true"
            timeToIdleSeconds="0"
            timeToLiveSeconds="3600"
            memoryStoreEvictionPolicy="LRU" />
    <!-- 一小时过期 -->
    <cache
            name="oneHour"
            eternal="false"
            maxElementsInMemory="10000"
            overflowToDisk="true"
            timeToIdleSeconds="0"
            timeToLiveSeconds="3600"
            memoryStoreEvictionPolicy="LRU" />
     <!-- 永不过期 -->
     <cache
            name="never"
            eternal="true"
            maxElementsInMemory="10000"
            overflowToDisk="true"
            memoryStoreEvictionPolicy="LRU" />
</ehcache>

Bootstrap.java

启动类添加注解

@EnableCaching
public class Bootstrap extends SpringBootServletInitializer{.......}

使用ehcache注解

cacheManager指定该注解 使用哪种缓存

@Cacheable(value="oneDay",key="'testCache::testData'",cacheManager=CacheManagerConfig.EHCACHE)
public Object testData(){
 return baseMapper.selectById("694fecce-b51e-478f-8718-5c75e15b9cbd");
}

到这里一个ehcache就完成了，接着说说使用代码查看和操作ehcache

---

人生第一步，却是纸尿裤：

    @Bean(name = "ehCacheManager")
    @Primary
    public EhCacheCacheManager ehCacheManager() {
        return new EhCacheCacheManager(EhCacheManagerUtils.buildCacheManager());
    }

将ehCacheManager声明成Bean，往后可以自动注入。

remove EhCache

这里是删除的方法，需要获取缓存名，也就是上面ehcache.xml配置的缓存，可以用分库的思想去理解，不同的库有各自的生命周期等配置

public void removeEhcache(String cacheName,String key) {
  Cache cache;
  if(StringUtil.isEmpty(cacheName) || "全部".equals(cacheName)){
    Collection<String> cacheNameArr = ehCacheManager.getCacheNames();
    for (String cacheNameStr : cacheNameArr) {
      cache=ehCacheManager.getCache(cacheNameStr);
      cache.evict(key);//删除ehcache
    }
  }else{
    cache=ehCacheManager.getCache(cacheName);
    cache.evict(key);
  }
}

state EhCache

哟，这里是获取ehcache状态。还可以获取更多状态~比如缓存命中率等等

    public Map<String,String> ehcacheState() {
        Map<String,String> stateMap = new HashMap<>();
        int sum=0;
        long size=0l;
        net.sf.ehcache.CacheManager cacheManager=ehCacheManager.getCacheManager();
        net.sf.ehcache.Cache cache;
        String[] cacheNameArr = cacheManager.getCacheNames();
        for (String cacheNameStr : cacheNameArr) {
            cache=cacheManager.getCache(cacheNameStr);
            sum+=cache.getSize();
            for (Object keyObj:cache.getKeys()) {
                System.out.println(String.valueOf(cache.get(keyObj).getObjectValue()));
                size +=new ReflectionSizeOf().sizeOf(cache.get(keyObj).getObjectValue());
            }
        }
        stateMap.put("sum",String.valueOf(sum));
        stateMap.put("size",String.valueOf(formetFileSize(size)));
        return stateMap;
    }

接着是让ehcache适应在集群环境下

很简单，开发两个类就行：一个请求分发类 一个簇类。
并且在配置文件中增加集群中各服务器的host：

# 集群配置，集群主机名单
cluster.hosts = 127.0.0.1:9000,127.0.0.1:9001,127.0.0.1:9002

这个可以自行根据实际情况个换配置方式，写到代码中固定也可以。

请求分发类

private List spreadRequest(String url_postfix, MultiValueMap<String, String> params) {
        List res = new ArrayList();
        if (StringUtil.isEmpty(clusterHosts)){
            return res;
        }
        String[] serverHostArr = clusterHosts.split(",");
        Map hostRes;
        for (String serverHost:serverHostArr) {
            hostRes = (Map)sendPostRequest(serverHost+url_postfix,params).get("parameters");
            hostRes.put("host",serverHost);
            res.add(hostRes);
        }
        return res;
    }

簇类

这个类更简单，只是单纯接受http请求然后调用写好的删除和查看状态的方法就行，避免篇幅过长就不贴那么多代码了。

---

---

Redis

固定流程走一波

pom.xml

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.session</groupId>
            <artifactId>spring-session-data-redis</artifactId>
        </dependency>

application.properties

spring.redis.host= 127.0.0.1
spring.redis.port= 6379
spring.redis.password=

redisTemplate

redis配置

@Autowired(required=false)
private RedisConnectionFactory redisConnectionFactory;

@Bean(name = "redisTemplate")
    public RedisTemplate redisTemplate(){
        RedisTemplate<String, Object> redisTemplate = null;
        if(redisConnectionFactory != null) {
            redisTemplate = new RedisTemplate<>();
            // 配置连接工厂
            redisTemplate.setConnectionFactory(redisConnectionFactory);

            //使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值（默认使用JDK的序列化方式）
            Jackson2JsonRedisSerializer jacksonSeial = new Jackson2JsonRedisSerializer(Object.class);

            ObjectMapper om = new ObjectMapper();
            // 指定要序列化的域，field,get和set,以及修饰符范围，ANY是都有包括private和public
            om.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
            // 指定序列化输入的类型，类必须是非final修饰的，final修饰的类，比如String,Integer等会跑出异常
            om.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
            jacksonSeial.setObjectMapper(om);

            // 值采用json序列化
            redisTemplate.setValueSerializer(jacksonSeial);
            //使用StringRedisSerializer来序列化和反序列化redis的key值
            redisTemplate.setKeySerializer(new StringRedisSerializer());

            // 设置hash key 和value序列化模式
            redisTemplate.setHashKeySerializer(new StringRedisSerializer());
            redisTemplate.setHashValueSerializer(jacksonSeial);
            redisTemplate.afterPropertiesSet();
        }
        return redisTemplate;
    }

使用Redis注解

ps：这里的value也可以算是缓存名，只是跟ehcache不一样不需要提前配置，而这个value最终存入redis时会并入key中，例如：value::key 。这里的双冒号是redis自己加的。然后我现在用的清除api是

@Cacheable(value="default",key="'testDataRedis3'",cacheManager=CacheManagerConfig.REDIS)
    public Object testDataRedis3(){
        return baseMapper.selectById("f0d5c6dd646a7d4602e58c8d55844d54");
    }

删除

value::key

redisTemplate.delete(key);

缓存数

redisTemplate.keys("*").size()

---

---

---

当前功能还是比较简陋，往后可以添加更多的状态以及操作方式，待续~

版权声明：文章为作者原创，版权归作者所有