跳到内容

11

添加搜索和分页

在前一章中，您通过流式处理改进了仪表板的初始加载性能。现在让我们继续到 /invoices 页面，并学习如何添加搜索和分页。

本章内容...

以下是我们将涵盖的主题

学习如何使用 Next.js API：useSearchParams、usePathname 和 useRouter。

使用 URL 搜索参数实现搜索和分页。

起始代码

在您的 /dashboard/invoices/page.tsx 文件中，粘贴以下代码

/app/dashboard/invoices/page.tsx
import Pagination from '@/app/ui/invoices/pagination';
import Search from '@/app/ui/search';
import Table from '@/app/ui/invoices/table';
import { CreateInvoice } from '@/app/ui/invoices/buttons';
import { lusitana } from '@/app/ui/fonts';
import { InvoicesTableSkeleton } from '@/app/ui/skeletons';
import { Suspense } from 'react';
 
export default async function Page() {
  return (
    <div className="w-full">
      <div className="flex w-full items-center justify-between">
        <h1 className={`${lusitana.className} text-2xl`}>Invoices</h1>
      </div>
      <div className="mt-4 flex items-center justify-between gap-2 md:mt-8">
        <Search placeholder="Search invoices..." />
        <CreateInvoice />
      </div>
      {/*  <Suspense key={query + currentPage} fallback={<InvoicesTableSkeleton />}>
        <Table query={query} currentPage={currentPage} />
      </Suspense> */}
      <div className="mt-5 flex w-full justify-center">
        {/* <Pagination totalPages={totalPages} /> */}
      </div>
    </div>
  );
}

花一些时间熟悉页面和您将要使用的组件

  1. <Search/> 允许用户搜索特定发票。
  2. <Pagination/> 允许用户在发票页面之间导航。
  3. <Table/> 显示发票。

您的搜索功能将跨越客户端和服务器。当用户在客户端搜索发票时，URL 参数将被更新，数据将在服务器上获取，并且表格将在服务器上使用新数据重新渲染。

为什么使用 URL 搜索参数？

如上所述，您将使用 URL 搜索参数来管理搜索状态。如果您习惯于使用客户端状态来完成此操作，则此模式可能是新的。

使用 URL 参数实现搜索有几个好处

  • 可书签和共享的 URL：由于搜索参数位于 URL 中，用户可以为将来参考或共享而将应用程序的当前状态（包括其搜索查询和过滤器）加入书签。
  • 服务器端渲染：URL 参数可以直接在服务器上使用以渲染初始状态，从而更容易处理服务器渲染。
  • 分析和跟踪：将搜索查询和过滤器直接放在 URL 中可以更轻松地跟踪用户行为，而无需额外的客户端逻辑。

添加搜索功能

以下是您将用于实现搜索功能的 Next.js 客户端 Hook

  • useSearchParams - 允许您访问当前 URL 的参数。例如，此 URL /dashboard/invoices?page=1&query=pending 的搜索参数将如下所示：{page: '1', query: 'pending'}。
  • usePathname - 让您读取当前 URL 的路径名。例如，对于路由 /dashboard/invoices，usePathname 将返回 '/dashboard/invoices'。
  • useRouter - 允许您以编程方式在客户端组件中的路由之间导航。您可以使用多种方法。

以下是实现步骤的快速概述

  1. 捕获用户的输入。
  2. 使用搜索参数更新 URL。
  3. 使 URL 与输入字段保持同步。
  4. 更新表格以反映搜索查询。

1. 捕获用户的输入

进入 <Search> 组件 (/app/ui/search.tsx)，您会注意到

  • "use client" - 这是一个客户端组件，这意味着您可以使用事件监听器和 Hook。
  • <input> - 这是搜索输入框。

创建一个新的 handleSearch 函数，并向 <input> 元素添加一个 onChange 监听器。每当输入值更改时，onChange 将调用 handleSearch。

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
 
export default function Search({ placeholder }: { placeholder: string }) {
  function handleSearch(term: string) {
    console.log(term);
  }
 
  return (
    <div className="relative flex flex-1 flex-shrink-0">
      <label htmlFor="search" className="sr-only">
        Search
      </label>
      <input
        className="peer block w-full rounded-md border border-gray-200 py-[9px] pl-10 text-sm outline-2 placeholder:text-gray-500"
        placeholder={placeholder}
        onChange={(e) => {
          handleSearch(e.target.value);
        }}
      />
      <MagnifyingGlassIcon className="absolute left-3 top-1/2 h-[18px] w-[18px] -translate-y-1/2 text-gray-500 peer-focus:text-gray-900" />
    </div>
  );
}

通过打开浏览器开发者工具中的控制台，然后在搜索字段中键入内容，验证它是否正常工作。您应该在浏览器控制台中看到搜索词。

太棒了！您正在捕获用户的搜索输入。现在，您需要使用搜索词更新 URL。

2. 使用搜索参数更新 URL

从 next/navigation 导入 useSearchParams Hook 并将其分配给一个变量

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
import { useSearchParams } from 'next/navigation';
 
export default function Search() {
  const searchParams = useSearchParams();
 
  function handleSearch(term: string) {
    console.log(term);
  }
  // ...
}

在 handleSearch 内部，使用新的 searchParams 变量创建一个新的 URLSearchParams 实例。

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
import { useSearchParams } from 'next/navigation';
 
export default function Search() {
  const searchParams = useSearchParams();
 
  function handleSearch(term: string) {
    const params = new URLSearchParams(searchParams);
  }
  // ...
}

URLSearchParams 是一个 Web API，它提供了用于操作 URL 查询参数的实用方法。您可以使用它来获取参数字符串，例如 ?page=1&query=a，而不是创建复杂的字符串文字。

接下来，根据用户的输入 set 参数字符串。如果输入为空，则需要 delete 它

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
import { useSearchParams } from 'next/navigation';
 
export default function Search() {
  const searchParams = useSearchParams();
 
  function handleSearch(term: string) {
    const params = new URLSearchParams(searchParams);
    if (term) {
      params.set('query', term);
    } else {
      params.delete('query');
    }
  }
  // ...
}

现在您有了查询字符串。您可以使用 Next.js 的 useRouter 和 usePathname Hook 来更新 URL。

从 'next/navigation' 导入 useRouter 和 usePathname，并在 handleSearch 内部使用 useRouter() 中的 replace 方法

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
import { useSearchParams, usePathname, useRouter } from 'next/navigation';
 
export default function Search() {
  const searchParams = useSearchParams();
  const pathname = usePathname();
  const { replace } = useRouter();
 
  function handleSearch(term: string) {
    const params = new URLSearchParams(searchParams);
    if (term) {
      params.set('query', term);
    } else {
      params.delete('query');
    }
    replace(`${pathname}?${params.toString()}`);
  }
}

以下是正在发生的事情的细分

  • ${pathname} 是当前路径，在您的情况下是 "/dashboard/invoices"。
  • 当用户在搜索栏中键入内容时，params.toString() 会将此输入转换为 URL 友好的格式。
  • replace(${pathname}?${params.toString()}) 使用用户的搜索数据更新 URL。例如，如果用户搜索“Lee”，则为 /dashboard/invoices?query=lee。
  • 由于 Next.js 的客户端导航（您在关于页面之间导航的章节中了解到的），URL 会更新而无需重新加载页面。

3. 使 URL 和输入保持同步

为了确保输入字段与 URL 同步，并在共享时填充，您可以传递一个 defaultValue 给输入，方法是从 searchParams 读取

/app/ui/search.tsx
<input
  className="peer block w-full rounded-md border border-gray-200 py-[9px] pl-10 text-sm outline-2 placeholder:text-gray-500"
  placeholder={placeholder}
  onChange={(e) => {
    handleSearch(e.target.value);
  }}
  defaultValue={searchParams.get('query')?.toString()}
/>

defaultValue 与 value / 受控与非受控

如果您使用状态来管理输入的值，您将使用 value 属性使其成为受控组件。这意味着 React 将管理输入的状态。

但是，由于您没有使用状态，因此可以使用 defaultValue。这意味着原生输入将管理其自身的状态。这没问题，因为您正在将搜索查询保存到 URL 而不是状态。

4. 更新表格

最后，您需要更新表格组件以反映搜索查询。

导航回发票页面。

页面组件接受名为 searchParams 的 prop，因此您可以将当前 URL 参数传递给 <Table> 组件。

/app/dashboard/invoices/page.tsx
import Pagination from '@/app/ui/invoices/pagination';
import Search from '@/app/ui/search';
import Table from '@/app/ui/invoices/table';
import { CreateInvoice } from '@/app/ui/invoices/buttons';
import { lusitana } from '@/app/ui/fonts';
import { Suspense } from 'react';
import { InvoicesTableSkeleton } from '@/app/ui/skeletons';
 
export default async function Page(props: {
  searchParams?: Promise<{
    query?: string;
    page?: string;
  }>;
}) {
  const searchParams = await props.searchParams;
  const query = searchParams?.query || '';
  const currentPage = Number(searchParams?.page) || 1;
 
  return (
    <div className="w-full">
      <div className="flex w-full items-center justify-between">
        <h1 className={`${lusitana.className} text-2xl`}>Invoices</h1>
      </div>
      <div className="mt-4 flex items-center justify-between gap-2 md:mt-8">
        <Search placeholder="Search invoices..." />
        <CreateInvoice />
      </div>
      <Suspense key={query + currentPage} fallback={<InvoicesTableSkeleton />}>
        <Table query={query} currentPage={currentPage} />
      </Suspense>
      <div className="mt-5 flex w-full justify-center">
        {/* <Pagination totalPages={totalPages} /> */}
      </div>
    </div>
  );
}

如果您导航到 <Table> 组件，您会看到两个 prop query 和 currentPage 被传递给 fetchFilteredInvoices() 函数，该函数返回与查询匹配的发票。

/app/ui/invoices/table.tsx
// ...
export default async function InvoicesTable({
  query,
  currentPage,
}: {
  query: string;
  currentPage: number;
}) {
  const invoices = await fetchFilteredInvoices(query, currentPage);
  // ...
}

完成这些更改后，继续测试一下。如果您搜索一个术语，您将更新 URL，这将向服务器发送新的请求，数据将在服务器上获取，并且只会返回与您的查询匹配的发票。

何时使用 useSearchParams() Hook 与 searchParams prop？

您可能已经注意到您使用了两种不同的方法来提取搜索参数。您使用哪种方法取决于您是在客户端还是服务器上工作。

  • <Search> 是一个客户端组件，因此您使用 useSearchParams() Hook 从客户端访问参数。
  • <Table> 是一个服务器组件，它获取自己的数据，因此您可以将 searchParams prop 从页面传递到组件。

作为一般规则，如果您想从客户端读取参数，请使用 useSearchParams() Hook，因为这避免了必须返回服务器。

最佳实践：防抖

恭喜！您已经使用 Next.js 实现了搜索！但是您可以做一些事情来优化它。

在您的 handleSearch 函数内部，添加以下 console.log

/app/ui/search.tsx
function handleSearch(term: string) {
  console.log(`Searching... ${term}`);
 
  const params = new URLSearchParams(searchParams);
  if (term) {
    params.set('query', term);
  } else {
    params.delete('query');
  }
  replace(`${pathname}?${params.toString()}`);
}

然后在搜索栏中键入“Delba”并检查开发工具中的控制台。发生了什么？

开发工具控制台
Searching... D
Searching... De
Searching... Del
Searching... Delb
Searching... Delba

您正在每次击键时更新 URL，因此每次击键时都查询数据库！由于我们的应用程序很小，这不是问题，但是想象一下，如果您的应用程序有数千个用户，每个用户在每次击键时都向您的数据库发送新请求。

防抖是一种编程实践，它限制了函数触发的速率。在我们的例子中，您只想在用户停止键入时查询数据库。

防抖的工作原理

  1. 触发事件：当应该防抖的事件（例如搜索框中的击键）发生时，计时器启动。
  2. 等待：如果在计时器到期之前发生新事件，则计时器将重置。
  3. 执行：如果计时器到达倒计时的末尾，则执行防抖函数。

您可以使用多种方法实现防抖，包括手动创建自己的防抖函数。为了简单起见，我们将使用一个名为 use-debounce 的库。

安装 use-debounce

终端
pnpm i use-debounce

在您的 <Search> 组件中，导入一个名为 useDebouncedCallback 的函数

/app/ui/search.tsx
// ...
import { useDebouncedCallback } from 'use-debounce';
 
// Inside the Search Component...
const handleSearch = useDebouncedCallback((term) => {
  console.log(`Searching... ${term}`);
 
  const params = new URLSearchParams(searchParams);
  if (term) {
    params.set('query', term);
  } else {
    params.delete('query');
  }
  replace(`${pathname}?${params.toString()}`);
}, 300);

此函数将包装 handleSearch 的内容，并且仅在用户停止键入（300 毫秒）后经过特定时间后才运行代码。

现在再次在搜索栏中键入内容，并在开发工具中打开控制台。您应该看到以下内容

开发工具控制台
Searching... Delba

通过防抖，您可以减少发送到数据库的请求数量，从而节省资源。

添加分页

引入搜索功能后，您会注意到表格一次只显示 6 张发票。这是因为 data.ts 中的 fetchFilteredInvoices() 函数每页最多返回 6 张发票。

添加分页允许用户浏览不同的页面以查看所有发票。让我们看看如何像搜索一样使用 URL 参数来实现分页。

导航到 <Pagination/> 组件，您会注意到它是一个客户端组件。您不希望在客户端获取数据，因为这会暴露您的数据库密钥（请记住，您没有使用 API 层）。相反，您可以在服务器上获取数据，并将其作为 prop 传递给组件。

在 /dashboard/invoices/page.tsx 中，导入一个名为 fetchInvoicesPages 的新函数，并将 searchParams 中的 query 作为参数传递

/app/dashboard/invoices/page.tsx
// ...
import { fetchInvoicesPages } from '@/app/lib/data';
 
export default async function Page(
  props: {
    searchParams?: Promise<{
      query?: string;
      page?: string;
    }>;
  }
) {
  const searchParams = await props.searchParams;
  const query = searchParams?.query || '';
  const currentPage = Number(searchParams?.page) || 1;
  const totalPages = await fetchInvoicesPages(query);
 
  return (
    // ...
  );
}

fetchInvoicesPages 返回基于搜索查询的总页数。例如，如果有 12 张发票与搜索查询匹配，并且每页显示 6 张发票，则总页数将为 2。

接下来，将 totalPages prop 传递给 <Pagination/> 组件

/app/dashboard/invoices/page.tsx
// ...
 
export default async function Page(props: {
  searchParams?: Promise<{
    query?: string;
    page?: string;
  }>;
}) {
  const searchParams = await props.searchParams;
  const query = searchParams?.query || '';
  const currentPage = Number(searchParams?.page) || 1;
  const totalPages = await fetchInvoicesPages(query);
 
  return (
    <div className="w-full">
      <div className="flex w-full items-center justify-between">
        <h1 className={`${lusitana.className} text-2xl`}>Invoices</h1>
      </div>
      <div className="mt-4 flex items-center justify-between gap-2 md:mt-8">
        <Search placeholder="Search invoices..." />
        <CreateInvoice />
      </div>
      <Suspense key={query + currentPage} fallback={<InvoicesTableSkeleton />}>
        <Table query={query} currentPage={currentPage} />
      </Suspense>
      <div className="mt-5 flex w-full justify-center">
        <Pagination totalPages={totalPages} />
      </div>
    </div>
  );
}

导航到 <Pagination/> 组件并导入 usePathname 和 useSearchParams Hook。我们将使用它来获取当前页面并设置新页面。确保也取消注释此组件中的代码。由于您尚未实现 <Pagination/> 逻辑，因此您的应用程序将暂时中断。让我们现在就做！

/app/ui/invoices/pagination.tsx
'use client';
 
import { ArrowLeftIcon, ArrowRightIcon } from '@heroicons/react/24/outline';
import clsx from 'clsx';
import Link from 'next/link';
import { generatePagination } from '@/app/lib/utils';
import { usePathname, useSearchParams } from 'next/navigation';
 
export default function Pagination({ totalPages }: { totalPages: number }) {
  const pathname = usePathname();
  const searchParams = useSearchParams();
  const currentPage = Number(searchParams.get('page')) || 1;
 
  // ...
}

接下来，在 <Pagination> 组件内部创建一个名为 createPageURL 的新函数。与搜索类似，您将使用 URLSearchParams 来设置新的页码，并使用 pathName 来创建 URL 字符串。

/app/ui/invoices/pagination.tsx
'use client';
 
import { ArrowLeftIcon, ArrowRightIcon } from '@heroicons/react/24/outline';
import clsx from 'clsx';
import Link from 'next/link';
import { generatePagination } from '@/app/lib/utils';
import { usePathname, useSearchParams } from 'next/navigation';
 
export default function Pagination({ totalPages }: { totalPages: number }) {
  const pathname = usePathname();
  const searchParams = useSearchParams();
  const currentPage = Number(searchParams.get('page')) || 1;
 
  const createPageURL = (pageNumber: number | string) => {
    const params = new URLSearchParams(searchParams);
    params.set('page', pageNumber.toString());
    return `${pathname}?${params.toString()}`;
  };
 
  // ...
}

以下是正在发生的事情的细分

  • createPageURL 创建当前搜索参数的实例。
  • 然后，它将“page”参数更新为提供的页码。
  • 最后，它使用路径名和更新的搜索参数构造完整的 URL。

<Pagination> 组件的其余部分处理样式和不同状态（第一页、最后一页、活动页、禁用页等）。我们不会在本课程中详细介绍，但您可以随意查看代码以了解 createPageURL 在哪里被调用。

最后，当用户键入新的搜索查询时，您希望将页码重置为 1。您可以通过更新 <Search> 组件中的 handleSearch 函数来执行此操作

/app/ui/search.tsx
'use client';
 
import { MagnifyingGlassIcon } from '@heroicons/react/24/outline';
import { usePathname, useRouter, useSearchParams } from 'next/navigation';
import { useDebouncedCallback } from 'use-debounce';
 
export default function Search({ placeholder }: { placeholder: string }) {
  const searchParams = useSearchParams();
  const { replace } = useRouter();
  const pathname = usePathname();
 
  const handleSearch = useDebouncedCallback((term) => {
    const params = new URLSearchParams(searchParams);
    params.set('page', '1');
    if (term) {
      params.set('query', term);
    } else {
      params.delete('query');
    }
    replace(`${pathname}?${params.toString()}`);
  }, 300);

总结

恭喜！您刚刚使用 URL 搜索参数和 Next.js API 实现了搜索和分页。

总结一下，在本章中

  • 您已经使用 URL 搜索参数而不是客户端状态处理了搜索和分页。
  • 您已经在服务器上获取了数据。
  • 您正在使用 useRouter 路由器 Hook 进行更流畅的客户端过渡。

这些模式与您在客户端 React 中使用的模式不同，但希望您现在更好地理解了使用 URL 搜索参数并将此状态提升到服务器的好处。

您已完成章节11

您的仪表板现在具有搜索和分页功能！

下一步

12：修改数据

学习如何使用服务器操作修改数据。

开始第 12 章