aixpand/backend

Optizone & Preventics 后端服务

概述

Optizone & Preventics后端服务是CAVI平台的核心Node.js后端组件，负责设备管理、数据处理、用户身份认证、通知推送等关键功能。该服务采用模块化架构设计，支持与MQTT Broker、PostgreSQL数据库、Redis缓存、MinIO/AWS S3存储等多种服务集成，通过环境变量实现灵活配置，确保在不同部署场景下的稳定性和可扩展性。

核心功能与特性

• 多服务集成：支持MQTT协议通信、PostgreSQL数据持久化、Redis缓存、MinIO/S3对象存储等多种服务连接
• 模块化架构：包含车辆注册、设备管理、身份认证、AI插件、通知服务等独立模块，便于维护和扩展
• 灵活配置：通过环境变量实现必要参数（如数据库连接、日志设置）和可选参数（如集成开关、清理策略）的配置
• 日志管理：支持控制台日志与文件日志输出，可配置日志路径、详细程度和文件存储策略
• 数据清理：内置批处理清理机制，可配置告警数据保留天数和清理批次大小
• CI/CD支持：通过GitHub Actions实现自动化构建、测试和发布流程

环境变量配置

应用通用设置

MQTT Broker连接

（注：原文档未提供具体变量，通常需配置MQTT服务器地址、端口、用户名、密码等参数，建议根据实际部署需求补充）

边缘节点网络设置

（注：原文档未提供具体变量，通常需配置边缘节点通信地址、端口、超时时间等参数，建议根据实际部署需求补充）

数据库（PostgreSQL）连接

（注：原文档未提供具体变量，通常需配置POSTGRES_HOST、POSTGRES_PORT、POSTGRES_USER、POSTGRES_PASSWORD、POSTGRES_DB等参数，建议根据实际部署需求补充）

Redis连接

（注：原文档未提供具体变量，通常需配置REDIS_HOST、REDIS_PORT、REDIS_PASSWORD、REDIS_DB等参数，建议根据实际部署需求补充）

MinIO或AWS S3凭证

（注：原文档未提供具体变量，通常需配置S3_ENDPOINT、S3_ACCESS_KEY、S3_SECRET_KEY、S3_BUCKET等参数，建议根据实际部署需求补充）

使用方法

Docker运行示例

bash
docker run -d \
  --name cavi-backend \
  -e HOSTNAME=cavi-backend-01 \
  -e LOG_TO_FILE=true \
  -e LOGS_PATH=/app/logs \
  -e INTEGRATIONS_ENABLED=1 \
  -e POSTGRES_HOST=postgres \
  -e POSTGRES_PORT=5432 \
  -e POSTGRES_USER=cavi_user \
  -e POSTGRES_PASSWORD=cavi_pass \
  -e POSTGRES_DB=cavi_db \
  -e REDIS_HOST=redis \
  -e REDIS_PORT=6379 \
  -v ./logs:/app/logs \
  cavi/optizone-preventics-backend:latest

Docker Compose配置示例

yaml
version: '3.8'
services:
  backend:
    image: cavi/optizone-preventics-backend:latest
    container_name: cavi-backend
    environment:
      - HOSTNAME=cavi-backend-01
      - LOG_TO_FILE=true
      - LOGS_PATH=/app/logs
      - INTEGRATIONS_ENABLED=1
      - VERBOSE=1
      - APP_TYPE=optizone
      - CSV_EXPORT_LIMIT=50000
      - SYSTEM_CLEANUP_BATCH_SIZE=2000
      - SYSTEM_ALERTS_CLEANUP_DAYS=180
      - POSTGRES_HOST=postgres
      - POSTGRES_PORT=5432
      - POSTGRES_USER=cavi_user
      - POSTGRES_PASSWORD=cavi_pass
      - POSTGRES_DB=cavi_db
      - REDIS_HOST=redis
      - REDIS_PORT=6379
    volumes:
      - ./logs:/app/logs
    depends_on:
      - postgres
      - redis
    restart: unless-stopped

  postgres:
    image: postgres:14
    environment:
      - POSTGRES_USER=cavi_user
      - POSTGRES_PASSWORD=cavi_pass
      - POSTGRES_DB=cavi_db
    volumes:
      - postgres-data:/var/lib/postgresql/data

  redis:
    image: redis:alpine
    command: redis-server --requirepass redis_pass
    volumes:
      - redis-data:/data

volumes:
  postgres-data:
  redis-data:

代码结构概述

核心目录

• src/: 源代码根目录，包含应用入口、配置和核心模块
  • configuration.ts: 应用配置管理
  • main.ts: 应用入口文件
  • main.module.ts: 根模块定义
• src/clients/: 客户端通信模块，处理外部服务连接
• src/car.registry/: 车辆注册管理模块，包含控制器、服务和实体定义
• src/equipment/: 设备管理模块，支持摄像头、边缘设备、 barrier等多种设备类型
• src/identity/: 身份认证模块，包含用户、角色和权限管理
• src/plugins/: 插件模块，包含AI处理、通知和自定义格式化功能
• src/system/: 系统功能模块，包含缓存、存储、WebSocket和版本管理

主要模块功能

• 设备管理: 提供设备注册、状态监控、操作控制等功能
• 车辆注册: 管理车辆信息的注册、查询和过滤
• 身份认证: 处理用户登录、权限验证和角色管理
• AI插件: 集成AI处理管道，支持实时数据流消费和边缘节点更新
• 通知服务: 处理系统告警和事件通知的生成与分发

版本发布

通过GitHub Actions实现自动化构建和发布流程，版本号遵循语义化版本规范（Semantic Versioning）。发布记录包含详细的功能变更、bug修复和兼容性说明，可在项目Releases页面查看完整历史。