Java內存緩存-通過Map定製簡單緩存

緩存

在程序中，緩存是一個高速數據存儲層，其中存儲了數據子集，且通常是短暫性存儲，這樣日後再次請求此數據時，速度要比訪問數據的主存儲位置快。通過緩存，可以高效地重用之前檢索或計算的數據。

爲什麼要用緩存

場景

在Java應用中，對於訪問頻率高，更新少的數據，通常的方案是將這類數據加入緩存中，相對從數據庫中讀取，讀緩存效率會有很大提升。

在集羣環境下，常用的分佈式緩存有Redis、Memcached等。但在某些業務場景上，可能不需要去搭建一套複雜的分佈式緩存系統，在單機環境下，通常是會希望使用內部的緩存(LocalCache)。

方案

• 基於JSR107規範自研
• 基於ConcurrentHashMap實現數據緩存

JSR107規範目標

• 爲應用程序提供緩存Java對象的功能。
• 定義了一套通用的緩存概念和工具。
• 最小化開發人員使用緩存的學習成本。
• 最大化應用程序在使用不同緩存實現之間的可移植性。
• 支持進程內和分佈式的緩存實現。

JSR107規範核心概念

• 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設置。

小例子

使用Map來實現一個簡單的緩存功能

MapCacheDemo.java

package me.xueyao.cache.java;

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

/**
 * @author simon
 * 用map實現一個簡單的緩存功能
 */
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) {
                    Thread.currentThread().interrupt();
                }
            }
        });
        cleanerThread.setDaemon(true);
        cleanerThread.start();
    }

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

    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;
        }
    }
}

代碼測試類MapCacheDemoTests.java

package me.xueyao.cache.java;

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秒後數據自動清除了~
    }
}