Spring Integration API

CoCache provides deep integration with the Spring Framework through the cocache-spring, cocache-spring-cache, and cocache-spring-boot-starter modules. This page documents all Spring-specific components.

Module Overview

mermaid

graph TB
    subgraph Starter["cocache-spring-boot-starter"]
        style Starter fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        Auto["CoCacheAutoConfiguration"]
        Props["CoCacheProperties"]
        Cond["@ConditionalOnCoCacheEnabled"]
        EP["CoCacheEndpoint"]
        CEP["CoCacheClientEndpoint"]
        EPAC["CoCacheEndpointAutoConfiguration"]
    end

    subgraph SpringCache["cocache-spring-cache"]
        style SpringCache fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        CCM["CoCacheManager"]
        CSC["CoSpringCache"]
        SVW["SpringCacheValueWrapper"]
    end

    subgraph Spring["cocache-spring"]
        style Spring fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        EC["EnableCoCache"]
        REG["EnableCoCacheRegistrar"]
        SCF["SpringCacheFactory"]
        ACF["AbstractCacheFactory"]
        CPFB["CacheProxyFactoryBean"]
        JCPFB["JoinCacheProxyFactoryBean"]
        SCSC["SpringClientSideCacheFactory"]
        SKCF["SpringKeyConverterFactory"]
        SCSrcF["SpringCacheSourceFactory"]
        SJKEF["SpringJoinKeyExtractorFactory"]
    end

    subgraph Core["cocache-core"]
        style Core fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        CPF["DefaultCacheProxyFactory"]
        CCF["DefaultCoherentCacheFactory"]
    end

    Auto --> SCF
    Auto --> CPF
    Auto --> CCF
    Auto --> CCM
    REG --> CPFB
    REG --> JCPFB
    CPFB --> CPF
    JCPFB --> JCPF["JoinCacheProxyFactory"]
    CCM --> CSC
    SCF --> ACF
    SCSC --> ACF
    SKCF --> ACF
    SCSrcF --> ACF

Factory Beans

CacheProxyFactoryBean

Spring FactoryBean that creates proxy-based cache instances for @CoCache-annotated interfaces.

Aspect	Detail	Source
Implements	`FactoryBean<Cache<Any, Any>>`, `ApplicationContextAware`	--
Constructor	`(cacheMetadata: CoCacheMetadata)`	--
Source File	--	CacheProxyFactoryBean.kt:23

Method	Returns	Description
`getObject()`	`Cache<Any, Any>`	Retrieves `CacheProxyFactory` from the application context and calls `create(cacheMetadata)`
`getObjectType()`	`Class<*>`	Returns the cache interface class (`cacheMetadata.proxyInterface.java`)

JoinCacheProxyFactoryBean

Spring FactoryBean that creates proxy-based join cache instances for @JoinCacheable-annotated interfaces.

Aspect	Detail	Source
Implements	`FactoryBean<JoinCache<Any, Any, Any, Any>>`, `ApplicationContextAware`	--
Constructor	`(cacheMetadata: JoinCacheMetadata)`	--
Source File	--	JoinCacheProxyFactoryBean.kt:23

Method	Returns	Description
`getObject()`	`JoinCache<Any, Any, Any, Any>`	Retrieves `JoinCacheProxyFactory` from the application context and calls `create(cacheMetadata)`
`getObjectType()`	`Class<*>`	Returns the join cache interface class

AbstractCacheFactory Pattern

The AbstractCacheFactory provides a template method pattern for creating cache components from Spring beans, with a named-bean-first lookup strategy and type-based fallback.

Aspect	Detail	Source
Package	`me.ahoo.cache.spring`	--
Source File	--	AbstractCacheFactory.kt:21

Bean Resolution Strategy

mermaid

flowchart TB
    subgraph Strategy["Bean Resolution Strategy"]
        style Strategy fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        Start["createBean(cacheMetadata)"]
        NameLookup["Look up by name:<br>{cacheName}{suffix}"]
        NameFound{"Bean found?"}
        TypeLookup["Look up by type:<br>BeanFactory.getBeanProvider(type)"]
        TypeFound{"Bean found?"}
        Fallback["Use default fallback"]
        TTL["Set TTL if TtlConfigurationAware"]
        Return["Return bean"]

        Start --> NameLookup
        NameLookup --> NameFound
        NameFound -- "yes" --> TTL
        NameFound -- "no" --> TypeLookup
        TypeLookup --> TypeFound
        TypeFound -- "yes" --> TTL
        TypeFound -- "no" --> Fallback
        Fallback --> TTL
        TTL --> Return
    end

Abstract Methods

Method	Signature	Description
`suffix`	`abstract val suffix: String`	Bean name suffix for this factory type
`getBeanType`	`abstract fun getBeanType(cacheMetadata: CoCacheMetadata): ResolvableType`	Returns the generic `ResolvableType` for bean lookup
`fallback`	`abstract fun fallback(cacheMetadata: CoCacheMetadata): Any`	Default component when no Spring bean is found
`getBeanProvider`	`open fun getBeanProvider(...)`	Type-based bean lookup with fallback provider

Spring Factory Implementations

All Spring factory implementations extend AbstractCacheFactory and follow the same named-bean-first resolution pattern.

SpringClientSideCacheFactory

Aspect	Detail	Source
Implements	`ClientSideCacheFactory`, `AbstractCacheFactory`	--
Bean Name Suffix	`.ClientSideCache`	--
Fallback	`DefaultClientSideCacheFactory.create()` (uses `@GuavaCache`/`@CaffeineCache` annotations)	--
Source File	--	SpringClientSideCacheFactory.kt:25

SpringKeyConverterFactory

Aspect	Detail	Source
Implements	`KeyConverterFactory`, `AbstractCacheFactory`	--
Bean Name Suffix	`.KeyConverter`	--
Fallback	`ExpKeyConverter` if `keyExpression` is set, otherwise `ToStringKeyConverter` with computed prefix	--
Source File	--	SpringKeyConverterFactory.kt:27

Special behavior: skips bean lookup when keyType is String (no conversion needed).

SpringCacheSourceFactory

Aspect	Detail	Source
Implements	`CacheSourceFactory`, `AbstractCacheFactory`	--
Bean Name Suffix	`.CacheSource`	--
Fallback	`CacheSource.noOp()`	--
Source File	--	SpringCacheSourceFactory.kt:24

SpringJoinKeyExtractorFactory

Aspect	Detail	Source
Implements	`JoinKeyExtractorFactory`	--
Bean Name Suffix	`.JoinKeyExtractor`	--
Fallback	Uses `joinKeyExpression` SpEL if set, otherwise type-based bean lookup	--
Source File	--	SpringJoinKeyExtractorFactory.kt:24

SpringCacheFactory

The CacheFactory implementation that retrieves cache beans from the Spring BeanFactory.

Aspect	Detail	Source
Implements	`CacheFactory`	--
Constructor	`(beanFactory: ListableBeanFactory)`	--
Source File	--	SpringCacheFactory.kt:24

Method	Description
`caches`	Returns all `Cache` beans from the application context via `getBeansOfType(Cache::class.java)`
`getCache(cacheName, cacheType)`	Retrieves a cache bean by name and type
`getCache(keyType, valueType)`	Retrieves a cache bean by generic key/value types using `ResolvableType`

Bean Naming Conventions

CoCache uses a consistent {cacheName}.{Suffix} naming pattern for optional customization beans. Register a Spring bean with the matching name to override the default.

Bean Name Pattern	Factory	Purpose	Default Behavior
`{cacheName}.ClientSideCache`	`SpringClientSideCacheFactory`	L2 local cache	`DefaultClientSideCacheFactory.create()`
`{cacheName}.DistributedCache`	`RedisDistributedCacheFactory`	L1 distributed cache	Redis-backed `RedisDistributedCache`
`{cacheName}.CacheSource`	`SpringCacheSourceFactory`	L0 data source	`CacheSource.noOp()`
`{cacheName}.KeyConverter`	`SpringKeyConverterFactory`	Key conversion	`ToStringKeyConverter` or `ExpKeyConverter`
`{cacheName}.JoinKeyExtractor`	`SpringJoinKeyExtractorFactory`	Join key extraction	SpEL expression or type-based bean
`{cacheName}.CacheMetadata`	`EnableCoCacheRegistrar`	Parsed annotation metadata	Auto-generated

Customization Example

To provide a custom ClientSideCache for a specific cache:

kotlin

@Configuration
class CustomCacheConfig {

    @Bean("user-cache.ClientSideCache")
    fun userClientSideCache(): ClientSideCache<User> {
        return CaffeineClientSideCache(
            Caffeine.newBuilder()
                .maximumSize(20_000)
                .expireAfterWrite(Duration.ofMinutes(10))
                .build()
        )
    }

    @Bean("user-cache.CacheSource")
    fun userCacheSource(userRepository: UserRepository): CacheSource<String, User> {
        return object : CacheSource<String, User> {
            override fun loadCacheValue(key: String): CacheValue<User>? {
                return userRepository.findById(key).map {
                    DefaultCacheValue.ttlAt(it, 3600)
                }.orElse(null)
            }
        }
    }
}

CoCacheManager

Bridge between CoCache and Spring's CacheManager abstraction, enabling @Cacheable and other Spring Cache annotations.

Aspect	Detail	Source
Extends	`AbstractCacheManager`	--
Constructor	`(cacheFactory: CacheFactory)`	--
Source File	--	CoCacheManager.kt:21

Method	Returns	Description
`loadCaches()`	`Collection<SpringCache>`	Wraps all registered CoCache instances as `CoSpringCache` adapters
`getMissingCache(name)`	`SpringCache?`	Looks up a CoCache by name and wraps it if found; returns `null` otherwise

CoCacheManager Flow

mermaid

sequenceDiagram
autonumber
    participant SC as Spring Container
    participant CCM as CoCacheManager
    participant CF as CacheFactory
    participant CSW as CoSpringCache

    SC->>CCM: getCache("user-cache")
    CCM->>CCM: Check internal cache map
    alt Cache not found internally
        CCM->>CF: getCache("user-cache")
        CF-->>CCM: Cache instance
        CCM->>CSW: new CoSpringCache("user-cache", cache)
        CCM->>CCM: Register in internal map
    end
    CCM-->>SC: CoSpringCache wrapper

CoSpringCache

Adapter that wraps a CoCache Cache instance as a Spring Cache implementation.

Aspect	Detail	Source
Implements	`NamedCache`, `SpringCache`, `CacheDelegated<Cache<Any, Any?>>`	--
Constructor	`(cacheName: String, delegate: Cache<Any, Any?>)`	--
Source File	--	CoSpringCache.kt:27

Method	Spring Interface	Description
`getName()`	`Cache.getName()`	Returns the cache name
`getNativeCache()`	`Cache.getNativeCache()`	Returns the underlying CoCache instance
`get(key)`	`Cache.get(key)`	Returns a `SpringCacheValueWrapper` around the CoCache value
`get(key, type)`	`Cache.get(key, type)`	Returns the value cast to the specified type
`get(key, valueLoader)`	`Cache.get(key, valueLoader)`	Loads value via `Callable` if not cached, then stores it
`put(key, value)`	`Cache.put(key, value)`	Delegates to `delegate.set(key, value)`
`evict(key)`	`Cache.evict(key)`	Delegates to `delegate.evict(key)`
`clear()`	`Cache.clear()`	Clears the `ClientSideCache` (if `CoherentCache`, clears L2 only)
`retrieve(key)`	`Cache.retrieve(key)`	Async get via `CompletableFuture.supplyAsync`
`retrieve(key, valueLoader)`	`Cache.retrieve(key, valueLoader)`	Async get with `CompletableFuture` composition

Using with @Cacheable

Once CoCacheManager is registered, standard Spring Cache annotations work seamlessly:

kotlin

@Service
class UserService(
    private val userRepository: UserRepository
) {
    @Cacheable(cacheNames = ["user-cache"], key = "#userId")
    fun getUser(userId: String): User {
        return userRepository.findById(userId).orElseThrow()
    }

    @CacheEvict(cacheNames = ["user-cache"], key = "#userId")
    fun deleteUser(userId: String) {
        userRepository.deleteById(userId)
    }
}

EnableCoCacheRegistrar

The registrar that processes @EnableCoCache and registers CacheProxyFactoryBean / JoinCacheProxyFactoryBean definitions.

Aspect	Detail	Source
Implements	`ImportBeanDefinitionRegistrar`	--
Source File	--	EnableCoCacheRegistrar.kt:31

Registration Logic

Step	Action
1	Resolve cache types from `@EnableCoCache.caches` attribute
2	Split into standard caches (not extending `JoinCache`) and join caches
3	For standard caches: parse `CoCacheMetadata`, register metadata bean + `CacheProxyFactoryBean` (marked as primary)
4	For join caches: parse `JoinCacheMetadata`, register `JoinCacheProxyFactoryBean` (marked as primary)

CoCacheAutoConfiguration

Spring Boot auto-configuration class that wires up all CoCache components.

Aspect	Detail	Source
Condition	`@ConditionalOnCoCacheEnabled`, `@AutoConfiguration(after = [DataRedisAutoConfiguration::class])`	--
Source File	--	CoCacheAutoConfiguration.kt:66

Registered Beans

Bean Name	Type	Condition	Description
`defaultHostClientIdGenerator`	`ClientIdGenerator`	No `ClientIdGenerator` or `HostAddressSupplier` bean exists	Uses host address as client ID
`cacheFactory`	`CacheFactory`	No existing bean	`SpringCacheFactory` backed by `ListableBeanFactory`
`coCacheManager`	`CoCacheManager`	Always	Spring Cache bridge
`cocacheRedisMessageListenerContainer`	`RedisMessageListenerContainer`	`RedisConnectionFactory` available	Redis pub/sub listener for eviction events
`cacheEvictedEventBus`	`CacheEvictedEventBus`	No existing bean	`RedisCacheEvictedEventBus`
`coherentCacheFactory`	`CoherentCacheFactory`	No existing bean	`DefaultCoherentCacheFactory`
`cacheSourceFactory`	`CacheSourceFactory`	No existing bean	`SpringCacheSourceFactory`
`clientSideCacheFactory`	`ClientSideCacheFactory`	No existing bean	`SpringClientSideCacheFactory`
`distributedCacheFactory`	`DistributedCacheFactory`	No existing bean	`RedisDistributedCacheFactory`
`keyConverterFactory`	`KeyConverterFactory`	No existing bean	`SpringKeyConverterFactory`
`cacheProxyFactory`	`CacheProxyFactory`	No existing bean	`DefaultCacheProxyFactory`
`joinKeyExtractorFactory`	`JoinKeyExtractorFactory`	No existing bean	`SpringJoinKeyExtractorFactory`
`joinCacheProxyFactory`	`JoinCacheProxyFactory`	No existing bean	`DefaultJoinCacheProxyFactory`

Auto-Configuration Dependency Graph

mermaid

graph TB
    subgraph Redis["Redis Auto-Configuration"]
        style Redis fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        DRA["DataRedisAutoConfiguration"]
        RT["StringRedisTemplate"]
        RCF["RedisConnectionFactory"]
    end

    subgraph CoCache["CoCacheAutoConfiguration"]
        style CoCache fill:#161b22,stroke:#6d5dfc,color:#e6edf3
        CCG["ClientIdGenerator"]
        CEV["CacheEvictedEventBus"]
        CCF["CoherentCacheFactory"]
        CPF["CacheProxyFactory"]
        CSrcF["CacheSourceFactory"]
        CSF["ClientSideCacheFactory"]
        DCF["DistributedCacheFactory"]
        KCF["KeyConverterFactory"]
        SCF["CacheFactory"]
        CCM["CoCacheManager"]
        JKEF["JoinKeyExtractorFactory"]
        JCPF["JoinCacheProxyFactory"]
    end

    RCF --> CEV
    RT --> CEV
    DRA --> CoCache
    CCG --> CPF
    CCF --> CPF
    CSrcF --> CPF
    CSF --> CPF
    DCF --> CPF
    KCF --> CPF
    SCF --> CCM

API Overview -- Architecture overview and module organization
Core Interfaces -- Detailed reference for all core interfaces
Annotations -- Complete annotation reference
Actuator Endpoints -- Monitoring and management endpoints

Spring Integration API ​

Module Overview ​

Factory Beans ​

CacheProxyFactoryBean ​

JoinCacheProxyFactoryBean ​

AbstractCacheFactory Pattern ​

Bean Resolution Strategy ​

Abstract Methods ​

Spring Factory Implementations ​

SpringClientSideCacheFactory ​

SpringKeyConverterFactory ​

SpringCacheSourceFactory ​

SpringJoinKeyExtractorFactory ​

SpringCacheFactory ​

Bean Naming Conventions ​

Customization Example ​

CoCacheManager ​

CoCacheManager Flow ​

CoSpringCache ​

Using with @Cacheable ​

EnableCoCacheRegistrar ​

Registration Logic ​

CoCacheAutoConfiguration ​

Registered Beans ​

Auto-Configuration Dependency Graph ​

Related Pages ​

Spring Integration API

Module Overview

Factory Beans

CacheProxyFactoryBean

JoinCacheProxyFactoryBean

AbstractCacheFactory Pattern

Bean Resolution Strategy

Abstract Methods

Spring Factory Implementations

SpringClientSideCacheFactory

SpringKeyConverterFactory

SpringCacheSourceFactory

SpringJoinKeyExtractorFactory

SpringCacheFactory

Bean Naming Conventions

Customization Example

CoCacheManager

CoCacheManager Flow

CoSpringCache

Using with @Cacheable

EnableCoCacheRegistrar

Registration Logic

CoCacheAutoConfiguration

Registered Beans

Auto-Configuration Dependency Graph

Related Pages