服务器操作和数据变更

服务器操作是在服务器上执行的异步函数。它们可以在服务器组件和客户端组件中调用，用于处理 Next.js 应用程序中的表单提交和数据修改。

🎥 观看： 了解更多关于使用服务器操作进行数据修改 → YouTube (10 分钟)。

约定

服务器操作可以通过 React 的 "use server" 指令定义。你可以将该指令放在 async 函数的顶部以将该函数标记为服务器操作，或者放在单独文件的顶部以将该文件的所有导出标记为服务器操作。

服务器组件

服务器组件可以使用函数级或模块级的 "use server" 指令。要内联服务器操作，在函数体的顶部添加 "use server"：

app/page.tsx

TypeScript

export default function Page() {
  // 服务器操作
  async function create() {
    'use server'
    // 修改数据
  }
 
  return '...'
}

客户端组件

要在客户端组件中调用服务器操作，创建一个新文件并在其顶部添加 "use server" 指令。文件中导出的所有函数都将被标记为可在客户端和服务器组件中重用的服务器操作：

app/actions.ts

TypeScript

'use server'
 
export async function create() {}

app/actions.js

'use server'
 
export async function create() {}

app/ui/button.tsx

TypeScript

'use client'
 
import { create } from '@/app/actions'
 
export function Button() {
  return <button onClick={() => create()}>Create</button>
}

将操作作为 props 传递

你也可以将服务器操作作为 prop 传递给客户端组件：

<ClientComponent updateItemAction={updateItem} />

app/client-component.tsx

TypeScript

'use client'
 
export default function ClientComponent({
  updateItemAction,
}: {
  updateItemAction: (formData: FormData) => void
}) {
  return <form action={updateItemAction}>{/* ... */}</form>
}

通常，Next.js TypeScript 插件会标记 client-component.tsx 中的 updateItemAction，因为函数通常不能在客户端-服务器边界之间序列化。然而，名为 action 或以 Action 结尾的 props 被假定为接收服务器操作。这只是一个启发式方法，因为 TypeScript 插件实际上并不知道它接收的是服务器操作还是普通函数。运行时类型检查仍然会确保你不会意外地将函数传递给客户端组件。

行为

服务器操作可以通过 <form> 元素的 action 属性调用：
- 服务器组件默认支持渐进式增强，这意味着即使 JavaScript 还没有加载或被禁用，表单也能提交。
- 在客户端组件中，如果 JavaScript 还没有加载，调用服务器操作的表单会将提交排队，优先处理客户端水合。
- 水合完成后，浏览器不会在表单提交时刷新。
服务器操作不限于 <form>，还可以在事件处理程序、useEffect、第三方库和其他表单元素（如 <button>）中调用。
服务器操作与 Next.js 的缓存和重新验证架构集成。当操作被调用时，Next.js 可以在单次服务器往返中同时返回更新的 UI 和新数据。
在后台，操作使用 POST 方法，并且只有这个 HTTP 方法可以调用它们。
服务器操作的参数和返回值必须是 React 可序列化的。查看 React 文档了解可序列化的参数和值的列表。
服务器操作是函数。这意味着它们可以在应用程序的任何地方重用。
服务器操作继承它们所在页面或布局的运行时。
服务器操作继承它们所在页面或布局的路由段配置，包括 maxDuration 等字段。

示例

表单

React 扩展了 HTML <form> 元素，允许通过 action 属性调用服务器操作。

当在表单中调用时，操作会自动接收 FormData 对象。你不需要使用 React useState 来管理字段，而是可以使用原生的 FormData 方法来提取数据：

app/invoices/page.tsx

TypeScript

export default function Page() {
  async function createInvoice(formData: FormData) {
    'use server'
 
    const rawFormData = {
      customerId: formData.get('customerId'),
      amount: formData.get('amount'),
      status: formData.get('status'),
    }
 
    // 修改数据
    // 重新验证缓存
  }
 
  return <form action={createInvoice}>...</form>
}

值得注意的是：

示例：带有加载和错误状态的表单

当处理具有多个字段的表单时，你可能需要考虑使用 entries() 方法与 JavaScript 的 Object.fromEntries()。例如：const rawFormData = Object.fromEntries(formData)。需要注意的是，formData 将包含额外的 $ACTION_ 属性。

查看 React <form> 文档了解更多信息。

传递额外参数

你可以使用 JavaScript 的 bind 方法向服务器操作传递额外参数。

app/client-component.tsx

TypeScript

'use client'
 
import { updateUser } from './actions'
 
export function UserProfile({ userId }: { userId: string }) {
  const updateUserWithId = updateUser.bind(null, userId)
 
  return (
    <form action={updateUserWithId}>
      <input type="text" name="name" />
      <button type="submit">更新用户名</button>
    </form>
  )
}

服务器操作将接收 userId 参数，以及表单数据:

app/actions.js

'use server'
 
export async function updateUser(userId, formData) {}

值得注意的是：

另一种方法是将参数作为表单中的隐藏输入字段传递 (例如 <input type="hidden" name="userId" value={userId} />)。但是，这个值将作为渲染的 HTML 的一部分，且不会被编码。

.bind 在服务器和客户端组件中都可以工作。它也支持渐进式增强。

嵌套表单元素

你也可以在 <form> 内部的元素（如 <button>、<input type="submit"> 和 <input type="image">）中调用服务器操作。这些元素接受 formAction 属性或事件处理程序。

这在你想要在表单中调用多个服务器操作的情况下很有用。例如，你可以创建一个特定的 <button> 元素用于保存文章草稿，另外一个用于发布文章。查看 React <form> 文档了解更多信息。

程序化表单提交

你可以使用 requestSubmit() 方法以编程方式触发表单提交。例如，当用户使用 ⌘ + Enter 键盘快捷键提交表单时，你可以监听 onKeyDown 事件：

app/entry.tsx

TypeScript

'use client'
 
export function Entry() {
  const handleKeyDown = (e: React.KeyboardEvent<HTMLTextAreaElement>) => {
    if (
      (e.ctrlKey || e.metaKey) &&
      (e.key === 'Enter' || e.key === 'NumpadEnter')
    ) {
      e.preventDefault()
      e.currentTarget.form?.requestSubmit()
    }
  }
 
  return (
    <div>
      <textarea name="entry" rows={20} required onKeyDown={handleKeyDown} />
    </div>
  )
}

这将触发最近的 <form> 祖先的提交，从而调用服务器操作。

服务器端表单验证

你可以使用 HTML 属性（如 required 和 type="email"）进行基本的客户端表单验证。

对于更高级的服务器端验证，你可以使用像 zod 这样的库在修改数据之前验证表单字段：

app/actions.ts

TypeScript

'use server'
 
import { z } from 'zod'
 
const schema = z.object({
  email: z.string({
    invalid_type_error: '邮箱无效',
  }),
})
 
export default async function createUser(formData: FormData) {
  const validatedFields = schema.safeParse({
    email: formData.get('email'),
  })
 
  // 如果表单数据无效则提前返回
  if (!validatedFields.success) {
    return {
      errors: validatedFields.error.flatten().fieldErrors,
    }
  }
 
  // 修改数据
}

一旦字段在服务器上被验证，你可以在操作中返回一个可序列化的对象，并使用 React useFormState hook 向用户显示消息。

通过将操作传递给 useFormState，操作的函数签名会改变，将接收一个新的 prevState 或 initialState 参数作为其第一个参数。
useFormState 是一个 React hook，因此必须在客户端组件中使用。

app/actions.ts

TypeScript

'use server'
 
import { redirect } from 'next/navigation'
 
export async function createUser(prevState: any, formData: FormData) {
  const res = await fetch('https://...')
  const json = await res.json()
 
  if (!res.ok) {
    return { message: '请输入有效的邮箱' }
  }
 
  redirect('/dashboard')
}

然后，你可以将你的操作传递给 useFormState hook，并使用返回的 state 来显示错误消息。

app/ui/signup.tsx

TypeScript

'use client'
 
import { useFormState } from 'react'
import { createUser } from '@/app/actions'
 
const initialState = {
  message: '',
}
 
export function Signup() {
  const [state, formAction] = useFormState(createUser, initialState)
 
  return (
    <form action={formAction}>
      <label htmlFor="email">邮箱</label>
      <input type="text" id="email" name="email" required />
      {/* ... */}
      <p aria-live="polite">{state?.message}</p>
      <button>注册</button>
    </form>
  )
}

值得注意的是：

这些示例使用了 React 的 useFormState hook，它已经与 Next.js App Router 捆绑在一起。如果你使用 React 19，请使用 useActionState 代替。更多信息请参见 React 文档。

待处理状态

在修改数据之前，你应该始终确保用户有权执行该操作。请参阅身份验证和授权。

useFormStatus hook 暴露了一个 pending 布尔值，可用于在操作执行时显示加载指示器：

app/submit-button.tsx

TypeScript

'use client'
 
import { useFormStatus } from 'react-dom'
 
export function SubmitButton() {
  const { pending } = useFormStatus()
 
  return (
    <button disabled={pending} type="submit">
      注册
    </button>
  )
}

值得注意的是：

在 React 19 中，useFormStatus 在返回的对象上包含额外的键，如 data、method 和 action。如果你没有使用 React 19，只有 pending 键可用。

在 React 19 中，useActionState 在返回的状态上也包含一个 pending 键。

乐观更新

你可以使用 React 的 useOptimistic hook 在服务器操作执行完成之前乐观地更新 UI，而不是等待响应：

app/page.tsx

TypeScript

'use client'
 
import { useOptimistic } from 'react'
import { send } from './actions'
 
type Message = {
  message: string
}
 
export function Thread({ messages }: { messages: Message[] }) {
  const [optimisticMessages, addOptimisticMessage] = useOptimistic
    Message[],
    string
  >(messages, (state, newMessage) => [...state, { message: newMessage }])
 
  const formAction = async (formData) => {
    const message = formData.get('message') as string
    addOptimisticMessage(message)
    await send(message)
  }
 
  return (
    <div>
      {optimisticMessages.map((m, i) => (
        <div key={i}>{m.message}</div>
      ))}
      <form action={formAction}>
        <input type="text" name="message" />
        <button type="submit">发送</button>
      </form>
    </div>
  )
}

事件处理程序

虽然在 <form> 元素中使用服务器操作很常见，但它们也可以通过事件处理程序（如 onClick）调用。例如，要增加点赞数：

app/like-button.tsx

TypeScript

'use client'
 
import { incrementLike } from './actions'
import { useState } from 'react'
 
export default function LikeButton({ initialLikes }: { initialLikes: number }) {
  const [likes, setLikes] = useState(initialLikes)
 
  return (
    <>
      <p>总点赞数：{likes}</p>
      <button
        onClick={async () => {
          const updatedLikes = await incrementLike()
          setLikes(updatedLikes)
        }}
      >
        点赞
      </button>
    </>
  )
}

你也可以给表单元素添加事件处理程序，例如在 onChange 时保存表单字段：

app/ui/edit-post.tsx

'use client'
 
import { publishPost, saveDraft } from './actions'
 
export default function EditPost() {
  return (
    <form action={publishPost}>
      <textarea
        name="content"
        onChange={async (e) => {
          await saveDraft(e.target.value)
        }}
      />
      <button type="submit">发布</button>
    </form>
  )
}

对于这种情况，如果多个事件可能快速连续触发，我们建议使用防抖来防止不必要的服务器操作调用。

`useEffect`

你可以使用 React 的 useEffect hook 在组件挂载或依赖项更改时调用服务器操作。这对于依赖全局事件或需要自动触发的修改很有用。例如，用于应用快捷键的 onKeyDown、用于无限滚动的交集观察器 hook，或在组件挂载时更新查看次数：

app/view-count.tsx

TypeScript

'use client'
 
import { incrementViews } from './actions'
import { useState, useEffect } from 'react'
 
export default function ViewCount({ initialViews }: { initialViews: number }) {
  const [views, setViews] = useState(initialViews)
 
  useEffect(() => {
    const updateViews = async () => {
      const updatedViews = await incrementViews()
      setViews(updatedViews)
    }
 
    updateViews()
  }, [])
 
  return <p>总浏览量：{views}</p>
}

请记住考虑 useEffect 的行为和注意事项。

错误处理

当抛出错误时，它将被最近的 error.js 或 <Suspense> 边界捕获。我们建议使用 try/catch 将错误返回给你的 UI 处理。

例如，你的服务器操作可以通过返回一条消息来处理创建新项目时的错误：

app/actions.ts

'use server'
 
export async function createTodo(prevState: any, formData: FormData) {
  try {
    // 修改数据
  } catch (e) {
    throw new Error('创建任务失败')
  }
}

app/actions.js

'use server'
 
export async function createTodo(prevState, formData) {
  try {
    // 修改数据
  } catch (e) {
    throw new Error('创建任务失败')
  }
}

值得注意的是：

除了抛出错误外，你还可以返回一个对象供 useFormState 处理。请参阅服务器端验证和错误处理。

重新验证数据

你可以使用 revalidatePath API 在服务器操作内重新验证 Next.js 缓存：

app/actions.ts

'use server'
 
import { revalidatePath } from 'next/cache'
 
export async function createPost() {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidatePath('/posts')
}

app/actions.js

'use server'
 
import { revalidatePath } from 'next/cache'
 
export async function createPost() {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidatePath('/posts')
}

或者使用 revalidateTag 通过缓存标签重新验证特定的数据获取：

app/actions.ts

'use server'
 
import { revalidateTag } from 'next/cache'
 
export async function createPost() {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidateTag('posts')
}

app/actions.js

'use server'
 
import { revalidateTag } from 'next/cache'
 
export async function createPost() {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidateTag('posts')
}

重定向

如果你想在服务器操作完成后将用户重定向到不同的路由，可以使用 redirect API。redirect 需要在 try/catch 块之外调用：

app/actions.ts

'use server'
 
import { redirect } from 'next/navigation'
import { revalidateTag } from 'next/cache'
 
export async function createPost(id: string) {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidateTag('posts') // 更新缓存的帖子
  redirect(`/post/${id}`) // 导航到新帖子页面
}

app/actions.js

'use server'
 
import { redirect } from 'next/navigation'
import { revalidateTag } from 'next/cache'
 
export async function createPost(id) {
  try {
    // ...
  } catch (error) {
    // ...
  }
 
  revalidateTag('posts') // 更新缓存的帖子
  redirect(`/post/${id}`) // 导航到新帖子页面
}

Cookies

你可以在服务器操作中使用 cookies API 来 get、set 和 delete cookies：

app/actions.ts

'use server'
 
import { cookies } from 'next/headers'
 
export async function exampleAction() {
  const cookieStore = await cookies()
 
  // 获取 cookie
  cookieStore.get('name')?.value
 
  // 设置 cookie
  cookieStore.set('name', 'Delba')
 
  // 删除 cookie
  cookieStore.delete('name')
}

app/actions.js

'use server'
 
import { cookies } from 'next/headers'
 
export async function exampleAction() {
  // 获取 cookie
  const cookieStore = await cookies()
 
  // 获取 cookie
  cookieStore.get('name')?.value
 
  // 设置 cookie
  cookieStore.set('name', 'Delba')
 
  // 删除 cookie
  cookieStore.delete('name')
}

查看其他示例了解如何从服务器操作中删除 cookies。

安全性

默认情况下，当创建和导出服务器操作时，它会创建一个公共的 HTTP 端点，应该用相同的安全假设和授权检查来对待。这意味着，即使服务器操作或工具函数未在代码的其他地方导入，它仍然是公开访问的。

为了提高安全性，Next.js 具有以下内置功能：

安全的操作 ID： Next.js 创建加密的、不确定的 ID，允许客户端引用和调用服务器操作。这些 ID 会在构建之间定期重新计算以增强安全性。
死代码消除： 未使用的服务器操作（通过其 ID 引用）会从客户端包中删除，以避免第三方的公共访问。

值得注意的是：

ID 是在编译期间创建的，并最多缓存 14 天。当启动新的构建或构建缓存失效时，它们会被重新生成。这种安全性改进减少了在缺少认证层的情况下的风险。但是，你仍然应该将服务器操作视为公共 HTTP 端点。

// app/actions.js
'use server'
 
// 这个操作**在**我们的应用程序中使用，因此 Next.js
// 将创建一个安全的 ID，允许客户端引用
// 和调用服务器操作。
export async function updateUserAction(formData) {}
 
// 这个操作**没有**在我们的应用程序中使用，因此 Next.js
// 将在 `next build` 期间自动删除这段代码
// 并且不会创建公共端点。
export async function deleteUserAction(formData) {}

身份验证和授权

你应该确保用户有权执行该操作。例如：

app/actions.ts

'use server'
 
import { auth } from './lib'
 
export function addItem() {
  const { user } = auth()
  if (!user) {
    throw new Error('你必须登录才能执行此操作')
  }
 
  // ...
}

闭包和加密

在组件内部定义服务器操作会创建一个闭包，使操作可以访问外部函数的作用域。例如，publish 操作可以访问 publishVersion 变量：

app/page.tsx

TypeScript

export default async function Page() {
  const publishVersion = await getLatestVersion();
 
  async function publish() {
    "use server";
    if (publishVersion !== await getLatestVersion()) {
      throw new Error('在点击发布后版本已更改');
    }
    ...
  }
 
  return (
    <form>
      <button formAction={publish}>发布</button>
    </form>
  );
}

闭包在你需要捕获数据（例如 publishVersion）的渲染时刻的快照以便稍后在调用操作时使用时很有用。

然而，为了实现这一点，捕获的变量会被发送到客户端，然后在调用操作时发送回服务器。为防止敏感数据暴露给客户端，Next.js 会自动加密被闭包捕获的变量。每次构建 Next.js 应用程序时都会为每个操作生成一个新的私钥。这意味着操作只能在特定的构建中被调用。

值得注意的是： 我们不建议仅依赖加密来防止敏感值暴露在客户端。相反，你应该使用 React taint API 主动防止特定数据被发送到客户端。

覆盖加密密钥（高级）

当自托管你的 Next.js 应用程序跨多个服务器时，每个服务器实例可能最终会有不同的加密密钥，导致潜在的不一致。

为了缓解这种情况，你可以使用 process.env.NEXT_SERVER_ACTIONS_ENCRYPTION_KEY 环境变量覆盖加密密钥。指定此变量确保你的加密密钥在构建之间保持持久性，并且所有服务器实例使用相同的密钥。

这是一个高级用例，其中跨多个部署的一致加密行为对你的应用程序至关重要。你应该考虑标准安全做法，如密钥轮换和签名。

值得注意的是： 部署到 Vercel 的 Next.js 应用程序会自动处理这个问题。

允许的来源（高级）

由于服务器操作可以在 <form> 元素中调用，这使它们容易受到 CSRF 攻击。

在后台，服务器操作使用 POST 方法，并且只有这个 HTTP 方法可以调用它们。这可以防止现代浏览器中的大多数 CSRF 漏洞，特别是在 SameSite cookies 作为默认设置的情况下。

作为额外的保护，Next.js 中的服务器操作还会比较 Origin header 和 Host header（或 X-Forwarded-Host）。如果这些不匹配，请求将被中止。换句话说，服务器操作只能在托管它的相同主机上调用。

对于使用反向代理或多层后端架构的大型应用程序（其中服务器 API 与生产域不同），建议使用配置选项 serverActions.allowedOrigins 来指定安全来源列表。该选项接受字符串数组。

next.config.js

/** @type {import('next').NextConfig} */
module.exports = {
  experimental: {
    serverActions: {
      allowedOrigins: ['my-proxy.com', '*.my-proxy.com'],
    },
  },
}

了解更多关于服务器操作的安全性。

其他资源

要了解更多信息，请查看以下 React 文档：

服务器操作和数据变更

下一步

serverActions