folioci/mod-circulation-item

FOLIO - mod-circulation-item 镜像文档

1. 镜像概述和主要用途

mod-circulation-item 是 FOLIO (图书馆服务平台) 生态中的核心模块之一，专注于处理与馆藏项目（Item）相关的流通业务逻辑。作为 FOLIO 流通系统的关键组件，该模块负责管理馆藏项目的流通状态（如图书借阅、归还、续借、预约等），并与平台其他模块（如用户管理、库存管理、权限控制模块）协同工作，支撑图书馆日常流通业务的自动化处理。

2. 核心功能和特性

2.1 核心功能

• 馆藏项目流通状态管理：实时跟踪并更新项目的借阅状态（可借、已借、预约中、处理中）。
• 流通规则执行：应用图书馆自定义的借阅规则（如借阅期限、续借次数限制、罚款规则）。
• 流通操作接口：提供 REST API 接口，支持借阅、归还、续借、预约等流通操作的请求处理。
• 跨模块数据交互：与 Okapi（FOLIO 网关）集成，实现与用户模块、库存模块等的数据同步。

2.2 主要特性

• 数据库依赖：需与关系型数据库（如 PostgreSQL）连接，存储流通业务数据。
• 可配置 JVM 参数：通过环境变量自定义 Java 运行时参数，优化内存使用。
• 标准化接口：遵循 FOLIO 模块开发规范，支持平台统一的服务注册与发现。

3. 使用场景和适用范围

3.1 使用场景

• FOLIO 图书馆服务平台部署环境中，作为流通业务层的核心组件。
• 图书馆日常运营中，处理馆藏项目的借阅、归还、续借等流通操作请求。
• 与其他 FOLIO 模块（如 mod-circulation、mod-users、mod-inventory）协同，构建完整的图书馆服务流程。

3.2 适用范围

• 适用于基于 FOLIO 平台的图书馆自动化系统。
• 需配合 FOLIO Okapi 网关及数据库服务部署，单独运行无实际业务意义。

4. 使用方法和配置说明

4.1 基础环境要求

• 依赖 FOLIO Okapi 网关服务（提供模块注册、路由、认证）。
• 依赖关系型数据库（如 PostgreSQL），需提前创建数据库并配置访问权限。
• 容器运行内存需满足最低 712MB（712673984 字节）要求。

4.2 核心配置参数

4.2.1 模块基础信息

4.2.2 环境变量配置

4. 使用方法和部署示例

4.1 Docker 运行命令

bash
docker run -d \
  --name mod-circulation-item \
  -p 8081:8081 \
  -e OKAPI_URL="http://okapi:9130" \
  -e ENV="folio" \
  -e JAVA_OPTIONS="-XX:MaxRAMPercentage=75.0" \
  -e DB_HOST="postgres" \
  -e DB_PORT="5432" \
  -e DB_NAME="folio_mod_circulation_item" \
  -e DB_USER="folio_user" \
  -e DB_PASSWORD="folio_password" \
  --memory=712m \
  folio/mod-circulation-item:latest

4.2 Docker Compose 配置示例

yaml
version: '3.8'

services:
  mod-circulation-item:
    image: folio/mod-circulation-item:latest
    container_name: mod-circulation-item
    ports:
      - "8081:8081"
    environment:
      - OKAPI_URL=http://okapi:9130
      - ENV=folio
      - JAVA_OPTIONS=-XX:MaxRAMPercentage=75.0
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=folio_mod_circulation_item
      - DB_USER=folio_user
      - DB_PASSWORD=folio_password
    depends_on:
      - okapi
      - postgres
    deploy:
      resources:
        limits:
          memory: 712m

  # 依赖服务（示例）
  okapi:
    image: folio/okapi:latest
    ports:
      - "9130:9130"

  postgres:
    image: postgres:13
    environment:
      - POSTGRES_USER=folio_user
      - POSTGRES_PASSWORD=folio_password
      - POSTGRES_DB=folio_mod_circulation_item
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  postgres-data:

5. 注意事项

• 数据库初始化：首次部署前需确保数据库已创建，且模块有权限执行表结构初始化（通常通过 Flyway 迁移脚本自动执行）。
• Okapi 依赖：需确保 Okapi 服务已启动并完成模块注册，否则模块无法接收请求。
• 内存配置：--memory=712m 为容器内存限制，需根据实际部署环境调整，建议不低于元数据指定的 712673984 字节（约 712MB）。