PyCharm 2025.3 Help

Next.js

PyCharm 集成了 Next.js React 框架。

开始之前

  1. 请确保您的计算机上已安装 Node.js

  2. 请确保在 设置 | 插件 页面、 已安装 选项卡中启用了所需插件 JavaScript and TypeScriptNext.js Support。 有关详细信息,请参阅 管理插件

创建新的 Next.js 应用程序

开始构建新的 Next.js 应用程序的推荐方式是使用 create-next-app 包,PyCharm 将使用 npx 为您下载并运行该包。 这样,您的开发环境将预配置为使用 Next.js。

当然,您仍然可以自行下载 create-next-app ,或创建一个空的 PyCharm 项目并在其中安装 Next.js。

使用 create-next-app 生成 Next.js 应用程序

  1. 欢迎 屏幕上点击 创建新项目 ,或从主菜单中选择 文件 | 新建 | 项目。 将打开 新建 项目 对话框

  2. 在左侧窗格中,选择 Next.js

  3. 在右侧窗格中:

    1. 指定用于存储项目相关文件的文件夹路径。

    2. Node 运行时 字段中,指定要使用的 Node.js 运行时。 从列表中选择一个已配置的运行时,或选择 添加 来配置新的运行时。

    3. create-next-app 列表中,选择 npx create-next-app

      或者,对于 npm 5.1 及更早版本,请在 终端 Alt+F12 中运行 npm install --save-dev next react react-dom ,自行安装 create-next-app 包。 创建应用程序时,选择存储 create-next-app 包的文件夹。

    4. 可选:

      要使用 TypeScript 而非 JavaScript,请选中 使用 TypeScript 模板 复选框。 PyCharm 将为您的应用程序生成 .ts 文件,以及一个 tsconfig.json 配置文件。

  4. 当您点击 创建 时,PyCharm 会生成一个特定于 Next.js 的项目,其中包含所有必需的配置文件,并下载所需的依赖项。 PyCharm 还会创建用于运行或调试您的应用程序的 npm startJavaScript Debug 配置,并使用默认设置。

在空的 PyCharm 项目中安装 Next.js

在这种情况下,您需要自行配置构建流水线。 有关将 Next.js 添加到项目的更多信息,请参阅 Next.js 官方网站

创建空的 PyCharm 项目

  1. 欢迎 屏幕上点击 创建新项目 ,或从主菜单中选择 文件 | 新建 | 项目。 将打开 新建 项目 对话框

  2. 在左侧窗格中,选择 空项目。 在右侧窗格中,指定应用程序文件夹并点击 创建

在空项目中安装 Next.js

  1. 打开将使用 Next.js 的空项目。

  2. 在嵌入的 终端Alt+F12 )中,键入:

    npm install --save-dev next react react-dom

从现有的 Next.js 应用程序开始

要继续开发现有的 Next.js 应用程序,请在 PyCharm 中将其打开并下载所需依赖项。

打开已在您计算机上的应用程序源代码

  • 欢迎 屏幕的左侧窗格中点击 打开 ,或从主菜单中选择 文件 | 打开。 在打开的对话框中,选择存储源代码的文件夹。

从您的版本控制中检出应用程序源代码

  1. 欢迎 屏幕的左侧窗格中点击 克隆

    或者,从主菜单中选择 文件 | 新建 | 来自版本控制的项目…Git | 克隆…VCS | 从版本控制获取

    主菜单中可能不会显示 Git ,您可能会看到与您的项目关联的其他版本控制系统。 例如, MercurialPerforce

  2. 在打开的对话框中,从列表中选择您的版本控制系统,并指定要从中检出应用程序源代码的存储库。 有关详细信息,请参阅 检出项目(克隆)

下载依赖项

  • 在弹出窗口中点击 运行 'npm install'运行 'yarn install'

    打开应用程序并下载依赖项

    您可以使用 npmYarn 1Yarn 2 ,详细信息请参阅 npm 和 Yarn

  • 或者,在编辑器中或在 项目 工具窗口 Alt+1 中,从 package.json 的上下文菜单中选择 运行 'npm install'运行 'yarn install'

项目安全性

当您打开一个在 PyCharm 之外创建并导入到其中的项目时,PyCharm 会显示一个对话框,您可以在其中决定如何处理该包含不熟悉的源代码的项目。

不受信任的项目警告

请选择以下选项之一:

  • 在安全模式下预览 :在这种情况下,PyCharm 以预览模式打开项目。 这意味着您可以浏览项目源代码,但无法运行任务和脚本,或运行/调试您的项目。

    PyCharm 会在编辑器区域顶部显示通知,您可以随时点击 信任项目… 链接以加载您的项目。

  • 信任项目 :在这种情况下,PyCharm 会打开并加载项目。 这意味着项目已初始化、项目的插件已解析、依赖项已添加,并且所有 PyCharm 功能均可用。

  • 不打开 :在这种情况下,PyCharm 不会打开该项目。

了解详情,请参阅 项目安全性

运行并调试 Next.js 应用程序

在 PyCharm 中,您可以通过两种方式运行应用程序并启动调试会话:

  • 从编辑器—将 next dev 命令作为脚本从 package.json 运行,或在 终端 中运行。 然后在 运行 工具窗口或 终端 中点击应用程序 URL,以启动调试会话。

  • 使用运行/调试配置

从编辑器开始运行和调试

使用 next dev 运行应用程序

  1. Сlick 运行图标 package.json dev 脚本旁的装订区域,或在 终端 Alt+F12 中执行 next dev 命令,或者双击 dev 任务,在 npm 工具窗口视图 | 工具窗口 | npm )中。

    从 package.json 运行 next dev
  2. 等待应用程序编译完成并且开发服务器已就绪。

    运行 工具窗口或 终端 显示您的应用程序运行的 URL,默认 URL 为 http://localhost:3000

    带有应用链接的运行工具窗口

    点击此链接在浏览器中查看应用程序。

从运行工具窗口或终端启动调试会话

  1. 设置断点 (根据需要)。

  2. Сlick 运行图标 package.json dev 脚本旁的装订区域,或在 终端 Alt+F12 中执行 next dev 命令,或者双击 dev 任务,在 npm 工具窗口视图 | 工具窗口 | npm )中。

  3. 等待应用程序编译完成并且开发服务器已就绪。

    运行 工具窗口或 终端 显示您的应用程序运行的 URL,默认 URL 为 http://localhost:3000

    从运行工具窗口启动调试会话

    按住 Ctrl+Shift 并点击该链接。

  4. 当应用程序在浏览器中打开时,执行触发程序执行的操作,例如点击链接。 焦点切换到 PyCharm,并打开 调试工具窗口

    调试会话已启动

    继续照常进行: 逐步执行程序停止并恢复程序执行、 在挂起时进行检查 、浏览调用堆栈和变量、设置监视、计算变量、 查看实际 HTML DOM ,等等。

使用运行/调试配置运行并调试 Next.js 应用程序

当您打开一个单存储库项目,且在根 package.json 中将 next 包列为依赖项时,PyCharm 会自动生成两个运行/调试配置:

  • Next.js:服务器端 ,类型为 npm。 该配置会执行 next dev 命令,启动开发服务器,并在开发模式下运行您的应用程序。

  • Next.js:客户端调试 ,类型为 JavaScript Debug ,用于在浏览器中调试您的应用程序。

生成了两个运行/调试配置

创建运行/调试配置

  1. 转到 运行 | 编辑配置。 或者,从工具栏上的 运行 小部件中选择 编辑配置

    打开编辑配置对话框

    在打开的 编辑配置 对话框中,点击工具栏上的 添加 按钮(添加按钮 ),并从列表中选择 npm

  2. 在打开的 运行/调试配置:npm 对话框的 配置 选项卡中,指定 package.json 的位置、要使用的 Node.js 运行时以及包管理器。

    命令 字段中,从列表中选择 run ,然后在 脚本 列表中选择要运行的脚本。 很可能是默认的 dev 脚本,但您可以在您的 package.json 中配置其他脚本,例如在自定义端口上运行应用程序。

    npm 运行/调试配置
  3. 可选:

    要在浏览器中打开应用程序,请按如下方式更新配置:在 浏览器 / 实时编辑 选项卡中,选中 启动后 复选框,选择用于打开应用程序的浏览器,并指定应用程序将运行的 URL 地址。

    浏览器 / Live Edit 选项卡:选择浏览器

使用 npm 运行/调试配置在开发模式下运行应用程序

  1. 在工具栏上的 运行 小部件的列表中,选择类型为 npm 的运行配置。 这可以是自动生成的 Next.js:服务器端 配置,或您自己创建的自定义配置, 如上所述

    通过运行/调试配置在开发模式下运行 Next.js 应用程序

    点击 运行图标

  2. 当应用程序编译完成并且开发服务器已就绪, 运行 工具窗口显示您的应用程序运行的 URL。 默认 URL 为 http://localhost:3000 ,然而如果默认端口 3000 已被占用,服务器会尝试在最接近的空闲端口上启动。

    在开发模式下运行 Next.js 应用程序:开发服务器已就绪

    点击此链接查看应用程序。

    或者,启用 PyCharm 在启动时打开应用程序 如上所述

使用 JavaScript Debug 配置开始调试

  1. 设置断点 (根据需要)。

  2. 运行您的应用程序在开发模式下 使用 npm 运行/调试配置使用 next dev

  3. 当应用程序编译完成并且开发服务器已就绪, 运行 工具窗口显示您的应用程序运行的 URL。 默认 URL 为 http://localhost:3000 ,然而如果默认端口 3000 已被占用,服务器会尝试在最接近的空闲端口上启动。

  4. 在工具栏上的 运行 小部件的列表中,选择类型为 JavaScript 调试 的运行配置。 这可以是自动生成的 Next.js:客户端调试 配置,或您自己创建的自定义配置, 如上所述

    开始调试会话 — 选择 JavaScript Debug 运行配置

    点击 调试图标

  5. 当应用程序在浏览器中打开时,执行触发程序执行的操作,例如点击链接。 焦点切换到 PyCharm,并打开 调试工具窗口

    继续照常进行: 逐步执行程序停止并恢复程序执行、 在挂起时进行检查 、浏览调用堆栈和变量、设置监视、计算变量、 查看实际 HTML DOM ,等等。

请参阅 运行 React 应用程序调试 React 应用程序

最后修改日期: 2025年 12月 2日