Algolia InstantSearch 在 Next.js 中自动清除 URL 参数问题解析与解决方案

问题背景

在使用 Algolia 的 InstantSearch 库（版本 7.12.3）与 Next.js 应用路由结合时，开发者可能会遇到一个棘手的问题：URL 中的查询参数会被自动清除。这种情况特别容易发生在使用 Google Tag Manager（GTM）等第三方工具时，当 URL 中包含如 ?gtm_debug=1724106408152 这样的参数时，这些非搜索相关的参数会被 InstantSearch 的路由机制意外移除。

问题本质

InstantSearch 默认会管理 URL 状态以实现搜索状态的持久化和分享功能。其内部的路由机制会监控并控制 URL 中的搜索相关参数（如查询词、过滤条件等）。然而，这种机制默认会"清理"URL，移除它认为与搜索无关的所有参数，导致开发者添加的自定义参数丢失。

技术原理

InstantSearch 的路由系统通过 stateMapping 配置项来控制 URL 状态与搜索状态之间的转换。默认情况下，它会：

1. 从 URL 中提取搜索相关的状态
2. 忽略其他所有参数
3. 在更新 URL 时只保留搜索状态

这种设计虽然保证了搜索功能的纯净性，但却牺牲了与其他系统集成的灵活性。

解决方案

要解决这个问题，我们需要自定义 stateMapping 行为，明确告诉 InstantSearch 哪些参数需要保留。以下是完整的解决方案：

function cleanState<TIndexUiState extends IndexUiState>(
  uiState: TIndexUiState
): TIndexUiState {
  // 保留除configure外的所有搜索状态，同时显式保留gtm_debug参数
  const { configure, ...trackedUiState } = uiState;
  return trackedUiState as TIndexUiState;
}

const routing = {
  stateMapping: {
    stateToRoute(uiState: UiState) {
      // 从当前URL获取需要保留的参数
      const gtm_debug = new URLSearchParams(location.search).get("gtm_debug");
      
      return Object.keys(uiState).reduce(
        (state, indexId) => ({
          ...state,
          [indexId]: cleanState(uiState[indexId]),
        }),
        {
          // 将需要保留的参数添加到路由状态
          gtm_debug,
        } as UiState
      );
    },
    routeToState(routeState = {} as UiState) {
      return Object.keys(routeState).reduce(
        (state, indexId) => ({
          ...state,
          [indexId]: cleanState(routeState[indexId]),
        }),
        {} as UiState
      );
    },
  },
};

然后在 InstantSearch 组件中使用这个自定义路由配置：

<InstantSearchNext
  searchClient={searchClient}
  indexName={indexName}
  routing={routing}
  future={{ preserveSharedStateOnUnmount: true }}
>
  {/* 其他组件 */}
</InstantSearchNext>

实现细节解析

1. cleanState函数：负责过滤掉不需要同步到URL的搜索状态（如configure），同时保留其他状态。

2. stateToRoute方法：将UI状态转换为路由状态时，主动从当前URL中提取需要保留的参数，并将其包含在返回的状态对象中。

3. routeToState方法：从路由状态还原UI状态时，同样确保只处理搜索相关的状态，避免污染UI状态。

4. TypeScript类型：使用泛型和类型断言确保类型安全，同时保持灵活性。

扩展应用

这个解决方案不仅适用于 gtm_debug 参数，可以轻松扩展以支持其他需要保留的参数：

// 定义需要保留的参数名列表
const PRESERVED_PARAMS = ['gtm_debug', 'utm_source', 'ref'];

// 修改stateToRoute方法
stateToRoute(uiState: UiState) {
  const preservedParams = PRESERVED_PARAMS.reduce((acc, param) => {
    const value = new URLSearchParams(location.search).get(param);
    return value ? { ...acc, [param]: value } : acc;
  }, {});
  
  return {
    ...Object.keys(uiState).reduce((state, indexId) => ({
      ...state,
      [indexId]: cleanState(uiState[indexId]),
    }), {}),
    ...preservedParams
  };
}

最佳实践建议

1. 明确参数用途：区分搜索参数和系统参数，避免命名冲突。

2. 文档记录：在团队内部记录哪些参数需要特殊处理。

3. 测试验证：确保在页面刷新、前进/后退导航等场景下参数都能正确保留。

4. 性能考虑：如果需要保留大量参数，注意评估对性能的影响。

总结

Algolia InstantSearch 的默认路由行为虽然简化了搜索状态管理，但在复杂应用中可能过于激进。通过自定义 stateMapping，我们可以精细控制URL参数的保留与清除，实现搜索功能与其他系统的和谐共存。这种解决方案不仅适用于Next.js，也可以应用于其他使用InstantSearch的React框架。