Yii框架RESTful接口怎么签名_Yii框架请求参数校验机制【教程】

阿宇大大_4881

阿宇大大_4881

2026-04-30

182人浏览

原创

yii2 restful接口需手动实现sign签名验证与参数校验,签名应在beforeaction中统一处理,参数须原始获取后按字典序拼接并hmac校验;参数校验不可依赖$request->get()等自动转换,必须先取原始值再通过验证器或filter_var严格校验。

yii框架restful接口怎么签名_yii框架请求参数校验机制【教程】

Yii RESTful 接口本身不提供签名机制,sign 必须手动实现;参数校验也**不是自动发生的**,$request->get() 和 $request->post() 返回的永远是原始字符串,不校验、不转类型、不过滤。

怎么在 Yii2 RESTful 接口中加 sign 签名验证

签名通常用于防止请求被篡改或重放,常见于开放 API 场景。Yii 没内置支持,需在控制器行为或基类中统一拦截处理。

  • 签名逻辑一般放在 behaviors() 的 AuthMethod 子类里(比如自定义 SignAuth),而不是写在每个 action 里
  • 典型流程:提取所有非 sign 参数 → 按 key 字典序排序 → 拼接成字符串 → 与约定密钥一起 md5() 或 hash_hmac('sha256', ...)
  • 注意:必须排除 sign 字段本身,且要统一处理空值、布尔值、嵌套数组——实际中建议只对 flat query string 校验,避免 JSON body 解析后结构差异引发签名不一致
  • 客户端传 sign=xxx 时,服务端用 $request->get() 或 $request->getBody() 解出原始参数后立即计算比对,失败直接 throw new BadRequestHttpException('Invalid sign')

示例片段(放在控制器基类中):

Yii Framework 2.0.51
Yii Framework 2.0.51

Yii Framework 2.0.51 官方 Basic 应用模板,适合旧项目兼容、升级验证和开发测试。

下载
public function beforeAction($action)
{
    $params = $this->getRequestParams();
    $clientSign = $params['sign'] ?? '';
    unset($params['sign']);
    ksort($params);
    $expected = hash_hmac('sha256', http_build_query($params), 'your_shared_secret');
    if (!hash_equals($expected, $clientSign)) {
        throw new BadRequestHttpException('Invalid sign');
    }
    return parent::beforeAction($action);
}

protected function getRequestParams()
{
    $contentType = \Yii::$app->request->getContentType();
    if ($contentType === 'application/json') {
        return \Yii::$app->request->getBodyParams() ?: Json::decode(\Yii::$app->request->getRawBody());
    }
    return \Yii::$app->request->get() + \Yii::$app->request->post();
}

为什么不能直接用 $request->get('xxx') 做校验

因为 $request->get('id') 返回的是字符串 "1abc",不是整数;$request->get('email') 可能是 "<script>alert(1)</script>@test.com";它不做任何清洗或类型约束。

  • 常见错误:写 $id = (int)$request->get('id'); —— 输入 "0x123" 或 "1e2" 会被转成 0 或 100,但数据库查询仍可能执行成功,造成越权或逻辑错乱
  • 更糟的是:$request->get('order') 直接拼进 SQL ORDER BY $order,导致 SQL 注入
  • 正确路径是:先取原始值 → 再走验证层(模型 or 单独 validator)→ 验证通过后才赋值给业务变量
  • 轻量场景可用 filter_var($value, FILTER_VALIDATE_INT, ['options' => ['min_range' => 1]]),但注意它不处理 null 或空字符串,得额外判 !empty()

RESTful 控制器里怎么组织参数验证才不啰嗦

别为每个 action 新建一个 Model 类,也别反复 new Validator。推荐复用 ParamsValidateService 这类轻量验证封装,规则动态传入。

  • 规则格式保持和 Model::rules() 一致,例如 [['page', 'size'], 'required']、[['id'], 'integer', 'min' => 1]
  • 关键点:验证前必须把参数“扁平化”——JSON body 要先 Json::decode(),否则 validate() 会跳过嵌套字段
  • 错误收集要用 $model->getErrorSummary(true),它返回一维数组,适合直接塞进 apiError() 响应体
  • 注意兼容性:ParamsValidateModel 继承 ActiveRecord 是为了复用验证框架,但它不连 DB,所以必须重写 attributes() 返回动态字段列表,否则 load() 会静默丢弃未声明属性

容易被忽略的边界:Content-Type 决定你该读哪个方法

前端发 application/json,你还调 $request->post('xxx'),结果一定是 null。这不是 bug,是设计如此。

  • $request->post() 只读 application/x-www-form-urlencoded 和 multipart/form-data 的 body
  • $request->get() 只读 URL query string,不管 content-type
  • JSON 请求必须用 $request->getRawBody() + 手动 Json::decode(),且要捕获 JSON_ERROR_* 异常
  • 混合场景(如表单带文件上传又含 JSON 字段)极难处理,建议拆成两个接口,或统一要求前端用 form-data 传 JSON 字符串再二次解析

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

yii框架 yii

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
PHP API接口开发与RESTful实践
PHP API接口开发与RESTful实践

本专题聚焦 PHP在API接口开发中的应用,系统讲解 RESTful 架构设计原则、路由处理、请求参数解析、JSON数据返回、身份验证(Token/JWT)、跨域处理以及接口调试与异常处理。通过实战案例(如用户管理系统、商品信息接口服务),帮助开发者掌握 PHP构建高效、可维护的RESTful API服务能力。

2025.11.26

524

16

ThinkPHP表单验证与数据安全处理实战
ThinkPHP表单验证与数据安全处理实战

本专题聚焦 ThinkPHP 在表单处理中的验证与安全机制,系统讲解验证器使用、自定义规则、场景验证以及错误提示处理。内容涵盖 XSS 防护、SQL 注入防御、数据过滤与输入校验等关键安全措施。通过实际案例,帮助开发者构建安全可靠的数据处理流程。

2026.03.30

221

20

PHP Yii框架专题
PHP Yii框架专题

本专题专注于PHP主流框架Yii的应用,系统讲解MVC架构、路由机制、数据库操作、表单处理、安全验证与RESTful API 开发等核心内容。通过电商网站、后台管理系统与内容管理平台等实战项目,帮助学员快速掌握Yii框架的开发技巧与实战经验。

2025.09.04

2950

22

Kratos框架Protobuf接口定义与代码生成合集
Kratos框架Protobuf接口定义与代码生成合集

本专题讲解Kratos框架接口定义体系,涵盖proto编写规范、proto add/client/server生成命令、http注解路由、validate校验、OpenAPI文档生成、跨服务proto复用与兼容性设计。

2026.10.10

0

15

C++虚函数怎么定义和调用
C++虚函数怎么定义和调用

C++虚函数是实现运行时多态的重要机制。本专题从virtual关键字的基本用法入手,介绍基类与派生类之间的函数重写、基类指针调用派生类方法,以及动态绑定的执行过程,帮助初学者掌握虚函数的核心语法。

2026.10.10

0

26

C++类与对象的封装方法教程
C++类与对象的封装方法教程

C++封装是面向对象编程的核心特性之一,通过类将数据与操作数据的函数组织在一起,并利用访问权限控制外部访问。本专题介绍类的定义、成员变量、成员函数以及public、private和protected的使用方法,帮助初学者掌握封装的基本原理。

2026.10.10

0

32

C++构造函数定义与调用方法
C++构造函数定义与调用方法

C++构造函数用于初始化类对象,是面向对象编程的重要基础。本专题从构造函数的定义、声明和调用入手,介绍默认构造函数、带参数构造函数、拷贝构造函数及成员初始化列表,帮助初学者掌握对象创建与初始化的基本方法。

2026.10.10

0

16

Kratos框架零基础入门教程
Kratos框架零基础入门教程

本专题整理Kratos框架入门内容,涵盖Go环境准备、kratos CLI安装升级、new命令创建项目、目录结构分层说明、服务启动与双协议端口、依赖下载报错排查,帮助开发者快速跑通第一个Kratos框架微服务应用。

2026.10.10

0

15

C++条件判断语句怎么写
C++条件判断语句怎么写

C++条件判断是控制程序执行流程的重要基础。本专题介绍if、if-else、else if和switch等常见分支语句,结合条件表达式、比较运算符与代码示例,帮助初学者掌握不同场景下的判断逻辑。

2026.10.10

0

13

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2.0框架开发实战视频教程
Yii2.0框架开发实战视频教程

共22课时 | 9.3万人学习

Yii Framework 2.0 API 官方文档
Yii Framework 2.0 API 官方文档

共0课时 | 0人学习