React

关注公众号 jb51net

关闭
首页 > 网络编程 > JavaScript > javascript类库 > React > react19 setSearchParams

react19中setSearchParams的5种传参实现

作者:朝阳39

本文深入讲解setSearchParams的5种传参写法,包括如何用回调保留原有参数,以及replace配置避免历史记录堆积,掌握这些技巧,轻松实现分页、筛选和搜索功能,告别手动编码和页面跳转的坑

一、基础介绍

import { useSearchParams } from 'react-router-dom'
// 解构:searchParams读取参数,setSearchParams修改URL查询参数
const [searchParams, setSearchParams] = useSearchParams()

作用:原地修改当前页面 ? 后的查询参数,不跳转新页面,组件自动重渲染

二、5种传参写法

1. 传对象(最常用,简单场景)

直接传键值对,会完全覆盖原有所有参数

// URL 变为 /?if_login=true&name=朝阳
setSearchParams({
  if_login: 'true',
  name: '测试&首页' // 内部自动编码
})

2. 回调函数写法(保留原有参数,分页/筛选必备)

重点!直接传对象会清空旧参数;用回调可以基于当前参数修改、保留其他参数

// 当前URL:/?if_login=true&sort=price
setSearchParams(prev => {
  // prev 是原始 searchParams 对象(URLSearchParams)
  prev.set('page', '2') // 新增/修改page,保留if_login、sort
  prev.set('name', '朝阳')
  return prev
})
// 结果:/?if_login=true&sort=price&page=2&name=%E6%9C%9D%E9%98%B3

常用操作:

setSearchParams(prev => {
  prev.set('page', 1) // 修改
  prev.delete('sort') // 删除某个参数
  return prev
})

3. 传 URLSearchParams 实例

适合复杂多参数批量处理

const params = new URLSearchParams()
params.set('if_login', 'true')
params.set('name', '朝阳')
setSearchParams(params)

4. 传查询字符串

setSearchParams("if_login=true&name=朝阳")
setSearchParams("?if_login=true&name=朝阳") // 带?也兼容

5. 传二维数组(支持同一个key多个值)

setSearchParams([
  ['page', '1'],
  ['tag', 'react'],
  ['tag', 'router']
])
// ?page=1&tag=react&tag=router

三、第二个配置参数 { replace: true }

默认:修改参数会新增一条历史记录,点返回会回到上一个参数状态
replace: true:替换当前历史记录,回退直接跳上一页(分页、筛选推荐)

// 替换模式,不增加历史栈
setSearchParams({ page: 3 }, { replace: true })

// 回调搭配replace
setSearchParams(prev => {
  prev.set('page', 3)
  return prev
}, { replace: true })

四、实战完整示例(贴合你之前的 name=朝阳 案例)

import { useSearchParams } from 'react-router-dom'

export default function Page() {
  const [searchParams, setSearchParams] = useSearchParams()
  
  // 读取参数,自动解码
  const name = searchParams.get('name')
  const isLogin = searchParams.get('if_login')

  // 按钮修改参数(保留原有其他参数)
  const updateQuery = () => {
    setSearchParams(prev => {
      prev.set('if_login', 'true')
      prev.set('name', '测试&首页') // 自动编码特殊符号
      return prev
    }, { replace: true })
  }

  // 清空所有参数
  const clearQuery = () => setSearchParams({})

  return (
    <div>
      <p>name参数:{name}</p>
      <button onClick={updateQuery}>设置参数 if_login & name</button>
      <button onClick={clearQuery}>清空所有查询参数</button>
    </div>
  )
}

五、核心坑点(必看)

坑1:直接传对象会清空全部旧参数

// 当前地址 ?a=1&b=2
setSearchParams({ c: 3 })
// 结果:?c=3  a、b直接消失!

✅ 解决:用回调函数 (prev) => {} 操作原有参数

坑2、编解码完全内置,无需手动处理

坑3、所有值最终都会转为字符串

数字、布尔传入会变成字符串:

setSearchParams({ page: 2 })
searchParams.get('page') // "2" 字符串,不是数字

坑4、删除参数方式

// 方式1:回调delete(推荐,保留其他参数)
setSearchParams(prev => {
  prev.delete('name')
  return prev
})
// 方式2:重新传对象覆盖(会清空其他参数)
setSearchParams({ if_login: 'true' })

六、对比 navigate 修改参数

  1. navigate(/?page=2)
    • 完整跳转,新增历史记录
    • 必须手动拼接字符串,自己处理编码
  2. setSearchParams({page:2})
    • 原地更新URL,组件刷新
    • 内置编解码,可保留旧参数、可替换历史
      分页、筛选、搜索框联动优先用 setSearchParams

七、配合 Object.fromEntries 一键获取所有参数

const [searchParams] = useSearchParams()
const query = Object.fromEntries(searchParams)
console.log(query.name, query.if_login)

到此这篇关于react19中setSearchParams的5种传参实现的文章就介绍到这了,更多相关react19 setSearchParams内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:
阅读全文