mod-sender 模块文档

概述

mod-sender是FOLIO项目的核心模块之一，主要用途是通过交付渠道发送消息，为FOLIO生态系统提供可靠的消息传递能力。该模块源代码托管于[***]

核心功能与特性

• 消息发送：支持通过指定交付渠道发送消息
• 无数据库依赖：模块运行无需数据库连接（数据库连接配置为false）
• 内存优化：提供JVM内存参数配置，确保容器资源高效利用

使用场景

作为FOLIO生态系统的消息传递组件，适用于各类需要系统间或系统与用户间消息通知的场景，例如：

• 图书馆管理系统中的用户通知（如借阅到期提醒）
• 系统内部服务间的消息通信
• 业务流程中的事件通知

部署与配置说明

基本部署命令

通过Docker容器部署mod-sender的基本命令如下：

bash
docker run -d -p 8081:8081 --name mod-sender folio/mod-sender

核心配置参数

网络配置

• 模块端口：8081，容器内部默认使用8081端口提供服务，可通过-p参数映射至主机端口

资源配置

• 容器内存：推荐配置536870912字节（512MB），确保模块运行时有足够内存资源
• JVM参数：JAVA_OPTIONS=-XX:MaxRAMPercentage=66.0，设置JVM最大可用内存占容器内存的百分比，优化内存使用效率

数据库配置

• 数据库连接：false，该模块无需连接数据库，部署时无需配置数据库相关环境变量或参数

环境变量配置

可通过环境变量自定义模块行为，主要支持的环境变量：

• JAVA_OPTIONS：自定义JVM参数，默认值为-XX:MaxRAMPercentage=66.0
• PORT：覆盖默认端口（默认8081），需同时调整容器端口映射

注意事项

• 部署时需确保容器内存配置不低于推荐的512MB，避免因内存不足导致服务异常
• 若修改默认端口，需同步更新容器端口映射及依赖服务的调用配置