php如何实现接口请求参数自动校验_php反射获取类型注解与规则验证示例

/**
 * 用户注册接口
 * @param string $username 必填|最小长度:2|最大长度:20
 * @param string $email    必填|格式:email
 * @param int    $age      可选|最小值:18
 */
public function register($username, $email, $age = null)
{
    // 业务逻辑
}

function getParamRules($class, $method)
{
    $reflection = new ReflectionMethod($class, $method);
    $docComment = $reflection->getDocComment();
    $params     = $reflection->getParameters();
<pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">$rules = [];

// 按行解析DocBlock
$lines = explode("\n", $docComment);
$paramDocs = [];

foreach ($lines as $line) {
    if (preg_match('/@param\s+\w+\s+\$(\w+)\s+(.+)/', $line, $matches)) {
        $paramName = $matches[1];
        $comment   = trim($matches[2]);
        $paramDocs[$paramName] = $comment;
    }
}

foreach ($params as $param) {
    $name = $param->getName();
    if (!isset($paramDocs[$name])) continue;

    $rawRules = explode('|', $paramDocs[$name]);
    $rules[$name] = [];

    foreach ($rawRules as $rule) {
        $rule = trim($rule);
        if (strpos($rule, ':') !== false) {
            list($key, $value) = explode(':', $rule, 2);
            $rules[$name][trim($key)] = trim($value);
        } else {
            $rules[$name][$rule] = true;
        }
    }

    // 标记是否可为空（有默认值）
    $rules[$name]['nullable'] = $param->isOptional();
}

return $rules;

function validate($data, $rules)
{
    $errors = [];
<pre class="brush:php;toolbar:false;"><pre class="brush:php;toolbar:false;">foreach ($rules as $field => $fieldRules) {
    $value = $data[$field] ?? null;

    if (isset($fieldRules['必填']) && $fieldRules['必填'] && $value === null) {
        $errors[] = "缺少必填参数: {$field}";
        continue;
    }

    if ($value === null && !isset($data[$field])) {
        continue; // 跳过未传递且可选的字段
    }

    // 类型检查（基于PHP反射实际类型也可扩展）
    if (isset($fieldRules['string']) && !is_string($value)) {
        $errors[] = "{$field} 必须是字符串";
    }

    if (isset($fieldRules['int']) && !is_int($value)) {
        $errors[] = "{$field} 必须是整数";
    }

    // 长度校验
    if (isset($fieldRules['最小长度']) && mb_strlen($value) < (int)$fieldRules['最小长度']) {
        $errors[] = "{$field} 长度不能小于 {$fieldRules['最小长度']}";
    }

    if (isset($fieldRules['最大长度']) && mb_strlen($value) > (int)$fieldRules['最大长度']) {
        $errors[] = "{$field} 长度不能大于 {$fieldRules['最大长度']}";
    }

    // 数值范围
    if (isset($fieldRules['最小值']) && $value < (int)$fieldRules['最小值']) {
        $errors[] = "{$field} 不能小于 {$fieldRules['最小值']}";
    }

    // 格式校验
    if (isset($fieldRules['格式']) && $fieldRules['格式'] === 'email' && !filter_var($value, FILTER_VALIDATE_EMAIL)) {
        $errors[] = "{$field} 邮箱格式不正确";
    }
}

return $errors;

$data = [
    'username' => '小明',
    'email'    => 'invalid-email',
    'age'      => 16
];
<p>$rules = getParamRules('UserController', 'register');
$errors = validate($data, $rules);</p><p>if (!empty($errors)) {
echo json_encode(['code' => 400, 'message' => $errors]);
} else {
echo json_encode(['code' => 200, 'message' => '校验通过']);
}