开发注意事项

1. 安全规范

1.1 敏感信息

敏感信息包括但不限于：

API 密钥
数据库连接信息
用户密码

在代码中不应该直接出现敏感信息，应该使用环境变量或配置文件的方式进行配置。

当需要使用某些敏感信息时，应使用以下方法：

本地部署时

在本地部署时，可以.env文件来配置环境变量，例如：

在根目录下创建.env文件：

API_KEY=sk-xxxxxxxxxxxxxxxxxx

然后在代码中使用os.getenv来获取环境变量：

# app.py
import os
from dotenv import load_dotenv # 使用 python-dotenv 库从 .env 文件中加载环境变量

load_dotenv() # 加载 .env 文件到环境变量
API_KEY = os.getenv('API_KEY') # 获取 API_KEY 环境变量

注意

所有环境变量应该在入口文件app.py中加载，其他模块应该通过app.py来获取环境变量。

服务器部署时

在服务器部署时，会通过相应的方式来配置环境变量。

1.2 template 注入风险

在使用模板引擎时，应该注意防止模板注入风险。

考虑到本后端项目的特性，尽量不要使用模板引擎（template）渲染用户输入的内容。

2. 代码规范

2.1 代码风格

对函数、变量、类等命名应该有意义，遵循以下规范：

不要使用拼音
对于常量，使用全大写字母，单词之间使用下划线分隔
对于函数、变量，使用小写字母，单词之间使用下划线分隔
对于类，使用大写字母开头的驼峰命名法

单行代码长度不应过长，需保证在正常编辑器大小中能够完整显示。

2.2 注释

对于函数、类、模块等，应该添加注释说明其功能。

可以使用#来添加注释，也可以使用"""来添加多行注释。

2.3 Typing

对于函数、方法等，应该添加类型注释。

如：

def add(a: int, b: int) -> int:
    return a + b