Symfony 8.2接收JSON查询筛选条件,用MapQueryString映射并校验DTO

夜辰君_3231

夜辰君_3231

2026-11-18

586人浏览

原创

symfony 8.2可以用mapquerystring的key选项,将某一个查询参数内的json映射为dto,同时保留原有验证规则。适用于已经安装frameworkbundle、serializer和validator的8.2测试应用;本文以8.2.0-beta2源码为依据,php要求至少8.4.1。它不是把整个请求体改成json,也不会在未设置key时自动解析所有查询值。

先定义筛选对象

示例将term设为必填,category可省略。将文件放入应用的常规src目录,并保持App命名空间自动加载配置有效:

<?php // src/Dto/SearchDto.php
namespace App\Dto;
use Symfony\Component\Validator\Constraints as Assert;
final readonly class SearchDto
{
    public function __construct(
        #[Assert\NotBlank] public string $term = '',
        public string $category = '',
    ) {}
}

让控制器读取search参数

控制器映射search这一项,而不是整个查询字符串。示例显式将约束验证失败设置为422,避免与MapQueryString默认的404混淆:

<?php // src/Controller/ProductSearchController.php
namespace App\Controller;
use App\Dto\SearchDto;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Attribute\MapQueryString;
use Symfony\Component\Routing\Attribute\Route;
final class ProductSearchController extends AbstractController
{
    #[Route('/products', name: 'product_search', methods: ['GET'], format: 'json')]
    public function __invoke(
        #[MapQueryString(key: 'search', validationFailedStatusCode: Response::HTTP_UNPROCESSABLE_ENTITY)]
        SearchDto $search,
    ): JsonResponse {
        return $this->json(['term' => $search->term, 'category' => $search->category]);
    }
}

Symfony官方MapQueryString命名JSON参数说明

官方公告展示数组式和JSON式查询映射到同一对象。

发送前由客户端做URL编码

在本地测试应用使用实际监听地址。以下curl命令通过data-urlencode编码参数,避免手工拼接引号、空格和特殊字符:

curl -G 'http://127.0.0.1:8000/products'   --data-urlencode 'search={"term":"keyboard","category":"accessories"}' 

按上方控制器,成功请求应得到包含term与category的JSON对象。数组式参数search[term]和search[category]仍可映射到同一个DTO;业务方法无需分别实现两套筛选逻辑。

Mailtrap Node.js SDK 用于事务性和沙盒电子邮件
Mailtrap Node.js SDK 用于事务性和沙盒电子邮件

一个基于官方 Mailtrap Node.js SDK 构建的 ASE 技能,用于发送事务邮件并与 Mailtrap 沙盒或生产流程协作。它非常适合需要 API 驱动邮件投递、测试邮箱验证和结构化消息自动化的代理工作流。

下载

Symfony8.2文档中的查询映射校验状态和key设置

官方8.2文档的浏览器翻译视图,说明默认404和自定义验证状态。

区分JSON解码与约束验证

用畸形JSON测试时,应返回400;当前文档还将传入对象未定义属性列为400情况。传入合法JSON但term为空时,NotBlank约束失败,按示例配置返回422。完整参数缺失或类型不符时,还要核对参数默认值与映射配置,不能把所有异常都归为JSON格式错误。

若请求仍提示期望array却收到string,先核对实际安装的http-kernel及相关组件是否包含8.2实现,而不是只改项目根目录的版本描述。此能力对应PR64368,已于8月合入8.2并存在于BETA2标签中;11月17日是功能介绍日期。

相关文章

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

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

下载

相关标签:

symfony js json

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

相关专题

更多
PHP Symfony框架
PHP Symfony框架

本专题专注于PHP主流框架Symfony的学习与应用,系统讲解路由与控制器、依赖注入、ORM数据操作、模板引擎、表单与验证、安全认证及API开发等核心内容。通过企业管理系统、内容管理平台与电商后台等实战案例,帮助学员全面掌握Symfony在企业级应用开发中的实践技能。

2025.09.11

6597

17

json数据格式
json数据格式

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

2023.08.07

2375

5

json是什么
json是什么

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

2023.08.23

3942

1

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

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

2023.10.13

1296

3

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

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

2025.09.10

4579

7

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Symfony 官方文档
Symfony 官方文档

共0课时 | 0人学习

Composer手册
Composer手册

共0课时 | 0人学习

Symfony5【从0开始开发博客系统】
Symfony5【从0开始开发博客系统】

共120课时 | 16.1万人学习