AdonisJS 中文文档

主题

REPL ​

与 Node.js REPL 一样，AdonisJS 提供了一个应用程序感知的 REPL，可从命令行与应用程序交互。您可以使用 node ace repl 命令启动 REPL 会话。

sh
node ace repl

在标准 Node.js REPL 之上，AdonisJS 提供以下功能。

  • 导入和执行 TypeScript 文件。
  • 导入容器服务（如 router、helpers、hash 服务等）的快捷方法。
  • 使用 IoC 容器创建类实例的快捷方法。
  • 可扩展的 API，用于添加自定义方法和 REPL 命令。

与 REPL 交互 ​

启动 REPL 会话后，您将看到一个交互式提示，您可以在其中编写有效的 JavaScript 代码并按回车键执行。代码的输出将打印在下一行。

如果您想输入多行代码，可以通过输入 .editor 命令进入编辑器模式。按 Ctrl+D 执行多行语句或 Ctrl+C 取消并退出编辑器模式。

sh
> (js) .editor
# // 进入编辑器模式 (Ctrl+D 完成, Ctrl+C 取消)

访问上次执行命令的结果 ​

如果您忘记将语句的值赋给变量，可以使用 _ 变量访问它。例如：

sh
> (js) helpers.string.generateRandom(32)
# 'Z3y8QQ4HFpYSc39O2UiazwPeKYdydZ6M'
> (js) _
# 'Z3y8QQ4HFpYSc39O2UiazwPeKYdydZ6M'
> (js) _.length
# 32
> (js)

访问上次执行命令引发的错误 ​

您可以使用 _error 变量访问上一个命令引发的异常。例如：

sh
> (js) helpers.string.generateRandom()
> (js) _error.message
# 'The value of "size" is out of range. It must be >= 0 && <= 2147483647. Received NaN'

搜索历史记录 ​

REPL 历史记录保存在用户主目录中的 .adonisjs_v6_repl_history 文件中。

您可以通过按向上箭头 ↑ 键循环浏览历史记录中的命令，或按 Ctrl+R 在历史记录中搜索。

退出 REPL 会话 ​

您可以通过输入 .exit 或按两次 Ctrl+C 退出 REPL 会话。AdonisJS 将在关闭 REPL 会话之前执行优雅关闭。

此外，如果您修改了代码库，必须退出并重新启动 REPL 会话才能使新更改生效。

导入模块 ​

Node.js 不允许在 REPL 会话中使用 import 语句。因此，您必须使用动态 import 函数并将输出赋给变量。例如：

ts
const { default: User } = await import('#models/user')

您可以使用 importDefault 方法访问默认导出，而无需解构导出。

ts
const User = await importDefault('#models/user')

助手方法 ​

助手方法是您可以执行以执行特定操作的快捷函数。您可以使用 .ls 命令查看可用方法列表。

sh
> (js) .ls

# GLOBAL METHODS:
importDefault         返回模块的默认导出
make                  使用 "container.make" 方法创建类实例
loadApp               在 REPL 上下文中加载 "app" 服务
loadEncryption        在 REPL 上下文中加载 "encryption" 服务
loadHash              在 REPL 上下文中加载 "hash" 服务
loadRouter            在 REPL 上下文中加载 "router" 服务
loadConfig            在 REPL 上下文中加载 "config" 服务
loadTestUtils         在 REPL 上下文中加载 "testUtils" 服务
loadHelpers           在 REPL 上下文中加载 "helpers" 模块
clear                 从 REPL 上下文中清除属性
p                     Promise 化函数。类似于 Node.js "util.promisify"

向 REPL 添加自定义方法 ​

您可以使用 repl.addMethod 向 REPL 添加自定义方法。该方法接受名称作为第一个参数，实现回调作为第二个参数。

为了演示，让我们创建一个预加载文件并定义一个方法来从 ./app/models 目录导入所有模型。

sh
node ace make:preload repl -e=repl
ts
// title: start/repl.ts
import app from '@adonisjs/core/services/app'
import repl from '@adonisjs/core/services/repl'
import { fsImportAll } from '@adonisjs/core/helpers'

repl.addMethod('loadModels', async () => {
  const models = await fsImportAll(app.makePath('app/models'))
  repl.server!.context.models = models

  repl.notify('已导入模型。您可以使用 "models" 属性访问它们')
  repl.server!.displayPrompt()
})

您可以将以下选项作为第三个参数传递给 repl.addMethod 方法。

  • description：在帮助输出中显示的人类可读描述。
  • usage：定义方法使用的代码片段。如果未设置，将使用方法名称。

完成后，您可以重新启动 REPL 会话并执行 loadModels 方法以导入所有模型。

sh
node ace repl

# 输入 ".ls" 以查看可用上下文方法/属性列表
> (js) await loadModels()