How march1995/cache-event works
Project Type and Purpose
• Cache Event is a modular, Spring Boot–based distributed cache consistency framework.
• It provides annotation-driven cache dependency management, AOP interception of cache eviction, and event-driven cache clearing across nodes (Spring events for single-node, RabbitMQ for multi-node).
A. Client Application (your microservice or monolith)
• Business code invoking methods annotated with @CacheEvict and @CacheDependency
B. cache-event-common
• @CacheDependency annotation
• InetAddressUtil utility
C. cache-event-core
• AOP interceptor (CacheEvictionAspect)
• Event builders (CacheClearEventClientBuilder)
• Event push service (EventCachePushService)
• Event listeners (CacheClearEventListener)
• Dependency registry (InMemoryCacheDependencyRegistry or RedisCacheDependencyRegistry)
• Configuration (BuilderConfig, EventCacheProperties)
D. cache-event-rabbit-mq (optional extension)
• RabbitMQ configuration and builder (RabbitMqBuilderConfig)
• RabbitMQ push service (RabbitmqPushServiceImpl)
• RabbitMQ listener (CacheClearRabbitMqListener)
E. Underlying Infrastructure
• Cache stores: Caffeine or Redis
• Message broker: RabbitMQ
• Optional: Redis used as a dependency graph store
Relationships and Data Flows
1. Business Code → AOP Advice
• Method call triggers CacheEvictionAspect
2. AOP Advice → Dependency Registry
• Reads/writes cache dependency graph (in-memory or Redis) via CacheDependencyRegistry
3. AOP Advice → Event Builder
• Builds a CacheClearEvent that includes target cache keys and dependency info
4. Event Builder → Event Push Service
• Strategy selected by configuration:
• SpringEventPushServiceImpl uses ApplicationEventPublisher
• RabbitmqPushServiceImpl sends to RabbitMQ exchange/queue
5. Event Broker → Event Listener
• For Spring events: local in-VM listener (CacheClearSpringListener)
• For RabbitMQ: distributed listener (CacheClearRabbitMqListener)
6. Event Listener → Local Cache
• Listeners invoke cache eviction on Caffeine/Redis caches, including dependent entries
Architectural Patterns and Principles
• AOP for non-intrusive interception of @CacheEvict methods
• Annotation-driven metadata (@CacheDependency) for dependency graph
• Strategy / pluggable push mechanism (Spring Event vs. RabbitMQ)
• Builder / Factory for constructing event clients and listeners
• Modular design: common + core + extension, enabling future push mechanisms