Wow

English

中文

English

中文

Appearance

Configuration ​

The Wow framework provides comprehensive configuration options through Spring Boot's configuration properties mechanism. This guide covers all available configuration options and how to configure them effectively.

Configuration Structure ​

Wow configuration is organized under the wow prefix in your application.yaml or application.yml file:

yaml
wow:
  enabled: true                    # Enable/disable Wow framework
  context-name: my-service         # Bounded context name
  shutdown-timeout: 60s           # Graceful shutdown timeout

  # Command Bus Configuration
  command:
    bus:
      type: kafka                  # kafka, redis, in_memory, no_op
      local-first:
        enabled: true              # Process local messages first

  # Event Bus Configuration
  event:
    bus:
      type: kafka
      local-first:
        enabled: true

  # State Event Bus Configuration
  eventsourcing:
    state:
      bus:
        type: kafka
        local-first:
          enabled: true
    store:
      storage: mongo               # Event store type: mongo, r2dbc, redis, elasticsearch, in_memory, delay
    snapshot:
      enabled: true
      strategy: all                # all, version_offset
      storage: mongo
      version-offset: 10

  # Infrastructure-specific configurations
  kafka:
    bootstrap-servers:
      - localhost:9092
    topic-prefix: 'wow.'

  mongo:
    enabled: true
    auto-init-schema: true
    event-stream-database: wow_event_db
    snapshot-database: wow_snapshot_db
    prepare-database: wow_prepare_db

  redis:
    enabled: true

  r2dbc:
    enabled: true
    datasource:
      type: simple                 # simple or sharding

  elasticsearch:
    enabled: true

  compensation:
    enabled: true
    webhook:
      weixin:
        url: <webhook-url>
        events:
          - execution_failed_created
          - execution_failed_applied
          - execution_success_applied

  openapi:
    enabled: true

  webflux:
    enabled: true
    global-error:
      enabled: true

Core Configuration ​

WowProperties ​

PropertyTypeDefaultDescription
wow.enabledBooleantrueEnable/disable the Wow framework
wow.context-nameString${spring.application.name}Bounded context name for the service
wow.shutdown-timeoutDuration60sGraceful shutdown timeout duration
yaml
wow:
  enabled: true
  context-name: order-service
  shutdown-timeout: 120s

Command Bus Configuration ​

CommandProperties ​

PropertyTypeDefaultDescription
wow.command.bus.typeBusTypekafkaCommand bus implementation type
wow.command.bus.local-first.enabledBooleantrueEnable LocalFirst mode
yaml
wow:
  command:
    bus:
      type: kafka
      local-first:
        enabled: true

Event Bus Configuration ​

EventProperties ​

PropertyTypeDefaultDescription
wow.event.bus.typeBusTypekafkaEvent bus implementation type
wow.event.bus.local-first.enabledBooleantrueEnable LocalFirst mode
yaml
wow:
  event:
    bus:
      type: kafka
      local-first:
        enabled: true

State Event Bus Configuration ​

StateProperties ​

PropertyTypeDefaultDescription
wow.eventsourcing.state.bus.typeBusTypekafkaState event bus type
wow.eventsourcing.state.bus.local-first.enabledBooleantrueEnable LocalFirst mode
yaml
wow:
  eventsourcing:
    state:
      bus:
        type: kafka
        local-first:
          enabled: true

Event Sourcing Configuration ​

Event Store Configuration ​

PropertyTypeDefaultDescription
wow.eventsourcing.store.storageStorageTypemongoEvent store backend
yaml
wow:
  eventsourcing:
    store:
      storage: mongo    # mongo, r2dbc, redis, elasticsearch, in_memory, delay

Snapshot Configuration ​

PropertyTypeDefaultDescription
wow.eventsourcing.snapshot.enabledBooleantrueEnable snapshot functionality
wow.eventsourcing.snapshot.strategyStrategyallSnapshot strategy
wow.eventsourcing.snapshot.version-offsetInt10Version offset for VERSION_OFFSET strategy
wow.eventsourcing.snapshot.storageStorageTypemongoSnapshot storage backend
yaml
wow:
  eventsourcing:
    snapshot:
      enabled: true
      strategy: version_offset      # all, version_offset
      version-offset: 10
      storage: mongo

Infrastructure Configuration ​

Kafka Configuration ​

PropertyTypeDefaultDescription
wow.kafka.enabledBooleantrueEnable Kafka support
wow.kafka.bootstrap-serversList<String>Kafka broker addresses
wow.kafka.topic-prefixStringwow.Topic name prefix
yaml
wow:
  kafka:
    enabled: true
    bootstrap-servers:
      - kafka-0:9092
      - kafka-1:9092
      - kafka-2:9092
    topic-prefix: 'wow.'

MongoDB Configuration ​

PropertyTypeDefaultDescription
wow.mongo.enabledBooleantrueEnable MongoDB support
wow.mongo.auto-init-schemaBooleantrueAuto-create collections
wow.mongo.event-stream-databaseStringSpring MongoDB databaseEvent stream database
wow.mongo.snapshot-databaseStringSpring MongoDB databaseSnapshot database
wow.mongo.prepare-databaseStringSpring MongoDB databasePrepare key database
yaml
wow:
  mongo:
    enabled: true
    auto-init-schema: true
    event-stream-database: wow_event_db
    snapshot-database: wow_snapshot_db
    prepare-database: wow_prepare_db

Redis Configuration ​

PropertyTypeDefaultDescription
wow.redis.enabledBooleantrueEnable Redis support
yaml
wow:
  redis:
    enabled: true

R2DBC Configuration ​

PropertyTypeDefaultDescription
wow.r2dbc.enabledBooleantrueEnable R2DBC support
wow.r2dbc.datasource.typeTypesimplesimple or sharding
yaml
wow:
  r2dbc:
    enabled: true
    datasource:
      type: simple

Elasticsearch Configuration ​

PropertyTypeDefaultDescription
wow.elasticsearch.enabledBooleantrueEnable Elasticsearch support
yaml
wow:
  elasticsearch:
    enabled: true

Feature Configuration ​

Event Compensation Configuration ​

PropertyTypeDefaultDescription
wow.compensation.enabledBooleantrueEnable event compensation
wow.compensation.webhook.weixin.urlStringWeChat Work webhook URL
wow.compensation.webhook.weixin.eventsList<String>See descriptionNotification events
yaml
wow:
  compensation:
    enabled: true
    webhook:
      weixin:
        url: https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=xxx
        events:
          - execution_failed_created
          - execution_failed_applied
          - execution_success_applied

OpenAPI Configuration ​

PropertyTypeDefaultDescription
wow.openapi.enabledBooleantrueEnable OpenAPI support
yaml
wow:
  openapi:
    enabled: true

WebFlux Configuration ​

PropertyTypeDefaultDescription
wow.webflux.enabledBooleantrueEnable WebFlux support
wow.webflux.global-error.enabledBooleantrueEnable global error handling
yaml
wow:
  webflux:
    enabled: true
    global-error:
      enabled: true

Bus Type ​

The framework supports multiple bus implementations:

TypeDescription
kafkaApache Kafka message bus (recommended for production)
redisRedis Streams message bus
in_memoryIn-memory message bus (for testing)
no_opNo-op message bus (for special cases)

Storage Type ​

For event stores and snapshots:

TypeDescription
mongoMongoDB (recommended for event store)
r2dbcR2DBC-compatible databases
redisRedis for high-performance scenarios
elasticsearchElasticsearch for full-text search

Complete Example ​

yaml
spring:
  application:
    name: order-service

  data:
    mongodb:
      uri: mongodb://localhost:27017/wow_db
    redis:
      host: localhost
      port: 6379

  r2dbc:
    url: r2dbc:pool:mysql://localhost:3306/wow_db

  elasticsearch:
    uris:
      - http://localhost:9200

wow:
  enabled: true
  context-name: order-service
  shutdown-timeout: 120s

  command:
    bus:
      type: kafka
      local-first:
        enabled: true
  event:
    bus:
      type: kafka
      local-first:
        enabled: true
  eventsourcing:
    state:
      bus:
        type: kafka
        local-first:
          enabled: true
    store:
      storage: mongo
    snapshot:
      enabled: true
      strategy: version_offset
      version-offset: 10
      storage: mongo
  kafka:
    bootstrap-servers:
      - localhost:9092
    topic-prefix: 'wow.'
  mongo:
    enabled: true
    auto-init-schema: true
  r2dbc:
    enabled: true
    datasource:
      type: simple
  elasticsearch:
    enabled: true
  compensation:
    enabled: true
  openapi:
    enabled: true
  webflux:
    enabled: true
    global-error:
      enabled: true

management:
  endpoint:
    health:
      show-details: always
      probes:
        enabled: true
  endpoints:
    web:
      exposure:
        include:
          - health
          - wow
          - cosid

springdoc:
  show-actuator: true

Configuration in Different Environments ​

Development ​

yaml
wow:
  command:
    bus:
      type: in_memory
  event:
    bus:
      type: in_memory
  eventsourcing:
    store:
      storage: in_memory
    snapshot:
      storage: in_memory
      strategy: all

Production ​

yaml
wow:
  command:
    bus:
      type: kafka
      local-first:
        enabled: true
  event:
    bus:
      type: kafka
      local-first:
        enabled: true
  eventsourcing:
    store:
      storage: mongo
    snapshot:
      enabled: true
      strategy: version_offset
      version-offset: 10
      storage: mongo
  kafka:
    bootstrap-servers:
      - kafka-0:9092
      - kafka-1:9092
      - kafka-2:9092
  mongo:
    enabled: true
    auto-init-schema: true

Configuration References ​

For detailed configuration of specific modules, see:

Released under the Apache 2.0 License.

Copyright © 2022-present Ahoo Wang