Flask & Python 简化请求缺失参数校验方案咨询

简化校验的实现方式 #

1. 原生无依赖方案 #

不需要引入额外第三方库，直接通过遍历必填字段列表实现，代码示例如下：

r = request.get_json(force=True, silent=True)
if not r:
    raise InvalidUsageError(message="请求体必须包含有效参数")

# 定义请求参数字段映射：key为前端传递的参数名，value为后端使用的变量名
required_fields = {
    "firstName": "first_name",
    "lastName": "last_name",
    "email": "email",
    "password": "password",
    "quizId": "quiz_uuid"
}
params = {}
for req_param, backend_var in required_fields.items():
    value = r.get(req_param)
    if not value:
        # 可直接生成你需要的任意格式错误提示
        raise InvalidUsageError(message=f"{req_param} is missing from the request")
    params[backend_var] = value

# 后续直接从params中取值使用即可
first_name = params["first_name"]
last_name = params["last_name"]
email = params["email"]
password = params["password"]
quiz_uuid = params["quiz_uuid"]

这种方式只需要维护required_fields列表即可，新增必填参数不需要额外写if not判断，自动完成校验和错误提示生成。

2. 第三方校验库方案（推荐） #

如果需要同时支持格式校验、类型转换等更复杂的校验能力，可以用pydantic这类成熟的校验库，不需要自己写校验逻辑，示例如下：

from pydantic import BaseModel, Field, ValidationError

# 定义参数校验模型
class ReqParamModel(BaseModel):
    first_name: str = Field(alias="firstName")
    last_name: str = Field(alias="lastName")
    email: str
    password: str
    quiz_uuid: str = Field(alias="quizId")

# 直接解析校验请求参数
try:
    params = ReqParamModel.parse_obj(request.get_json(force=True, silent=True))
except ValidationError as e:
    # 自动收集所有缺失的参数生成错误提示
    miss_params = [err["loc"][0] for err in e.errors() if err["type"] == "value_error.missing"]
    err_msg = "; ".join([f"{p} is missing from the request" for p in miss_params])
    raise InvalidUsageError(message=err_msg)

# 后续直接通过属性取值即可
first_name = params.first_name
last_name = params.last_name

这种方式除了非空校验外，还能自动校验参数格式（比如邮箱格式、数字范围等），错误提示也能自动生成，适合中大型项目使用。

细粒度参数校验错误的行业使用情况 #

行业内没有统一的强制规范，主要根据接口的使用场景决定：

• 对内使用的接口（给自有前端、内部系统调用）：普遍会返回这类细粒度错误提示，既可以提升前后端联调效率，也可以让前端直接复用后端的错误提示做用户引导，避免重复开发校验逻辑。
• 对外公开的接口、涉及敏感操作的接口：会对错误提示做模糊处理，避免泄露系统信息被恶意利用。比如登录接口不会明确返回“账号不存在”或者“密码错误”，只会返回“账号或密码错误”这类通用提示，但普通的非敏感参数校验场景，依然会返回明确的参数缺失/格式错误提示。

内容的提问来源于stack exchange，提问作者Sean Payne