xmonline/xm-ms-entity

XM^online 2 领域对象微服务

镜像概述

XM^online 2领域对象微服务是XM^online 2系统的核心组件之一，专注于实现领域驱动设计(DDD)中的领域层功能，提供领域对象的定义、管理、操作及相关业务逻辑的处理。该微服务旨在解耦应用中的领域层与其他层，支持企业级应用在领域驱动架构下的高效开发、部署与维护。

核心功能与特性

• 领域对象全生命周期管理：支持领域对象的创建、查询、更新、删除(CRUD)等基础操作，满足领域对象从定义到销毁的全流程需求。
• 业务规则引擎：内置业务规则执行机制，可配置领域对象相关的业务规则，自动执行领域层业务逻辑，确保业务规则的一致性与复用性。
• 领域事件发布：支持领域事件的定义、发布与订阅，实现领域对象状态变更时的事件通知，促进微服务间的松耦合通信。
• 数据验证：提供领域对象数据的合法性验证功能，基于预定义规则或自定义验证逻辑，确保领域对象数据的准确性与完整性。
• 多接口支持：提供RESTful API与gRPC接口，满足不同场景下的服务调用需求，支持同步与异步通信模式。
• 可扩展性设计：采用模块化架构，支持领域对象类型、业务规则、验证逻辑的扩展，适配不同业务场景的定制化需求。

使用场景与适用范围

• 企业级领域驱动设计(DDD)应用：作为DDD架构中的领域层实现，支撑业务复杂的企业应用，如电商平台的订单领域、***系统的账户领域等。
• 微服务架构集成：与其他微服务（如用户服务、权限服务、数据存储服务）协同工作，提供领域对象的专业管理能力。
• 业务规则集中管理：适用于需要集中定义、执行和维护业务规则的场景，确保业务逻辑的统一执行与版本控制。
• 领域对象API服务：为前端应用或其他后端服务提供标准化的领域对象操作接口，简化集成流程。

使用方法与配置说明

环境变量配置

该微服务通过环境变量进行配置，常用环境变量如下：

Docker Run 部署示例

bash
docker run -d \
  --name xm-online2-domain-service \
  -p 8080:8080 \
  -e SERVER_PORT=8080 \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://mysql-host:3306/xm_domain \
  -e SPRING_DATASOURCE_USERNAME=domain_user \
  -e SPRING_DATASOURCE_PASSWORD=secure_password \
  -e LOG_LEVEL=DEBUG \
  -e EVENT_BROKER_URL=kafka://kafka-host:9092 \
  -e REGISTRY_SERVER=http://eureka-host:8761/eureka \
  docker.xuanyuan.run/xm-online2/domain-service:latest

Docker Compose 配置示例

yaml
version: '3.8'
services:
  domain-service:
    image: docker.xuanyuan.run/xm-online2/domain-service:latest
    container_name: xm-online2-domain-service
    ports:
      - "8080:8080"
    environment:
      - SERVER_PORT=8080
      - SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/xm_domain
      - SPRING_DATASOURCE_USERNAME=domain_user
      - SPRING_DATASOURCE_PASSWORD=secure_password
      - LOG_LEVEL=INFO
      - EVENT_BROKER_URL=kafka://kafka:9092
      - REGISTRY_SERVER=http://eureka:8761/eureka
    depends_on:
      - mysql
      - kafka
      - eureka
    networks:
      - xm-online2-network

networks:
  xm-online2-network:
    driver: bridge

API调用示例（RESTful API）

获取领域对象列表

bash
curl -X GET "http://localhost:8080/api/v1/domain/objects?type=order" \
  -H "Authorization: Bearer {token}"

创建领域对象

bash
curl -X POST "http://localhost:8080/api/v1/domain/objects" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {token}" \
  -d '{
    "type": "order",
    "attributes": {
      "orderNo": "ORD20240501001",
      "amount": 999.99,
      "status": "CREATED"
    }
  }'

扩展与定制

通过挂载配置文件或自定义模块实现扩展：

• 业务规则扩展：将自定义业务规则配置文件挂载至 /app/config/rules 目录
• 领域对象类型扩展：通过 -v /path/to/domain-types:/app/domain-types 挂载自定义领域对象类型定义文件