0

0

Yii2 GridView URL参数优化:自动移除未使用的查询参数

心靈之曲

心靈之曲

发布时间:2025-11-06 13:33:01

|

691人浏览过

|

来源于php中文网

原创

Yii2 GridView URL参数优化:自动移除未使用的查询参数

本教程旨在解决yii2 gridview过滤后url中包含大量空值查询参数的问题。通过修改 `yii.gridview.js` 文件并配置 `assetmanager`,我们可以在不直接修改 `vendor` 目录代码的前提下,实现自动移除url中未填充的参数,从而使url更加简洁、美观且易于管理。

在Yii2应用中,当使用 GridView 组件及其自定义过滤器时,尤其是在存在大量过滤字段的情况下,用户在进行过滤操作后,浏览器地址栏的URL可能会变得非常冗长。例如,即使许多过滤字段没有被填充,它们的参数名依然会出现在URL中,且值为一个小写的 null 或空字符串,如 localhost:20024/consignment?fid=&post_code=&pud2_mrn=&pud2_status=PUDP&pud_status=&pud2_remaining_date=&mrn=&mrn_status=&ioss_number=&declaration_type=&status=&entry_at=&exit_at=&created_at=。这种冗余的URL不仅影响用户体验,也可能对SEO和URL分享造成不便。

为了解决这一问题,我们可以在参数发送到服务器之前,通过修改 GridView 相关的JavaScript逻辑来移除这些空值参数。以下是详细的实现步骤。

1. 复制并修改 yii.gridView.js

由于不建议直接修改 vendor 目录下的核心文件,以避免在项目更新时被覆盖,我们需要将 yii.gridView.js 复制到项目的公共资源目录,并对其进行修改。

操作步骤:

  1. 将 vendor/yiisoft/yii2/assets/yii.gridView.js 文件复制到你的 web 目录下的一个自定义JavaScript文件夹中,例如 web/js/。

  2. 打开复制后的 web/js/yii.gridView.js 文件。

  3. 找到 applyFilter 方法,在该方法内部,定位到 var pos = settings.filterUrl.indexOf('?'); 这一行。

  4. 在这一行代码之前,添加以下JavaScript代码片段:

    $.each(data, function (name, value) { 
        if (value[0].length === 0) {
            data[name] = null; 
        }
    });

    代码解释: 这段代码会遍历 GridView 过滤器发送的所有参数 (data 对象)。对于每个参数,它检查其值(通常是数组的第一个元素 value[0])的长度是否为零。如果长度为零,则表示该参数未被填充,将其值设置为 null。当URL参数被构建时,值为 null 的参数通常会被忽略,从而达到清理URL的目的。

2. 配置 AssetManager 以使用自定义JS文件

完成JavaScript文件的修改后,Yii2仍然会默认加载 vendor 目录下的原始 yii.gridView.js。为了让系统使用我们修改后的版本,需要通过配置 assetManager 来覆盖默认的资源包。

学习导航
学习导航

学习者优质的学习网址导航网站

下载

操作步骤:

  1. 打开你的应用程序配置文件,通常是 config/web.php (或 config/main.php,取决于你的应用结构)。

  2. 在 components 配置数组中,找到或添加 assetManager 组件的配置。

  3. 在 assetManager 的 bundles 数组中,添加对 yii\grid\GridViewAsset 的覆盖配置:

    'assetManager' => [
        'bundles' => [
            'yii\grid\GridViewAsset' => [
                'sourcePath' => '@webroot/js', // 指向你复制的 yii.gridView.js 所在的目录
                'basePath' => '@webroot/js',   // 同上
                'baseUrl' => '@web/js',        // 指向该目录的URL路径
            ],
        ],
    ],

    配置解释:

    • 'yii\grid\GridViewAsset':这是 GridView 组件使用的官方资源包的类名。
    • 'sourcePath' 和 'basePath':指定了 Yii2 应该从哪个物理路径查找 GridViewAsset 相关的源文件。这里我们将其指向 web/js 目录。
    • 'baseUrl':指定了浏览器访问这些资源时的基本URL。

3. 验证与注意事项

完成上述步骤后,刷新你的 GridView 页面并尝试进行过滤操作。你会发现,当某些过滤字段未输入任何值时,它们对应的查询参数将不再出现在URL中,使URL变得更加整洁。

注意事项:

  • 路径准确性: 确保 sourcePath、basePath 和 baseUrl 的配置与你实际存放 yii.gridView.js 的路径完全匹配。
  • 缓存清理: 如果在配置后发现更改未生效,请尝试清理浏览器缓存和Yii2的资产缓存(如果开启了 assetManager 的缓存功能)。
  • 影响范围: 此修改会影响所有使用 GridViewAsset 的 GridView 实例。如果你的应用中存在需要保留空值参数的特殊 GridView 场景,可能需要更细粒度的控制,例如通过JavaScript在特定的 GridView 实例上进行处理,而不是全局覆盖。
  • 版本兼容性: 本教程基于Yii2的常见版本,但未来Yii2核心库的更新可能会对 yii.gridView.js 的内部结构进行调整。如果遇到问题,请检查新版本的文件结构并相应调整代码。

通过这种方法,我们既解决了URL冗余的问题,又遵循了Yii2的开发最佳实践,避免了直接修改 vendor 目录,从而保证了项目的可维护性和升级的便利性。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

236

2023.09.22

java中null的用法
java中null的用法

在Java中,null表示一个引用类型的变量不指向任何对象。可以将null赋值给任何引用类型的变量,包括类、接口、数组、字符串等。想了解更多null的相关内容,可以阅读本专题下面的文章。

458

2024.03.01

js 字符串转数组
js 字符串转数组

js字符串转数组的方法:1、使用“split()”方法;2、使用“Array.from()”方法;3、使用for循环遍历;4、使用“Array.split()”方法。本专题为大家提供js字符串转数组的相关的文章、下载、课程内容,供大家免费下载体验。

298

2023.08.03

js截取字符串的方法
js截取字符串的方法

js截取字符串的方法有substring()方法、substr()方法、slice()方法、split()方法和slice()方法。本专题为大家提供字符串相关的文章、下载、课程内容,供大家免费下载体验。

212

2023.09.04

java基础知识汇总
java基础知识汇总

java基础知识有Java的历史和特点、Java的开发环境、Java的基本数据类型、变量和常量、运算符和表达式、控制语句、数组和字符串等等知识点。想要知道更多关于java基础知识的朋友,请阅读本专题下面的的有关文章,欢迎大家来php中文网学习。

1502

2023.10.24

字符串介绍
字符串介绍

字符串是一种数据类型,它可以是任何文本,包括字母、数字、符号等。字符串可以由不同的字符组成,例如空格、标点符号、数字等。在编程中,字符串通常用引号括起来,如单引号、双引号或反引号。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

624

2023.11.24

java读取文件转成字符串的方法
java读取文件转成字符串的方法

Java8引入了新的文件I/O API,使用java.nio.file.Files类读取文件内容更加方便。对于较旧版本的Java,可以使用java.io.FileReader和java.io.BufferedReader来读取文件。在这些方法中,你需要将文件路径替换为你的实际文件路径,并且可能需要处理可能的IOException异常。想了解更多java的相关内容,可以阅读本专题下面的文章。

633

2024.03.22

php中定义字符串的方式
php中定义字符串的方式

php中定义字符串的方式:单引号;双引号;heredoc语法等等。想了解更多字符串的相关内容,可以阅读本专题下面的文章。

589

2024.04.29

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
PHP课程
PHP课程

共137课时 | 10万人学习

JavaScript ES5基础线上课程教学
JavaScript ES5基础线上课程教学

共6课时 | 11.2万人学习

PHP新手语法线上课程教学
PHP新手语法线上课程教学

共13课时 | 0.9万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号