AD密码自助服务项目教程

AD密码自助服务项目教程

1. 项目目录结构及介绍

ad-password-self-service/
├── README.md
├── src/
│   ├── main.py
│   ├── config.py
│   ├── utils/
│   │   ├── helper.py
│   │   └── logger.py
│   └── services/
│       ├── password_service.py
│       └── user_service.py
├── tests/
│   ├── test_main.py
│   └── test_password_service.py
├── requirements.txt
└── setup.py

目录结构说明

• README.md: 项目说明文件，包含项目的基本信息、安装步骤和使用说明。
• src/: 源代码目录，包含项目的所有源代码文件。
  • main.py: 项目的启动文件，负责初始化应用并启动服务。
  • config.py: 项目的配置文件，包含应用的配置参数。
  • utils/: 工具模块，包含项目中使用的各种工具函数。
    • helper.py: 辅助函数模块，提供一些通用的辅助功能。
    • logger.py: 日志记录模块，负责记录应用的运行日志。
  • services/: 服务模块，包含项目的核心业务逻辑。
    • password_service.py: 密码服务模块，负责处理密码相关的业务逻辑。
    • user_service.py: 用户服务模块，负责处理用户相关的业务逻辑。
• tests/: 测试代码目录，包含项目的所有测试代码。
  • test_main.py: 主测试文件，包含对main.py的测试。
  • test_password_service.py: 密码服务测试文件，包含对password_service.py的测试。
• requirements.txt: 项目依赖文件，列出了项目运行所需的所有Python包。
• setup.py: 项目安装脚本，用于安装项目及其依赖。

2. 项目启动文件介绍

main.py

main.py是项目的启动文件，负责初始化应用并启动服务。以下是main.py的主要功能：

from src.config import Config
from src.services.password_service import PasswordService
from src.services.user_service import UserService

def main():
    config = Config()
    password_service = PasswordService(config)
    user_service = UserService(config)

    # 初始化服务
    password_service.init()
    user_service.init()

    # 启动服务
    password_service.start()
    user_service.start()

if __name__ == "__main__":
    main()

功能说明

• 初始化配置: 从config.py中加载配置参数。
• 初始化服务: 初始化密码服务和用户服务。
• 启动服务: 启动密码服务和用户服务。

3. 项目配置文件介绍

config.py

config.py是项目的配置文件，包含应用的配置参数。以下是config.py的主要内容：

class Config:
    def __init__(self):
        self.DEBUG = True
        self.SECRET_KEY = "your_secret_key"
        self.DATABASE_URI = "sqlite:///ad_password_self_service.db"
        self.LOG_LEVEL = "DEBUG"
        self.LOG_FILE = "app.log"

配置参数说明

• DEBUG: 调试模式开关，设置为True时启用调试模式。
• SECRET_KEY: 应用的密钥，用于加密和解密数据。
• DATABASE_URI: 数据库连接字符串，指定数据库的类型和路径。
• LOG_LEVEL: 日志记录级别，设置为DEBUG时记录详细日志。
• LOG_FILE: 日志文件路径，指定日志文件的存储位置。

通过以上配置，可以灵活调整应用的行为和日志记录方式。