localnerve/jam-build-propsdb

jam-build-propsdb - Go Fiber数据服务镜像

镜像概述

jam-build-propsdb是一个基于Go和Fiber框架构建的高性能数据服务镜像，旨在替代Jam Build项目中的Node.js Express数据服务。它支持所有GORM兼容数据库（MariaDB/MySQL、PostgreSQL、SQLite、SQL Server），提供认证集成、API兼容等功能，适用于轻量级数据API场景。

核心功能

• 🚀 高性能：基于Go Fiber框架实现高吞吐量
• 🗄️ 多数据库支持：通过DB_TYPE配置支持MariaDB、MySQL、PostgreSQL、SQLite和SQL Server
• 🔐 认证集成：使用authorizer-go SDK与Authorizer服务集成
• 📦 API兼容性：无缝替代Node.js Express服务的API接口
• 🔄 版本控制：通过E_VERSION冲突检测实现乐观锁
• 🐳 Docker就绪：多阶段Dockerfile支持容器化部署
• 🧪 可测试性：支持单元、集成及端到端测试（基于testcontainers）

使用场景

1. Jam Build项目的后端数据服务替代方案
2. 需要多数据库支持的轻量级数据API服务
3. 追求高性能数据处理的应用场景
4. 需要认证和版本控制的企业级数据服务

配置说明

环境变量配置

核心环境变量：

• PORT：服务暴露端口（默认3000）
• DB_TYPE：数据库类型（可选：mariadb/mysql/postgres/sqlite/sqlserver）
• DB_HOST：数据库主机地址
• DB_PORT：数据库端口
• DB_APP_DATABASE：应用数据库名称（SQLite需指定文件路径）
• DB_APP_USER/DB_APP_PASSWORD：应用数据库账号密码
• AUTHZ_URL：Authorizer服务地址
• AUTHZ_CLIENT_ID：Authorizer客户端ID

数据库初始化与迁移

• 初始化脚本：data/initdb/目录下对应数据库类型的SQL文件
• 迁移脚本：data/migrations/目录下对应数据库类型的SQL文件
• 支持GORM AutoMigrate作为 fallback

Docker部署示例

单容器运行

bash
docker run -d -p 3000:3000 \
  -e PORT=3000 \
  -e DB_TYPE=mariadb \
  -e DB_HOST=your-db-host \
  -e DB_PORT=3306 \
  -e DB_APP_DATABASE=propsdb \
  -e DB_APP_USER=appuser \
  -e DB_APP_PASSWORD=your-app-pass \
  -e AUTHZ_URL=http://your-authorizer-url \
  -e AUTHZ_CLIENT_ID=your-client-id \
  docker.xuanyuan.run/localnerve/jam-build-propsdb:latest

Docker Compose堆栈部署

yaml
version: '3.8'
services:
  api:
    image: docker.xuanyuan.run/localnerve/jam-build-propsdb:latest
    ports:
      - "3000:3000"
    environment:
      PORT: 3000
      DB_TYPE: mariadb
      DB_HOST: db
      DB_PORT: 3306
      DB_APP_DATABASE: propsdb
      DB_APP_USER: appuser
      DB_APP_PASSWORD: apppass
      DB_USER: user
      DB_PASSWORD: userpass
      AUTHZ_URL: http://authorizer:8080
      AUTHZ_CLIENT_ID: your-client-id
    depends_on:
      - db
      - authorizer

  db:
    image: docker.xuanyuan.run/mariadb:10.11
    environment:
      MYSQL_ROOT_PASSWORD: rootpass
      MYSQL_DATABASE: propsdb
      MYSQL_USER: appuser
      MYSQL_PASSWORD: apppass
    volumes:
      - db-data:/var/lib/mysql

  authorizer:
    image: docker.xuanyuan.run/authorizer/authorizer:latest
    ports:
      - "8080:8080"
    environment:
      AUTHORIZER_CLIENT_ID: your-client-id
      AUTHORIZER_DATABASE_URL: postgres://user:pass@postgres:5432/authorizer
    depends_on:
      - postgres

  postgres:
    image: docker.xuanyuan.run/postgres:15
    environment:
      POSTGRES_USER: user
      POSTGRES_PASSWORD: pass
      POSTGRES_DB: authorizer
    volumes:
      - authorizer-db:/var/lib/postgresql/data

volumes:
  db-data:
  authorizer-db:

API端点

• 公共GET接口（无需认证）：获取应用数据
• 管理POST/DELETE接口（需admin角色）：更新/删除应用数据
• 用户接口（需user角色）：获取/更新用户数据
• Swagger文档：http://localhost:3000/swagger/

认证与版本控制

• 认证：集成Authorizer服务，admin角色访问管理接口，user角色访问用户接口
• 版本控制：通过乐观锁实现冲突检测，客户端需携带当前版本号， mismatch返回409错误

许可协议

该项目采用GNU Affero General Public License v3.0或更高版本授权。 ===END===