AI Agent / 系统课时

实现接口参数校验

实现接口参数校验

接口参数校验负责拦截无效输入,避免错误数据进入业务流程。本篇将学习如何处理必填字段、格式限制和业务规则,并建立统一错误反馈机制。

学习目标

  • 理解接口参数校验的不同层次。
  • 能够实现基础字段和业务规则检查。
  • 掌握统一返回校验错误的方法。

参数校验的分层思路

参数校验通常分为三层。第一层是格式校验,例如类型、长度和正则规则;第二层是业务校验,例如金额范围或状态限制;第三层是数据一致性校验,例如数据库中的唯一性检查。合理分层可以让错误更早暴露,也方便定位问题。

使用代码实现基础校验

下面使用 JavaScript 编写一个简单接口参数校验示例。

javascript
function validateCreateUser(input) {
  const errors = [];

  // 检查客户端必须提供的字段
  if (!input.email) {
    errors.push("email is required");
  }

  // 检查字段格式
  if (input.email && !input.email.includes("@")) {
    errors.push("email format is invalid");
  }

  if (errors.length > 0) {
    return { valid: false, errors };
  }

  return { valid: true };
}

const result = validateCreateUser({ email: "user.example.com" });
console.log(JSON.stringify(result));

预期输出

text
{"valid":false,"errors":["email format is invalid"]}

实际项目中可以根据框架能力,将校验规则抽离为独立模块,避免控制器代码越来越复杂。

统一处理错误反馈

接口不应直接返回随机字符串作为错误信息,而应该定义稳定的错误结构。例如:

json
{
  "errorCode": "USER_EMAIL_INVALID",
  "message": "邮箱格式不正确",
  "details": {
    "field": "email"
  }
}

客户端可以根据 errorCode 决定展示方式,而不是依赖可能变化的文字内容。

校验边界与常见问题

参数校验需要关注边界条件。例如数字字段不仅要检查是否存在,还要检查最大值、最小值和精度。字符串字段需要考虑空字符串、特殊字符和长度限制。常见错误包括:

  • 只做前端校验,忽略服务端校验。
  • 校验逻辑分散在多个业务方法中。
  • 错误信息不统一,导致客户端难以处理。
  • 将业务规则和格式规则混合在一起。
按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

实现接口参数校验

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通