Python Eve：如何实现文档级验证以替代重复字段级验证？

我们目前大量使用字段级验证（field-level validation），它确实功能强大且实用，但遇到需要同时评估多个字段才能判定文档有效性的场景时，现有方案存在问题：只要涉及的任一字段变更，就需要为每个相关字段添加相同的验证逻辑，这会导致POST请求时验证被多次执行。

举个具体例子：我们有一个some_thing资源，包含field1和field2两个字段，验证规则需要同时校验这两个字段的组合逻辑，任一字段变更都要结合另一个字段做校验。

现有字段级实现方式 #

验证器（已简化）：

def _validate_custom_validation(self, custom_validation, field, value):
    if field == "field1":
        f1 = value
        f2 = self.document.get('field2')
    if field == "field2":
        f1 = self.document.get('field1')
        f2 = value
    if custom_validation and not is_validate(f1, f2):
        self._error(field, "validation failed...")

对应的Schema定义：

DOMAIN = {
    'some_thing': {
        'schema': {
            'field1': { 'type': 'string', 'custom_validation': True },
            'field2': { 'type': 'string', 'custom_validation': True }
        }
    }
}

我们期望的文档级实现形式 #

我们希望直接为整个文档应用验证规则，而不是绑定到单个字段上，比如：
验证器：

def _validate_custom_validation(self, custom_validation):
    f1 = self.document.get('field1')
    f2 = self.document.get('field2')
    if custom_validation and not is_validate(f1, f2):
        self._error(resource, "validation failed...")

对应的Schema定义：

DOMAIN = {
    'some_thing': {
        'custom_validation': True,
        'schema': {
            'field1': { 'type': 'string' },
            'field2': { 'type': 'string' }
        }
    }
}

想请教各位，这种文档级的验证实现是否可行？如果可行，具体该怎么操作？

从你给出的DOMAIN配置结构来看，你应该在使用Eve框架对吧？完全可以实现这种文档级的验证逻辑，完美解决字段级验证重复执行的问题，下面给你两种常用的实现方式：

1. 用Eve原生的文档级验证钩子（最推荐） #

Eve支持在资源配置里直接指定文档级验证函数，通过validators字段定义，它会在所有字段级验证完成后执行，而且不管多少字段变更，只会跑一次，正好匹配你的需求。

具体实现： #

先写好你的文档级验证函数：

from eve import ValidationError

def validate_some_thing_doc(document):
    f1 = document.get('field1')
    f2 = document.get('field2')
    # 这里调用你的校验逻辑
    if not is_validate(f1, f2):
        # 抛出ValidationError，Eve会自动返回标准的422错误响应
        raise ValidationError("validation failed...")

然后修改你的DOMAIN配置，把验证器绑定到资源上：

DOMAIN = {
    'some_thing': {
        'schema': {
            'field1': { 'type': 'string' },
            'field2': { 'type': 'string' }
        },
        # 这里指定文档级验证器，支持多个函数按顺序执行
        'validators': {
            'validate_document': validate_some_thing_doc
        }
    }
}

这种方式的好处：

• 逻辑简洁，直接操作整个文档，不用再判断当前处理的是哪个字段
• 验证只执行一次，彻底解决POST/UPDATE时重复验证的问题
• 完全贴合Eve的原生扩展机制，兼容性拉满

2. 用事件钩子实现更灵活的验证 #

如果你需要更精细的控制（比如插入和更新时用不同的校验逻辑，或者验证前要做一些数据预处理），可以用Eve的before_insert/before_update事件钩子：

def pre_check_some_thing(resource, items):
    for item in items:
        # 如果是更新操作，可能需要获取原始文档的字段（因为更新可能只传部分字段）
        if resource == 'some_thing' and request.method == 'PATCH':
            original = app.data.find_one(resource, id=item['_id'])
            f1 = item.get('field1', original.get('field1'))
            f2 = item.get('field2', original.get('field2'))
        else:
            f1 = item.get('field1')
            f2 = item.get('field2')
        
        if not is_validate(f1, f2):
            raise ValidationError("validation failed...")

# 把钩子注册到对应的事件上
app.on_pre_insert_some_thing += pre_check_some_thing
app.on_pre_update_some_thing += pre_check_some_thing

小提醒： #

更新操作时要注意，客户端可能只传了变更的字段，所以需要结合原始数据来获取完整的字段值，避免校验逻辑出错。

关于你期望的配置形式 #

你想直接在资源配置里加custom_validation: True的方式，Eve原生不支持，但其实没必要额外扩展——上面两种方案已经能完美解决你的问题，而且比你设想的实现更简洁可靠。

总之，文档级验证完全可行，而且能有效解决你现在遇到的重复执行问题，优先推荐第一种validators方案，上手快，代码也更干净。

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