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 来覆盖默认的资源包。

VidAU
VidAU

VidAU AI 是一款AI驱动的数字人视频创作平台,旨在简化视频内容创作流程

下载

操作步骤:

  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 目录,从而保证了项目的可维护性和升级的便利性。

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2788

2023.09.01

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

1687

2023.10.11

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

1548

2023.10.11

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

1036

2023.10.23

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

1485

2023.10.23

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

1256

2023.11.03

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1569

2023.11.09

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

1307

2023.11.13

菜鸟裹裹入口以及教程汇总
菜鸟裹裹入口以及教程汇总

本专题整合了菜鸟裹裹入口地址及教程分享,阅读专题下面的文章了解更多详细内容。

0

2026.01.22

热门下载

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

精品课程

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

共137课时 | 9.2万人学习

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

共6课时 | 10万人学习

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

共13课时 | 0.9万人学习

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

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