React InstantSearch 在 Next.js 应用路由中的 hydration 问题解析

在 Next.js 应用中使用 React InstantSearch 时，开发者可能会遇到一个特殊的 hydration 错误，这个错误与 __isArtificial 标志有关。本文将深入分析这个问题的成因，并提供几种解决方案。

问题背景

当开发者在 Next.js 应用路由中使用 React InstantSearch 的 <NoResultsBoundary> 组件时，可能会遇到客户端和服务器端渲染不一致的问题。核心问题在于 results.__isArtificial 标志在服务器端存在，但在客户端却消失了。

技术原理

React InstantSearch 使用 __isArtificial 标志来区分真实的搜索结果和人工构造的结果。这个标志主要用于防止在没有返回任何命中结果时显示"无结果"消息。

在 Next.js 的 SSR 环境中，服务器端渲染时会生成带有 __isArtificial 标志的初始结果对象。然而，当客户端接管渲染时，如果这个标志不存在，就会导致 hydration 不匹配的错误。

解决方案分析

方案一：强制等待实际结果

通过引入任意一个 InstantSearch 的 hook（如 useSearchBox），可以确保组件等待实际的搜索结果，而不是使用初始的人工结果。这种方法虽然有效，但略显 hacky。

const SearchNoResultsBoundary = ({ children, fallback }) => {
  useSearchBox(); // 强制等待实际结果
  
  const { results } = useInstantSearch();

  if (!results.__isArtificial && results.nbHits === 0) {
    return (
      <>
        {fallback}
        <div hidden>{children}</div>
      </>
    );
  }

  return children;
};

方案二：完善自定义搜索客户端

更规范的解决方案是在自定义搜索客户端中明确设置 __isArtificial 标志。当检测到空查询时，返回的结果对象应包含这个标志。

const searchClient = {
  ...algoliaClient,
  search(requests) {
    if (requests.every(({ params }) => !params.query)) {
      return Promise.resolve({
        results: requests.map(() => ({
          hits: [],
          nbHits: 0,
          // 其他必要字段...
          __isArtificial: true // 明确设置标志
        }))
      });
    }
    return algoliaClient.search(requests);
  }
};

最佳实践建议

1. 一致性是关键：确保服务器端和客户端返回的结果结构完全一致，包括所有标志性字段。

2. 合理使用人工结果：只在确实需要时才使用人工构造的结果，并确保所有必要的标志都已设置。

3. 考虑渲染时机：理解 InstantSearch 各 hook 的行为差异，useInstantSearch 不会等待实际结果，而 widget-specific hooks 会。

4. 类型安全：在使用 TypeScript 时，为结果对象定义明确的类型，包括 __isArtificial 这样的内部标志。

总结

React InstantSearch 在 Next.js 应用中的 hydration 问题通常源于服务器端和客户端渲染结果的不一致。通过理解 InstantSearch 的内部工作机制，开发者可以采取适当的措施确保渲染一致性。无论是强制等待实际结果还是完善自定义搜索客户端，都能有效解决这类问题。选择哪种方案取决于具体应用场景和团队偏好。