CoCache

中文

English

中文

English

Appearance

测试概览 ​

CoCache 通过 cocache-test 模块提供了全面的技术兼容性测试套件（TCK）。这些抽象测试规范确保任何缓存实现——无论是内置的还是自定义的——在所有标准操作中行为正确。

TCK 测试规范 ​

cocache-test 模块包含定义缓存组件预期行为的抽象基类。新的缓存实现只需继承这些类并提供具体的工厂方法。

mermaid
classDiagram
    direction TB
    class CacheSpec~K, V~ {
        <<Abstract>>
        #createCache() Cache~K, V~
        #createCacheEntry() Pair~K, V~
        +get()
        +getWhenExpired()
        +set()
        +setWithTtl()
        +setWithTtlAmplitude()
        +evict()
        +setMissing()
        +setMissingTtl()
    }
    class ClientSideCacheSpec~V~ {
        <<Abstract>>
        +clear()
    }
    class DistributedCacheSpec~V~ {
        <<Abstract>>
    }
    class DefaultCoherentCacheSpec~K, V~ {
        <<Abstract>>
        +getFromCacheSource()
        +onEvicted()
        +onEvictedWhenLoop()
        +onEvictedWhenCacheNameNotMatch()
        +should prevent cache breakdown under high concurrency()
    }
    class MultipleInstanceSyncSpec~K, V~ {
        <<Abstract>>
        +multipleInstanceSync()
    }
    class CacheEvictedEventBusSpec {
        <<Abstract>>
        +publish()
        +unregister()
    }

    CacheSpec <|-- ClientSideCacheSpec
    CacheSpec <|-- DistributedCacheSpec
    CacheSpec <|-- DefaultCoherentCacheSpec
    MultipleInstanceSyncSpec ..> CacheEvictedEventBusSpec

    style CacheSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style ClientSideCacheSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DistributedCacheSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DefaultCoherentCacheSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style MultipleInstanceSyncSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CacheEvictedEventBusSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

规范参考 ​

CacheSpec ​

所有缓存实现的基础测试规范，测试 Cache<K, V> 的基本契约。

测试方法描述源码
get()验证获取不存在的键返回 nullCacheSpec.kt:36-39
getWhenExpired()验证已过期的条目不会被返回并被清理CacheSpec.kt:41-47
set()验证基本的 set 和 get 往返操作CacheSpec.kt:49-53
setWithTtl()验证设置显式 TTL 且 TTL 被正确存储CacheSpec.kt:55-61
setWithTtlAmplitude()验证设置带 TTL 抖动幅度（jitter）的缓存CacheSpec.kt:63-68
evict()验证驱逐操作会移除条目CacheSpec.kt:70-75
setMissing()验证缺失守卫值被视为不存在CacheSpec.kt:77-81
setMissingTtl()验证带 TTL 的缺失守卫值被视为不存在CacheSpec.kt:83-89

源码参考：cocache-test/.../CacheSpec.kt

ClientSideCacheSpec ​

继承 CacheSpec，增加针对 ClientSideCache<V> 接口（L2 本地缓存）的特有测试。

测试方法描述源码
clear()验证 clear() 移除所有条目并将大小重置为 0ClientSideCacheSpec.kt:24-33
(继承)所有 CacheSpec 测试CacheSpec.kt

源码参考：cocache-test/.../ClientSideCacheSpec.kt

DistributedCacheSpec ​

继承 CacheSpec，使用 String 类型键，针对 DistributedCache<V> 接口（L1 分布式缓存）。继承所有 CacheSpec 测试。

源码参考：cocache-test/.../DistributedCacheSpec.kt

DefaultCoherentCacheSpec ​

测试完整的 DefaultCoherentCache，包含所有三层（L2 + L1 + DataSource）。包括并发和事件驱动一致性测试。

测试方法描述源码
getFromCacheSource()验证缓存未命中时从 CacheSource 加载数据DefaultCoherentCacheSpec.kt:90-96
onEvicted()验证远程驱逐事件清除 L2 但保留 L1DefaultCoherentCacheSpec.kt:98-109
onEvictedWhenLoop()验证自己发布的事件被忽略（无循环）DefaultCoherentCacheSpec.kt:111-122
onEvictedWhenCacheNameNotMatch()验证其他缓存的事件被忽略DefaultCoherentCacheSpec.kt:124-136
should prevent cache breakdown under high concurrency参数化测试（10、100、1000 线程），验证逐键锁定机制防止对 CacheSource 的多次调用DefaultCoherentCacheSpec.kt:138-179

源码参考：cocache-test/.../DefaultCoherentCacheSpec.kt

MultipleInstanceSyncSpec ​

测试两个具有不同客户端 ID 的 CoherentCache 实例通过事件总线正确同步。

测试方法描述源码
multipleInstanceSync()模拟两个实例：在一个上设置值，验证另一个的 L2 通过事件总线被失效；测试 set 和 evict 的传播MultipleInstanceSyncSpec.kt:86-138

源码参考：cocache-test/.../MultipleInstanceSyncSpec.kt

CacheEvictedEventBusSpec ​

测试事件总线的发布/订阅机制。

测试方法描述源码
publish()验证发布事件后，已注册的订阅者能收到事件CacheEvictedEventBusSpec.kt:29-48
unregister()验证取消注册订阅者后，事件不再被投递CacheEvictedEventBusSpec.kt:50-73

源码参考：cocache-test/.../consistency/CacheEvictedEventBusSpec.kt

测试架构 ​

mermaid
graph TB
    subgraph sg_82 ["cocache-test (TCK Specs)"]
        direction TB
        CacheSpec["CacheSpec<br>Base cache operations"]
        CSCSpec["ClientSideCacheSpec<br>L2 local cache"]
        DCSpec["DistributedCacheSpec<br>L1 distributed cache"]
        CoherentSpec["DefaultCoherentCacheSpec<br>Full coherent cache"]
        MISpec["MultipleInstanceSyncSpec<br>Multi-instance sync"]
        EBSpec["CacheEvictedEventBusSpec<br>Event bus"]
    end

    subgraph sg_83 ["cocache-core Tests"]
        direction TB
        MapTest["MapClientSideCacheTest"]
        MockDCTest["MockDistributedCacheTest"]
        CoherentTest["DefaultCoherentCacheTest"]
    end

    subgraph sg_84 ["cocache-spring-redis Tests"]
        direction TB
        RedisDCTest["RedisDistributedCacheTest"]
        RedisEBTest["RedisCacheEvictedEventBusTest"]
        SyncTest["RedisMultipleInstanceSyncTest"]
    end

    CacheSpec --> CSCSpec
    CacheSpec --> DCSpec
    CacheSpec --> CoherentSpec
    CSCSpec --> MapTest
    DCSpec --> MockDCTest
    CoherentSpec --> CoherentTest
    DCSpec --> RedisDCTest
    EBSpec --> RedisEBTest
    MISpec --> SyncTest

    style CacheSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CSCSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style DCSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CoherentSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style MISpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style EBSpec fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style MapTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style MockDCTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style CoherentTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RedisDCTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style RedisEBTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3
    style SyncTest fill:#2d333b,stroke:#6d5dfc,color:#e6edf3

测试工具 ​

工具用途源码
JUnit 5 (Jupiter)测试框架--
mockkKotlin Mock 库--
fluent-assertimport me.ahoo.test.asserts.assert 然后对任意值调用 .assert()--
JUnit @ParameterizedTest并发测试使用 @ValueSource(ints = [10, 100, 1000])--

并发测试详情 ​

DefaultCoherentCacheSpec 包含一个关键的并发测试，验证逐键锁定机制：

mermaid
sequenceDiagram
autonumber
    participant T1 as Thread 1
    participant T2 as Thread 2
    participant TN as Thread N
    participant Lock as KeyLock
    participant L2 as L2 Cache
    participant L1 as L1 Cache
    participant L0 as CacheSource

    par Concurrent requests
        T1->>Lock: synchronized(lock)
        T2->>Lock: synchronized(lock)
        TN->>Lock: synchronized(lock)
    end

    Lock->>L2: check (miss)
    Lock->>L1: check (miss)
    Lock->>L0: loadCacheValue(key)
    Note over L0: Only called ONCE
    L0-->>Lock: CacheValue
    Lock->>L2: setCache(key, value)
    Lock->>L1: setCache(key, value)
    Lock-->>T1: CacheValue
    Lock-->>T2: CacheValue (from L2)
    Lock-->>TN: CacheValue (from L2)

    Note over T1,TN: callCount.assert().isOne()

源码参考：DefaultCoherentCacheSpec.kt:138-179

相关页面 ​

基于 Apache License 2.0 发布。

Copyright 2022-present Ahoo Wang