046. 使用 Java 实现一个简单的内存缓存

1. 场景

---

• 在 Java 应用中，对于访问频率高，更新少的数据，通常的方案是将这类数据加入缓存中。相对从数据库中读取来说，读缓存效率会有很大提升。
• 在集群环境下，常用的分布式缓存有 Redis、Memcached 等。但在某些业务场景上，可能不需要去搭建一套复杂的分布式缓存系统，在单机环境下，通常是会希望使用内部的缓存（LocalCache）。

2. 方案

---

• 基于 JSR107 规范自研。
• 基于 ConcurrentHashMap 实现数据缓存。

3. JSR107 规范

---

文档：https://jcp.org/en/jsr/detail?id=107（了解一下就行，没太大的应用）

目标

• 为应用程序提供缓存 Java 对象的功能。
• 定义了一套通用的缓存概念和工具。
• 最小化开发人员使用缓存的学习成本。
• 最大化应用程序在使用不同缓存实现之间的可移植性。
• 支持进程内和分布式的缓存实现。

核心概念

• Java Caching 定义了 5 个核心接口，分别是 CachingProvider、CacheManager、Cache、Entry 和 Expiry。
• CachingProvider 定义了创建、配置、获取、管理和控制多个 CacheManager。一个应用可以在运行期间访问多个 CachingProvider。
• CacheManager 定义了创建、配置、获取、管理和控制多个唯一命名的 Cache，这些 Cache 存在于 CacheManager 的上下文中。一个 CacheManager 仅被一个 CachingProvider 所拥有。
• Cache 是一个类似 Map 的数据结构并临时存储以 key 为索引的值。一个 Cache 仅被一个 CacheManager 所拥有。
• Entry 是一个存储在 Cache 中的 key-value 对。
• 每一个存储在 Cache 中的条目有一个定义的有效期，即 Expiry Duration。一旦超过这个时间，条目为过期的状态。一旦过期，条目将不可访问、更新和删除。缓存有效期可以通过 ExpiryPolicy 设置。

4. 使用 Map 实现一个简单缓存

---

package com.study.cache.java;

import java.lang.ref.SoftReference;
import java.util.Optional;
import java.util.concurrent.ConcurrentHashMap;

/**
 * 使用 Map 实现一个简单的缓存功能
 * @author 华夏紫穹
 */
public class MapCacheDemo {

    // 使用 ConcurrentHashMap，线程安全的要求。
    // 使用 SoftReference<Object> 作为映射值，因为软引用可以保证在抛出 OutOfMemory 之前，如果缺少内存，将删除引用的对象。
    // 在构造函数中，我创建了一个守护程序线程，每 5 秒扫描一次并清理过期的对象。

    private static final int CLEAN_UP_PERIOD_IN_SEC = 5;

    private final ConcurrentHashMap<String, SoftReference<CacheObject>> cache = new ConcurrentHashMap<>();

    public MapCacheDemo() {
        Thread cleanerThread = new Thread(() -> {
            while (! Thread.currentThread().isInterrupted()) {
                try {
                    Thread.sleep(CLEAN_UP_PERIOD_IN_SEC * 1000);
                    cache.entrySet().removeIf(entry -> Optional.ofNullable(entry.getValue()).map(SoftReference::get).map(CacheObject::isExpired).orElse(false));
                } catch (InterruptedException e) {
                    e.printStackTrace();
                }
            }
        });
        cleanerThread.setDaemon(true);
        cleanerThread.start();
    }

    public void add(String key, Object value, long periodInMillis) {
        if (key == null) { return; }
        if (value == null) { cache.remove(key); }
        long expireTime = System.currentTimeMillis() + periodInMillis;
        cache.put(key, new SoftReference<>(new CacheObject(value, expireTime)));
    }

    public void remove(String key) {
        cache.remove(key);
    }

    public Object get(String key) {
        return Optional.ofNullable(cache.get(key)).map(SoftReference::get).filter(cacheObject -> ! cacheObject.isExpired()).map(CacheObject::getValue).orElse(null);
    }

    public void clear() {
        cache.clear();
    }

    public long size() {
        return cache.entrySet().stream().filter(entry -> Optional.ofNullable(entry.getValue()).map(SoftReference::get).map(cacheObject -> ! cacheObject.isExpired()).orElse(false)).count();
    }


    // 缓存对象 value
    private static class CacheObject {
        private Object value;
        private long expiryTime;

        private CacheObject(Object value, long expiryTime) {
            this.value = value;
            this.expiryTime = expiryTime;
        }

        boolean isExpired() {
            return System.currentTimeMillis() > expiryTime;
        }

        public Object getValue() {
            return value;
        }

        public void setValue(Object value) {
            this.value = value;
        }
    }

}

package com.study.cache.java;

/**
 * MapCache 测试类
 * @author 华夏紫穹
 */
public class MapCacheDemoTests {
    public static void main(String[] args) throws InterruptedException {
        MapCacheDemo mapCacheDemo = new MapCacheDemo();
        mapCacheDemo.add("uid_10001", "{1}", 5 * 1000);
        mapCacheDemo.add("uid_10002", "{2}", 5 * 1000);
        mapCacheDemo.add("uid_10003", "{3}", 5 * 1000);
        System.out.println("从缓存中取出值：" + mapCacheDemo.get("uid_10001"));
        Thread.sleep(5000L);
        System.out.println("5 秒钟过后");
        System.out.println("从缓存中取出值：" + mapCacheDemo.get("uid_10001"));
        // 5 秒后数据自动清除了
    }
}