openlmis/notification

OpenLMIS Notification Service 镜像文档

1. 镜像概述

OpenLMIS Notification Service 是 OpenLMIS (Open Logistics Management Information System) 开源物流管理信息系统的核心微服务组件，专注于系统内通知消息的处理、分发与发送。作为OpenLMIS架构的关键部分，该服务与库存管理、订单管理等其他服务协同工作，确保用户及时获取业务关键事件通知，提升系统交互效率。

2. 核心功能与特性

• 通知生命周期管理：支持通知消息的接收、验证、存储、分发全流程处理
• 多渠道分发：可配置通过系统内消息、电子邮件等多种渠道发送通知（具体渠道取决于部署配置）
• 模板化通知内容：提供通知模板功能，支持自定义消息格式，适配不同业务场景需求
• 事件驱动机制：与OpenLMIS事件系统集成，基于业务事件（如库存阈值触发、订单状态变更）自动生成通知
• 发送状态跟踪：记录通知发送状态，支持失败重试与异常处理

3. 使用场景与适用范围

该服务主要应用于OpenLMIS系统环境中，典型使用场景包括：

• 库存管理通知：库存水平低于安全阈值、库存过期预警、库存接收确认等场景通知
• 订单流程通知：订单创建、审批通过、发货确认、接收完成等状态变更通知
• 用户操作提醒：账户注册验证、密码重置、权限变更等用户相关操作通知
• 系统运维告警：服务异常、任务执行失败、数据同步异常等系统级事件通知

4. 使用方法与配置说明

4.1 前置条件

• 已部署OpenLMIS基础架构（含数据库、认证服务、服务注册发现等核心组件）
• Docker Engine 1.13+ 环境
• 网络环境支持服务间通信及外部依赖访问（如SMTP服务器）

4.2 基本部署命令

Docker Run 示例

bash
docker run -d \
  --name openlmis-notification \
  -p 8080:8080 \
  --network openlmis-network \
  -e SPRING_PROFILES_ACTIVE=production \
  -e DB_HOST=openlmis-postgres \
  -e DB_NAME=openlmis \
  -e DB_USER=notification_service \
  -e DB_PASSWORD=${DB_PASSWORD} \
  -e SMTP_HOST=smtp.example.org \
  -e SMTP_PORT=587 \
  -e SMTP_USER=notifications@openlmis.org \
  -e SMTP_PASSWORD=${SMTP_PASSWORD} \
  openlmis/openlmis-notification:latest

Docker Compose 配置示例

yaml
version: '3.8'
services:
  notification-service:
    image: openlmis/openlmis-notification:latest
    container_name: openlmis-notification
    ports:
      - "8080:8080"
    environment:
      - SPRING_PROFILES_ACTIVE=production
      - DB_HOST=postgres
      - DB_PORT=5432
      - DB_NAME=openlmis
      - DB_USER=${NOTIFICATION_DB_USER}
      - DB_PASSWORD=${NOTIFICATION_DB_PASSWORD}
      - SMTP_HOST=${SMTP_HOST}
      - SMTP_PORT=587
      - SMTP_USER=${SMTP_USER}
      - SMTP_PASSWORD=${SMTP_PASSWORD}
      - EUREKA_CLIENT_SERVICEURL_DEFAULTZONE=http://service-registry:8761/eureka/
    depends_on:
      - postgres
      - service-registry
    networks:
      - openlmis-network

networks:
  openlmis-network:
    external: true

4.3 核心配置参数

4.4 注意事项

• 依赖集成：该服务需与OpenLMIS其他组件协同工作，单独部署无法提供完整功能
• 安全配置：生产环境中必须通过环境变量、配置文件或密钥管理服务注入敏感信息（如数据库密码、SMTP凭据）
• 扩展配置：高级功能（如通知渠道扩展、模板管理）需参考官方GitHub仓库文档进行配置
• 版本兼容性：请确保该服务版本与OpenLMIS系统其他组件版本兼容，具体参考官方版本矩阵

5. 参考资源

• 官方GitHub仓库：https://github.com/OpenLMIS/openlmis-notification
• OpenLMIS系统文档：[***]