folioorg/mod-orders-storage

FOLIO - mod-orders-storage 镜像文档

1. 镜像概述和主要用途

1.1 概述

mod-orders-storage 是 FOLIO（图书馆服务平台）生态中的订单存储模块，负责订单数据的持久化管理。该模块基于 CRUD（创建、读取、更新、删除）模式设计，为 FOLIO 系统提供订单数据的基础存储能力。

1.2 主要用途

作为 FOLIO 订单管理功能的核心组件，用于：

• 订单数据的持久化存储与管理；
• 支持订单信息的全生命周期操作（创建、查询、更新、删除）；
• 为 FOLIO 其他模块提供订单数据访问接口。

代码仓库：https://github.com/folio-org/mod-orders-storage

2. 核心功能和特性

2.1 核心功能

• 订单数据 CRUD 操作：支持订单信息的创建（Create）、读取（Read）、更新（Update）、删除（Delete）。
• 数据持久化：通过数据库集成实现订单数据的可靠存储。

2.2 主要特性

• 数据库依赖：需配置外部数据库（如 PostgreSQL）以实现数据存储；
• Kafka 集成：支持与 Kafka 消息系统对接（通过配置 Kafka 服务地址与端口）；
• 资源可控：支持通过环境变量配置 JVM 参数及容器内存限制，优化资源占用。

3. 使用场景和适用范围

3.1 使用场景

• 部署 FOLIO 图书馆服务平台时，作为订单管理模块的后端存储服务；
• 需对 FOLIO 系统中的订单数据进行持久化管理及基础操作的场景。

3.2 适用范围

• FOLIO 平台部署环境（如图书馆、学术机构等使用 FOLIO 进行资源管理的组织）；
• 需集成订单存储功能的 FOLIO 生态系统组件。

4. 使用方法和配置说明

4.1 基础要求

• 外部数据库（如 PostgreSQL），需提前创建数据库及用户；
• Kafka 服务（如需消息队列集成）；
• Docker 环境（1.13+）或 Docker Compose（2.0+）。

4.2 Docker Run 命令示例

bash
docker run -d \
  --name mod-orders-storage \
  -p 8081:8081 \
  -e DB_HOST=your-db-host \
  -e DB_PORT=5432 \
  -e DB_NAME=folio_orders \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=your-db-password \
  -e KAFKA_HOST=10.0.2.15 \
  -e KAFKA_PORT=9092 \
  -e consumer.verticle.mandatory=false \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  --memory=341m \
  docker.xuanyuan.run/folio/mod-orders-storage

4.3 Docker Compose 配置示例

yaml
version: '3.8'
services:
  mod-orders-storage:
    image: docker.xuanyuan.run/folio/mod-orders-storage
    container_name: mod-orders-storage
    ports:
      - "8081:8081"  # 模块端口映射
    environment:
      # 数据库配置（需提前创建数据库）
      DB_HOST: postgres
      DB_PORT: 5432
      DB_NAME: folio_orders
      DB_USER: folio_user
      DB_PASSWORD: your-db-password
      # Kafka配置
      KAFKA_HOST: 10.0.2.15
      KAFKA_PORT: 9092
      consumer.verticle.mandatory: "false"
      # JVM参数
      JAVA_OPTIONS: "-XX:MaxRAMPercentage=66.0"
    deploy:
      resources:
        limits:
          memory: 341m  # 容器内存限制（357913941字节 ≈ 341MB）
    depends_on:
      - postgres  # 依赖数据库服务
      - kafka     # 依赖Kafka服务（如需）

  # 依赖服务示例（实际部署需确保外部服务可用）
  postgres:
    image: docker.xuanyuan.run/postgres:13
    environment:
      POSTGRES_DB: folio_orders
      POSTGRES_USER: folio_user
      POSTGRES_PASSWORD: your-db-password
  kafka:
    image: docker.xuanyuan.run/confluentinc/cp-kafka:7.3.0
    environment:
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
    depends_on:
      - zookeeper
  zookeeper:
    image: docker.xuanyuan.run/confluentinc/cp-zookeeper:7.3.0
    environment:
      ZOOKEEPER_CLIENT_PORT: 2181

4.4 配置参数说明

4.4.1 模块基本信息

• 模块端口：8081（固定，容器内部端口，需映射至主机）；
• 容器内存限制：357913941字节（约341MB），建议通过 --memory 参数或 Docker Compose 资源限制配置。

4.4.2 环境变量配置

4.4.3 数据库配置说明

需提前创建兼容的数据库（如PostgreSQL），并确保：

• 容器网络可访问数据库服务；
• 数据库已通过 FOLIO 数据库迁移工具初始化表结构（如使用 okapi 或 folio-db-tools）。