validation_utils.py 2.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758
  1. import re
  2. from jsonschema import validate, ValidationError
  3. from app.core.biz_exception import BizLogicError
  4. def validate_user_inputs(schema_json: dict, user_inputs: dict):
  5. """
  6. Validate user inputs against the product's JSON Schema.
  7. Produces clear, human-readable English error messages identifying the exact field.
  8. """
  9. if not schema_json:
  10. return
  11. if user_inputs is None:
  12. user_inputs = {}
  13. if not isinstance(user_inputs, dict):
  14. raise BizLogicError(f"Invalid parameter [root]: Expected object, got {type(user_inputs).__name__}")
  15. try:
  16. validate(instance=user_inputs, schema=schema_json)
  17. except ValidationError as e:
  18. path_prefix = ".".join(map(str, e.path))
  19. # 1. 必填字段缺失错误 (required)
  20. if e.validator == 'required':
  21. match = re.search(r"'([^']+)' is a required property", e.message)
  22. missing_prop = match.group(1) if match else (e.validator_value[0] if isinstance(e.validator_value, list) and e.validator_value else "unknown")
  23. field = f"{path_prefix}.{missing_prop}" if path_prefix else missing_prop
  24. # 尝试从 properties 中获取该字段的人类可读名称 (title)
  25. prop_schema = e.schema.get("properties", {}).get(missing_prop, {}) if isinstance(e.schema, dict) else {}
  26. field_name = prop_schema.get("title") or missing_prop
  27. raise BizLogicError(f"Missing required field [{field}]: '{field_name}' is required")
  28. # 2. 正则格式错误 (pattern)
  29. elif e.validator == 'pattern':
  30. field = path_prefix or "root"
  31. prop_title = e.schema.get("title") or field if isinstance(e.schema, dict) else field
  32. desc = e.schema.get("description") if isinstance(e.schema, dict) else None
  33. detail = f" ({desc})" if desc else f" ({e.message})"
  34. raise BizLogicError(f"Invalid parameter [{field}]: '{prop_title}' format is invalid{detail}")
  35. # 3. 字段类型错误 (type)
  36. elif e.validator == 'type':
  37. field = path_prefix or "root"
  38. prop_title = e.schema.get("title") or field if isinstance(e.schema, dict) else field
  39. raise BizLogicError(f"Invalid parameter [{field}]: '{prop_title}' must be of type '{e.validator_value}'")
  40. # 4. 未知扩展字段错误 (additionalProperties)
  41. elif e.validator == 'additionalProperties':
  42. field = path_prefix or "root"
  43. raise BizLogicError(f"Invalid parameter [{field}]: {e.message}")
  44. # 5. 其他类型验证错误 (enum, minimum, maximum, etc.)
  45. else:
  46. field = path_prefix or "root"
  47. prop_title = e.schema.get("title") if isinstance(e.schema, dict) else None
  48. prefix = f"'{prop_title}': " if (prop_title and field != "root") else ""
  49. raise BizLogicError(f"Invalid parameter [{field}]: {prefix}{e.message}")