clintsharp/gogen

Gogen 数据生成器 Docker 镜像文档

镜像概述

Gogen 数据生成器 Docker 镜像是一个轻量级容器化解决方案，提供高效、灵活的数据生成功能。该镜像封装了 Gogen 工具核心能力，帮助用户快速生成各类结构化数据，无需复杂的本地环境配置，适用于软件开发、测试验证、数据分析等多种场景。

核心功能与特性

多类型数据支持

• 覆盖基础数据类型：整数、浮点数、字符串、布尔值、日期时间（支持自定义格式）、***、手机号、UUID、URL 等
• 支持复杂数据结构：嵌套对象、数组、关联数据（如父子关系数据）

自定义生成规则

• 通过参数或配置文件定义数据范围（如数值范围、字符串长度、日期区间）
• 支持格式模板（如固定前缀+随机字符串、自定义日期格式）
• 可配置数据分布规则（如均匀分布、正态分布、指定概率分布）

多输出格式兼容

• 支持主流数据格式：JSON、CSV、SQL（INSERT 语句）、XML、YAML
• 支持批量输出到文件或标准输出流

高效批量生成

• 支持指定生成数据量（单条至百万级）
• 优化的生成引擎，低资源占用下实现高效数据产出

轻量级设计

• 镜像体积小（<50MB），启动速度快
• 无复杂依赖，支持多平台运行（amd64/arm64）

使用场景

软件开发与测试

• 为单元测试、集成测试生成符合业务规则的测试数据，覆盖正常、边界值及异常场景
• 生成 API 接口测试用例数据（请求参数、响应数据）

数据库与数据存储

• 快速填充数据库表样本数据，用于功能演示、培训或性能测试
• 生成符合表结构的 SQL INSERT 语句，简化数据库初始化流程

数据分析与演示

• 生成结构化模拟数据，用于数据分析工具验证、报表演示
• 创建带噪声或特定分布的数据集，支持算法测试与模型训练

使用方法与配置说明

基本使用（Docker Run）

通过 docker run 命令直接生成默认配置数据，输出至标准输出：

bash
docker run --rm docker.xuanyuan.run/gogen-data-generator

默认生成 10 条包含基础字段（id、username、email、register_date、is_active）的 JSON 格式数据。

自定义参数生成

通过命令行参数指定数据类型、数量及输出格式，常用参数说明：

示例 1：生成 50 条 CSV 格式用户数据

bash
docker run --rm -v $(pwd):/data docker.xuanyuan.run/gogen-data-generator \
  --count 50 \
  --output csv \
  --fields "user_id:int(1000-9999),username:string(8),email:email,join_date:date(2023-01-01,2023-12-31)" \
  --output-file /data/users.csv

说明：-v $(pwd):/data 将本地当前目录挂载到容器内 /data 目录，实现数据持久化

示例 2：生成 SQL INSERT 语句（MySQL 格式）

bash
docker run --rm -v $(pwd):/data docker.xuanyuan.run/gogen-data-generator \
  --count 20 \
  --output sql \
  --table "products" \
  --fields "id:int(1-100),name:string(20),price:float(10.0-999.9,2),stock:int(0-500)" \
  --output-file /data/products.sql

配置文件使用（复杂场景）

对于嵌套结构、数组或关联数据等复杂需求，可通过 YAML 配置文件定义生成规则。配置文件支持字段嵌套、数组长度控制、数据关联关系等高级特性。

配置文件示例（config.yaml）

yaml
count: 30  # 生成 30 条数据
output:
  format: json
  file: /data/orders.json
fields:
  order_id:
    type: string
    format: "ORD-{{random_int(1000,9999)}}-{{date('Ymd')}}"  # 格式如 ORD-1234-20231025
  user:
    type: object  # 嵌套对象
    fields:
      user_id: int(1-100)
      username: string(6-12)
  items:
    type: array  # 数组类型
    length: 1-3  # 数组长度 1-3 个元素
    fields:
      product_id: int(100-999)
      quantity: int(1-5)
      price: float(10.0-200.0,2)
  order_date:
    type: date
    start: "2023-01-01"
    end: "2023-12-31"
    format: "YYYY-MM-DD HH:mm:ss"
  status:
    type: enum  # 枚举类型
    values: ["pending", "paid", "shipped", "delivered"]  # 从指定值中随机选择

运行命令（挂载配置文件）

bash
docker run --rm \
  -v $(pwd)/config.yaml:/config/config.yaml \
  -v $(pwd):/data \
  docker.xuanyuan.run/gogen-data-generator --config /config/config.yaml

环境变量配置

支持通过环境变量设置默认参数，简化命令行输入：

示例：通过环境变量指定默认配置

bash
docker run --rm \
  -e GOGEN_COUNT=50 \
  -e GOGEN_OUTPUT=csv \
  -v $(pwd):/data \
  docker.xuanyuan.run/gogen-data-generator \
  --fields "id:int,name:string(10),age:int(18-60)"

注意事项

1. 数据持久化：容器内生成的文件需通过 -v 挂载本地目录（如示例中的 /data），否则容器退出后数据将丢失。
2. 性能优化：生成超 10 万条数据时，建议通过 --memory=2g 限制容器内存，避免资源溢出。
3. 配置优先级：命令行参数 > 配置文件 > 环境变量 > 默认值。
4. 嵌套结构：复杂嵌套对象或数组建议使用配置文件方式定义，支持多层嵌套（最大深度 5 层）。