folioorg/mod-pubsub

FOLIO - mod-pubsub 镜像文档

镜像概述

mod-pubsub是FOLIO开源图书馆服务平台的核心模块之一，实现发布-订阅（Publisher-Subscriber）机制，提供事件驱动的处理架构，支持系统内部事件的产生、分发与消费。该模块是FOLIO系统模块间异步通信的关键组件。
代码仓库：https://github.com/folio-org/mod-pubsub

核心功能与特性

• 事件驱动架构：基于发布-订阅模式，实现事件的生产、路由和消费，支持模块间异步通信
• 松耦合集成：通过事件机制降低系统模块间的直接依赖，提升架构灵活性
• 可配置化部署：支持通过环境变量自定义Kafka连接、系统认证等关键参数
• 内存优化：默认配置JVM内存参数，保障服务稳定运行（MaxRAMPercentage=66.0%）

使用场景

• FOLIO系统内部模块间的事件通知（如资源变更、任务状态更新等）
• 跨模块异步任务触发与结果回调
• 系统事件日志的集中收集与处理
• 需要解耦的业务流程协同（如订单处理、库存更新等）

使用方法与配置说明

基础运行信息

• 模块端口：8081（容器内服务端口，需映射至主机）
• 容器内存限制：***字节（1GB，建议通过--memory参数显式指定）
• 数据库依赖：需连接外部数据库（具体配置需结合FOLIO整体部署）
• JVM参数：-XX:MaxRAMPercentage=66.0 -XX:+HeapDumpOnOutOfMemoryError（控制内存分配及OOM时堆转储）

环境变量配置

Docker运行示例

bash
docker run -d \
  -p 8081:8081 \  # 端口映射（主机:容器）
  -e KAFKA_HOST=kafka-service \  # Kafka服务地址（需替换为实际地址）
  -e KAFKA_PORT=9092 \
  -e OKAPI_URL=http://okapi:9130 \  # FOLIO OKAPI服务地址
  -e SYSTEM_USER_NAME=pub-sub \
  -e SYSTEM_USER_PASSWORD=secure-pubsub-password \  # 生产环境建议使用强密码
  --memory=1g \  # 容器内存限制（与元数据一致）
  folio/mod-pubsub:latest

关键注意事项

• 需确保Kafka服务与OKAPI网关服务可访问，网络配置需匹配实际部署环境
• 系统用户密码（SYSTEM_USER_PASSWORD）需保密，建议通过Docker Secrets或环境变量安全管理
• 数据库连接配置需结合FOLIO整体部署（如使用PostgreSQL），具体参数需参考FOLIO部署文档