folioorg/mod-inventory

FOLIO - mod-inventory 镜像文档

镜像概述和主要用途

mod-inventory 是 FOLIO（开源图书馆服务平台）生态系统的核心模块之一，专注于图书馆资源的库存数据管理。该模块提供标准化的接口和工具，用于记录、跟踪和维护图书馆资源（如图书、期刊、电子资源等）的库存状态信息。作为 FOLIO 微服务架构的一部分，mod-inventory 需与其他模块（如 mod-circulation、mod-discovery）协同工作，支撑图书馆日常运营中的资源管理流程。

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

核心功能和特性

核心功能

• 资源库存记录管理：支持资源元数据录入、更新、查询及删除
• 库存状态跟踪：监控资源的在库、借出、丢失、维修等状态变更
• 数据标准化：提供符合图书馆行业标准的库存数据模型和字段定义
• 批量操作支持：支持批量导入/导出库存数据，简化大规模资源管理

技术特性

• 数据库依赖：需外部数据库存储库存数据（Database connection: true）
• 消息队列集成：通过 Kafka 实现异步消息处理（需配置 Kafka 连接参数）
• HTTP 服务：通过固定端口（9403）提供 REST API 接口
• JVM 优化：默认配置 JVM 内存参数以适应容器化环境

使用场景和适用范围

典型使用场景

• 图书馆资源入库登记与编目后的库存信息初始化
• 日常库存状态更新（如借出、归还、报废等操作的记录）
• 库存数据批量校验与修正（如定期盘点后的状态同步）
• 与 circulation 模块联动，实时更新资源借阅状态

适用范围

• 学术图书馆、公共图书馆、研究机构图书馆等采用 FOLIO 平台的机构
• 需要标准化管理实体或电子资源库存数据的图书馆系统
• 需与其他 FOLIO 模块协同实现资源全生命周期管理的场景

详细的使用方法和配置说明

前提条件

• 已部署 Docker 环境（Docker Engine 20.10+）
• 已准备兼容的关系型数据库（如 PostgreSQL 12+，FOLIO 推荐数据库）
• 已部署 Kafka 服务（如需启用消息队列功能）
• 网络环境需开放模块端口（9403）及数据库、Kafka 连接端口

部署方案示例

1. Docker Run 命令示例

bash
docker run -d \
  --name mod-inventory \
  -p 9403:9403 \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0 -Dorg.folio.metadata.inventory.storage.type=okapi" \
  -e KAFKA_HOST=kafka-service \
  -e KAFKA_PORT=9092 \
  -e DB_HOST=postgres-service \
  -e DB_PORT=5432 \
  -e DB_NAME=folio_inventory \
  -e DB_USER=folio_user \
  -e DB_PASSWORD=folio_password \
  --memory=715m \
  folioorg/mod-inventory:latest

2. Docker Compose 配置示例

yaml
version: '3.8'

services:
  mod-inventory:
    image: folioorg/mod-inventory:latest
    container_name: folio-mod-inventory
    restart: unless-stopped
    ports:
      - "9403:9403"
    environment:
      # JVM 配置
      JAVA_OPTIONS: "-XX:MaxRAMPercentage=66.0 -Dorg.folio.metadata.inventory.storage.type=okapi"
      # Kafka 连接
      KAFKA_HOST: kafka
      KAFKA_PORT: 9092
      # 数据库连接（必需）
      DB_HOST: postgres
      DB_PORT: 5432
      DB_NAME: folio_inventory
      DB_USER: folio_user
      DB_PASSWORD: secure_password
    mem_limit: 715m
    depends_on:
      - postgres
      - kafka

  # 依赖服务（示例）
  postgres:
    image: postgres:14-alpine
    environment:
      POSTGRES_DB: folio_inventory
      POSTGRES_USER: folio_user
      POSTGRES_PASSWORD: secure_password
    volumes:
      - postgres-data:/var/lib/postgresql/data

  kafka:
    image: confluentinc/cp-kafka:7.5.0
    environment:
      KAFKA_ADVERTISED_LISTENERS: PLAINTEXT://kafka:9092
      KAFKA_OFFSETS_TOPIC_REPLICATION_FACTOR: 1
      KAFKA_ZOOKEEPER_CONNECT: zookeeper:2181
    depends_on:
      - zookeeper

  zookeeper:
    image: confluentinc/cp-zookeeper:7.5.0
    environment:
      ZOOKEEPER_CLIENT_PORT: 2181

volumes:
  postgres-data:

配置参数说明

核心环境变量

容器资源配置

• 内存限制：建议设置为 715MB（对应 715827883 字节），通过 --memory=715m 或 mem_limit: 715m 配置
• 端口映射：模块默认监听 9403 端口，需通过 -p 9403:9403 映射至宿主机

代码仓库

https://github.com/folio-org/mod-inventory