Yii2表单验证错误信息封装JSON实现

梦芳吖_7581

梦芳吖_7581

2026-08-21

711人浏览

原创

yii2 api场景下需将表单验证错误转为json响应:显式调用validate(),失败时用422状态码返回扁平化errors(取各字段首个错误),可封装formaterrors()处理,并在控制器统一拦截输出。

yii2表单验证错误信息封装json实现

Yii2 表单验证失败时,默认返回的是 HTML 页面或重定向,但在前后端分离或 API 场景下,需要将验证错误以 JSON 格式统一返回,便于前端解析展示。核心思路是捕获 Model::validate() 的结果,将 $model->errors 结构转换为扁平、语义清晰的 JSON 响应。

统一拦截验证失败并转为 JSON

在控制器中,不直接调用 $model->save()(它会自动 validate),而是显式验证,并手动控制响应格式:

  • 调用 $model->validate() 触发规则校验
  • 检查 $model->hasErrors() 判断是否出错
  • 若出错,用 yii\helpers\Json::encode() 将错误结构标准化输出,并设置 HTTP 状态码为 422(Unprocessable Entity)

示例代码:

public function actionCreate()
{
    $model = new Post();
    if ($model->load(Yii::$app->request->post()) && $model->validate()) {
        if ($model->save()) {
            return $this->asJson(['success' => true, 'data' => $model->attributes]);
        }
    }

    // 验证失败:返回结构化错误
    if ($model->hasErrors()) {
        Yii::$app->response->setStatusCode(422);
        return $this->asJson([
            'success' => false,
            'errors' => $this->formatErrors($model->errors)
        ]);
    }
}

规范错误字段结构(key → message)

Yii2 默认的 $model->errors 是二维数组:['title' => ['标题不能为空', '标题长度不能超过20']]。前端通常更希望是扁平 key-value 形式,例如:{"title": "标题不能为空"}(取每字段首个错误)。可封装一个辅助方法:

jm-jsjkxyjs02-pzl-803
jm-jsjkxyjs02-pzl-803

查询全球任意城市的实时天气和未来天气预报

下载
  • 遍历 $errors,对每个属性取 $errors[$attribute][0]
  • 支持自定义 message 拼接(如加前缀“请填写”)
  • 避免空字段或 null 错误干扰

参考 formatErrors() 实现:

protected function formatErrors($errors)
{
    $result = [];
    foreach ($errors as $attribute => $msgs) {
        if (!empty($msgs)) {
            $result[$attribute] = is_array($msgs) ? reset($msgs) : $msgs;
        }
    }
    return $result;
}

全局处理(适用于 RESTful 应用)

若项目大量使用 API,可在 behaviors() 中配置 ContentNegotiator 和自定义 beforeAction 统一拦截验证异常:

  • 重写 beforeAction(),在 ActiveForm 或模型 save 失败时提前终止流程
  • 监听 yii\base\ModelEvent::EVENT_BEFORE_VALIDATE 不推荐;更稳妥的是在控制器层统一出口处理
  • 配合 yii\rest\Controller 时,可继承并覆盖 afterAction() 对验证失败做响应修正

前端接收与提示建议

返回的 JSON 示例:

{
  "success": false,
  "errors": {
    "title": "标题不能为空",
    "content": "内容必须至少10个字符"
  }
}

前端可直接遍历 response.errors,按字段 ID 插入对应 <span class="error"></span> 提示,无需解析嵌套结构。注意保留原始字段名(如 user[username] 这类复合名需在模型中用 formName() 或自定义场景处理)。

相关文章

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

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

下载

相关标签:

yii2 js json yii

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

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

2023.08.07

1955

5

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.23

2562

1

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

2023.10.13

896

3

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

2025.09.10

2859

7

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

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

2026.03.30

161

20

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

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

2025.09.04

2730

22

Vibeknow在线使用入口合集
Vibeknow在线使用入口合集

本专题汇总了Vibeknow在线创作视频的官方入口及网页版使用教程,涵盖PPT、PDF、Word等文档一键转讲解视频的核心操作,并整理了免费版水印规则与手机端浏览器访问指南,助你快速将知识内容视频化。

2026.09.21

0

20

NumPy随机数文件读写与dtype数据类型
NumPy随机数文件读写与dtype数据类型

本专题整理 NumPy 随机数、文件读写与 dtype 数据类型相关教程,覆盖 Generator/random、随机数种子、正态分布采样、npy/npz/CSV/TXT 保存读取、loadtxt/savetxt、memmap、大文件处理、astype 类型转换、结构化 dtype、整数溢出和精度丢失等场景。

2026.09.21

0

24

NumPy矩阵运算与线性代数计算
NumPy矩阵运算与线性代数计算

本专题整理 NumPy 矩阵运算与线性代数计算相关教程,覆盖矩阵乘法、dot 与 @ 运算符、逆矩阵、行列式、特征值与特征向量、SVD、线性方程组、欧氏距离、矩阵分解和大规模矩阵性能优化等内容,帮助读者掌握 np.linalg 与矩阵计算实战。

2026.09.21

0

20

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Yii2中文手册
Yii2中文手册

共0课时 | 0.6万人学习

thinkphp基础介绍和yii2基础介绍
thinkphp基础介绍和yii2基础介绍

共10课时 | 2.5万人学习

Yii2框架基础视频教程
Yii2框架基础视频教程

共22课时 | 2.8万人学习