folioorg/mod-circulation

FOLIO mod-circulation 镜像文档

1. 镜像概述和主要用途

1.1 概述

FOLIO mod-circulation 是 FOLIO (The Future of Libraries Is Open) 开源图书馆服务平台的核心模块之一，专注于图书馆日常流通业务的管理与处理。该模块提供流通环节的核心功能支持，是 FOLIO 生态中实现借阅、归还、续借等业务流程的关键组件。

1.2 主要用途

用于处理图书馆馆藏资源的流通生命周期，包括但不限于借阅管理、归还处理、续借操作、流通规则执行等，支撑图书馆日常运营中的核心流通业务场景。

2. 核心功能和特性

• 流通业务流程支持：基于 FOLIO 平台架构，实现图书馆标准流通业务流程的自动化处理。
• 借阅数据化**：支持计划任务式借阅数据**化，可配置单次检查的借阅记录数量。
• 浮动馆藏管理：通过环境变量控制是否启用浮动馆藏（Floating Collections）功能。
• Kafka 消息集成：支持与 Kafka 消息队列对接，实现模块间事件通信与数据同步。
• 资源占用优化：通过 JVM 参数配置（如 MaxRAMPercentage）优化内存资源利用。

3. 使用场景和适用范围

3.1 适用场景

• 部署 FOLIO 图书馆服务平台的机构，需构建完整流通业务系统时。
• 图书馆日常运营中需自动化处理借阅、归还、续借等流通操作时。
• 需要对接 Kafka 实现流通事件通知或数据同步的场景。

3.2 适用范围

适用于各类图书馆（高校图书馆、公共图书馆等）及信息资源管理机构，作为 FOLIO 平台的核心模块协同其他服务（如用户管理、馆藏管理模块）运行。

4. 使用方法和配置说明

4.1 Docker 部署示例

4.1.1 docker run 命令部署

bash
docker run -d \
  --name mod-circulation \
  -p 9801:9801 \
  -e SCHEDULED_ANONYMIZATION_NUMBER_OF_LOANS_TO_CHECK=50000 \
  -e ENABLE_FLOATING_COLLECTIONS=true \
  -e KAFKA_HOST=kafka \
  -e KAFKA_PORT=9092 \
  -e REPLICATION_FACTOR=1 \
  -e ENV=folio \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=66.0" \
  --memory=1g \
  folio/mod-circulation:latest

4.1.2 docker-compose 配置示例

yaml
version: '3.8'
services:
  mod-circulation:
    image: folio/mod-circulation:latest
    container_name: mod-circulation
    ports:
      - "9801:9801"
    environment:
      - SCHEDULED_ANONYMIZATION_NUMBER_OF_LOANS_TO_CHECK=50000
      - ENABLE_FLOATING_COLLECTIONS=true
      - KAFKA_HOST=kafka
      - KAFKA_PORT=9092
      - REPLICATION_FACTOR=1
      - ENV=folio
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0
    deploy:
      resources:
        limits:
          memory: 1g
    depends_on:
      - kafka  # 若依赖 Kafka 服务，需确保 Kafka 容器已启动

4.2 配置参数说明

4.2.1 基础配置

4.2.2 JVM 配置

4.2.3 业务配置（环境变量）

5. 代码仓库

模块源代码及详细文档可参考：https://github.com/folio-org/mod-circulation