xmonline/xm-ms-timeline

XM^online 2 时间线微服务镜像文档

1. 镜像概述和主要用途

XM^online 2 时间线微服务镜像是XM^online 2系统中的独立微服务组件，专门用于处理和管理时间线相关的数据及业务功能。该镜像封装了时间线数据的存储、查询、更新、事件触发等核心能力，支持与系统其他微服务协同工作，提供高效、可靠的时间线服务。

2. 核心功能和特性

• 时间线数据管理：支持时间线记录的创建（Create）、读取（Read）、更新（Update）、删除（Delete）等基础操作
• 事件驱动处理：可响应系统内外部事件，自动更新或生成相关时间线数据
• 高可用设计：支持集群部署，具备故障转移能力，保障服务持续可用
• 灵活集成：提供标准API接口，支持与XM^online 2系统其他微服务及外部应用集成
• 可配置存储：支持对接多种数据库（如MySQL、PostgreSQL等），适配不同数据存储需求
• 监控与日志：集成基础监控指标和日志记录功能，便于问题排查和性能优化

3. 使用场景和适用范围

适用场景

• 社交媒体类应用的用户动态时间线展示
• 系统操作日志、活动记录的时间线式查询与展示
• 用户行为轨迹的时间线追踪与分析
• 事件序列的时间线管理（如项目进度、任务流程等）

适用范围

• XM^online 2系统的完整部署环境
• 需要集成时间线功能的第三方应用（通过API对接）
• 开发、测试及生产环境的时间线服务独立部署

4. 使用方法和配置说明

4.1 Docker 运行示例

bash
docker run -d \
  --name xm-online2-timeline-service \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://mysql-host:3306/xm_timeline \
  -e SPRING_DATASOURCE_USERNAME=root \
  -e SPRING_DATASOURCE_PASSWORD=password \
  -e EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://eureka-server:8761/eureka/ \
  docker.xuanyuan.run/xm-online2/timeline-microservice:latest

4.2 Docker Compose 配置示例

yaml
version: '3.8'
services:
  timeline-service:
    image: docker.xuanyuan.run/xm-online2/timeline-microservice:latest
    container_name: xm-online2-timeline-service
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/xm_timeline
      - SPRING_DATASOURCE_USERNAME=root
      - SPRING_DATASOURCE_PASSWORD=password
      - EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://eureka-server:8761/eureka/
      - SERVER_PORT=8080
    depends_on:
      - mysql
      - eureka-server
    restart: unless-stopped

4.3 环境变量配置说明

4.4 服务健康检查

服务启动后，可通过访问 http://<service-host>:<server-port>/actuator/health 检查服务健康状态，返回 {"status":"UP"} 表示服务正常运行。

4.5 API 访问示例

• 获取时间线列表：GET http://<service-host>:<server-port>/api/timelines?userId=123&page=0&size=10
• 创建时间线记录：POST http://<service-host>:<server-port>/api/timelines（请求体包含时间线数据）

5. 注意事项

• 确保数据库服务已提前创建并配置好相应权限
• 生产环境建议通过配置外部配置文件（如挂载 volumes）管理敏感配置
• 集群部署时需确保各实例间的缓存一致性（如使用分布式缓存）
• 根据实际负载调整JVM参数（如通过 -e JAVA_OPTS="-Xms512m -Xmx1g" 设置）