编辑 | blame | 历史 | 原始文档

配置文件使用指南

概述

项目已从Python配置文件(config.py)转换为JSON配置文件(config.json),这样更适合打包为exe文件。

配置文件结构

config.json

{
  "database": {
    "url": "mysql+pymysql://root:password@host:port/database"
  },
  "redis": {
    "url": "redis://localhost:6379/0"
  },
  "ecloud": {
    "base_url": "http://125.122.152.142:9899",
    "authorization": "your_authorization_token"
  },
  "dify": {
    "base_url": "https://api.dify.ai/v1",
    "api_key": "your_dify_api_key"
  },
  "server": {
    "host": "0.0.0.0",
    "port": 7979,
    "debug": true
  },
  "logging": {
    "level": "INFO",
    "file": "logs/app.log"
  },
  "message_processing": {
    "max_retry_count": 3,
    "retry_delay": 5,
    "queue_timeout": 300
  }
}

配置项说明

数据库配置 (database)

  • url: 数据库连接字符串,支持MySQL

Redis配置 (redis)

  • url: Redis连接字符串

E云管家配置 (ecloud)

  • base_url: E云管家API基础URL
  • authorization: E云管家API授权令牌

DifyAI配置 (dify)

  • base_url: DifyAI API基础URL
  • api_key: DifyAI API密钥

服务器配置 (server)

  • host: 服务器监听地址
  • port: 服务器监听端口
  • debug: 是否启用调试模式

日志配置 (logging)

  • level: 日志级别 (DEBUG, INFO, WARNING, ERROR)
  • file: 日志文件路径

消息处理配置 (message_processing)

  • max_retry_count: 最大重试次数
  • retry_delay: 重试延迟时间(秒)
  • queue_timeout: 队列超时时间(秒)

使用方法

1. 修改配置

直接编辑 config.json 文件即可,应用会自动加载新配置。

2. 配置文件位置

  • 开发环境:项目根目录下的 config.json
  • 生产环境:exe文件同目录下的 config.json

3. 配置验证

如果配置文件不存在或格式错误,系统会使用默认配置并输出错误信息。

兼容性

  • 原有的 from config import settings 导入方式保持不变
  • 所有配置属性的访问方式保持不变(如 settings.database_url
  • 向后兼容,不需要修改现有代码

打包为exe的优势

  1. 配置外部化: 配置文件独立于exe文件,便于部署时修改
  2. 无需重新编译: 修改配置不需要重新打包exe
  3. 易于维护: JSON格式直观易读,便于运维人员配置
  4. 版本控制友好: 可以为不同环境准备不同的配置文件

注意事项

  1. 确保 config.json 文件格式正确,可以使用JSON验证工具检查
  2. 敏感信息(如数据库密码、API密钥)应妥善保管
  3. 生产环境建议将 debug 设置为 false
  4. 日志文件路径确保应用有写入权限