xmonline/xm-ms-config

XM^online 2 配置微服务镜像

1. 镜像概述和主要用途

XM^online 2配置微服务镜像是XM^online 2分布式架构中的核心组件，专注于提供集中化的配置管理能力。该服务替代传统的本地配置文件方式，实现分布式系统中所有服务配置的统一存储、动态更新和按需分发，减少配置变更导致的服务重启操作，提升系统整体的可维护性和灵活性。

2. 核心功能和特性

2.1 集中化配置管理

• 统一存储分布式系统中所有微服务的配置参数，支持JSON、YAML等多种配置格式
• 提供配置项的分类管理，支持按服务、模块或环境维度组织配置

2.2 动态配置更新

• 配置变更后实时推送到关联服务，无需重启服务即可生效
• 支持配置更新通知机制，确保服务端与客户端配置一致性

2.3 多环境与多版本支持

• 内置多环境隔离能力，可区分开发、测试、生产等环境的配置
• 支持配置版本控制，记录配置变更历史，支持版本回滚操作

2.4 高可用与安全性

• 支持集群部署，避免单点故障，保障配置服务持续可用
• 提供基于角色的访问控制（RBAC），限制配置操作权限，防止未授权修改

3. 使用场景和适用范围

3.1 典型使用场景

• 分布式微服务架构：在XM^online 2微服务集群中统一管理各服务的配置参数
• 动态参数调整：需要实时修改运行时参数的场景（如限流阈值、缓存策略、日志级别等）
• 多环境部署：同一套服务代码在开发、测试、生产环境中使用不同配置的场景
• 大规模集群配置：简化成百上千个服务实例的配置维护工作

3.2 适用范围

• 基于XM^online 2框架构建的分布式系统
• 需要集中化配置管理的Java微服务应用
• 对配置变更实时性要求较高的业务系统

4. 使用方法和配置说明

4.1 Docker快速启动

通过以下命令可快速启动配置微服务容器：

bash
docker run -d \
  --name xm-online2-config \
  -p 8888:8888 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e SPRING_DATASOURCE_URL=jdbc:mysql://mysql-host:3306/config_db \
  -e SPRING_DATASOURCE_USERNAME=config_user \
  -e SPRING_DATASOURCE_PASSWORD=config_pass \
  docker.xuanyuan.run/xm-online2/config-service:latest

4.2 Docker Compose配置示例

创建docker-compose.yml文件，实现配置服务与依赖组件的一键部署：

yaml
version: '3.8'
services:
  config-service:
    image: docker.xuanyuan.run/xm-online2/config-service:latest
    container_name: xm-online2-config
    restart: always
    ports:
      - "8888:8888"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - SERVER_PORT=8888
      - SPRING_DATASOURCE_URL=jdbc:mysql://mysql:3306/config_db?useSSL=false&serverTimezone=UTC
      - SPRING_DATASOURCE_USERNAME=config_user
      - SPRING_DATASOURCE_PASSWORD=config_pass
      - CONFIG_REFRESH_INTERVAL=30
      - LOG_LEVEL=INFO
    depends_on:
      - mysql

  mysql:
    image: docker.xuanyuan.run/mysql:8.0
    container_name: xm-config-mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=root@123
      - MYSQL_DATABASE=config_db
      - MYSQL_USER=config_user
      - MYSQL_PASSWORD=config_pass
    volumes:
      - mysql-data:/var/lib/mysql
    ports:
      - "3306:3306"

volumes:
  mysql-data:

4.3 环境变量配置

4.4 核心配置参数

配置微服务的核心配置通过application.yml（或按环境区分的application-{profile}.yml）定义，关键配置项包括：

yaml
# 配置存储方式（数据库示例）
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://mysql:3306/config_db
    username: config_user
    password: config_pass
  # 配置缓存策略
  cache:
    type: redis
    redis:
      host: redis-host
      port: 6379

# 配置服务端设置
config:
  server:
    # 允许覆盖本地配置
    override-none: true
    # 接受客户端覆盖配置请求
    allow-override: true
    # 优先使用服务端配置
    override-system-properties: false

# 监控端点配置
management:
  endpoints:
    web:
      exposure:
        include: health,info,refresh,bus-refresh
  endpoint:
    health:
      show-details: always

4.5 集群部署指南

为保障高可用，建议采用集群部署方式：

1. 多实例部署：部署2个及以上配置服务实例，通过负载均衡器（如Nginx）分发请求
2. 共享存储：所有实例连接同一数据库或共享配置仓库（如Git），确保配置数据一致性
3. 健康检查：启用健康检查端点（/actuator/health），配合容器编排平台（如Kubernetes）实现实例自愈

Nginx负载均衡配置示例：

nginx
upstream config-service {
  server config-instance1:8888;
  server config-instance2:8888;
}

server {
  listen 80;
  server_name config.xm-online2.com;
  
  location / {
    proxy_pass http://config-service;
    proxy_set_header Host $host;
    proxy_set_header X-Real-IP $remote_addr;
  }
}

5. 注意事项

• 配置服务启动前需确保后端存储（数据库/Git仓库）已就绪
• 生产环境中建议启用SSL/TLS加密传输配置数据
• 敏感配置（如数据库密码）建议使用加密存储（可集成配置服务的加密功能）
• 定期备份配置数据，避免数据丢失导致服务不可用