Inventory Service 镜像文档

1. 镜像概述

Inventory Service 镜像是一个轻量级的库存管理服务容器化解决方案，旨在提供高效、可靠的库存跟踪和管理功能。该镜像封装了完整的库存服务应用程序，包含数据存储、API接口和管理功能，可快速集成到各类商业系统或电商平台中。

2. 核心功能与特性

• 实时库存跟踪：支持商品入库、出库、调拨等操作的实时记录与更新
• 库存预警机制：可配置低库存阈值警报，避免缺货风险
• 多维度库存查询：支持按商品、类别、仓库等多维度查询库存状态
• 事务支持：所有库存操作具备事务特性，确保数据一致性
• RESTful API：提供标准RESTful接口，便于与外部系统集成
• 数据备份：内置定时备份功能，保障数据安全
• 轻量化设计：基于Alpine Linux构建，镜像体积小，资源占用低

3. 使用场景与适用范围

• 电商平台库存管理系统
• 零售门店库存跟踪
• 仓库管理系统(WMS)
• 供应链管理系统
• 生产企业库存控制
• 多渠道销售库存同步

4. 快速开始

基本运行命令

bash
docker run -d \
  --name inventory-service \
  -p 8080:8080 \
  -e SPRING_PROFILES_ACTIVE=prod \
  -e DB_HOST=mysql-host \
  -e DB_NAME=inventory \
  -e DB_USER=root \
  -e DB_PASSWORD=password \
  inventory-service:latest

5. 配置说明

5.1 环境变量

5.2 端口映射

默认情况下，服务监听容器内8080端口，建议映射到主机的8080端口或根据实际需求调整。

6. Docker Compose 部署示例

yaml
version: '3.8'

services:
  inventory-service:
    image: inventory-service:latest
    container_name: inventory-service
    restart: always
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=prod
      - DB_HOST=mysql
      - DB_PORT=3306
      - DB_NAME=inventory
      - DB_USER=invuser
      - DB_PASSWORD=invpassword
      - CACHE_ENABLED=true
      - BACKUP_ENABLED=true
      - BACKUP_CRON=0 0 2 * * ?
    volumes:
      - inventory-data:/app/data
      - ./config:/app/config
    depends_on:
      - mysql
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:8080/actuator/health"]
      interval: 30s
      timeout: 10s
      retries: 3

  mysql:
    image: mysql:8.0
    container_name: inventory-mysql
    restart: always
    environment:
      - MYSQL_ROOT_PASSWORD=rootpassword
      - MYSQL_DATABASE=inventory
      - MYSQL_USER=invuser
      - MYSQL_PASSWORD=invpassword
    volumes:
      - mysql-data:/var/lib/mysql
    ports:
      - "3306:3306"

volumes:
  inventory-data:
  mysql-data:

7. 数据持久化

为确保库存数据不丢失，建议对以下目录进行持久化挂载：

• /app/data：存放备份文件和日志
• /app/config：存放自定义配置文件

持久化运行示例：

bash
docker run -d \
  --name inventory-service \
  -p 8080:8080 \
  -v /host/path/data:/app/data \
  -v /host/path/config:/app/config \
  -e DB_HOST=mysql-host \
  -e DB_NAME=inventory \
  -e DB_USER=root \
  -e DB_PASSWORD=password \
  inventory-service:latest

8. API 接口说明

服务启动后，可通过访问 http://localhost:8080/swagger-ui.html 查看完整API文档，主要接口包括：

• GET /api/inventory - 获取库存列表
• GET /api/inventory/{productId} - 获取指定商品库存
• POST /api/inventory - 创建库存记录
• PUT /api/inventory/{productId} - 更新库存信息
• DELETE /api/inventory/{productId} - 删除库存记录
• POST /api/inventory/stock-in - 商品入库
• POST /api/inventory/stock-out - 商品出库
• GET /api/inventory/alerts - 获取库存预警列表

9. 健康检查

服务内置健康检查接口，可通过以下命令验证服务状态：

bash
curl http://localhost:8080/actuator/health

健康检查响应示例：

json
{
  "status": "UP",
  "components": {
    "db": {
      "status": "UP"
    },
    "diskSpace": {
      "status": "UP"
    }
  }
}

10. 日志管理

服务日志默认输出到标准输出流，可通过Docker日志命令查看：

bash
docker logs -f inventory-service

如需自定义日志配置，可挂载外部日志配置文件到容器内 /app/config/logback.xml 路径。