# @adonisjs/framework 中文文档

规范地址：https://npmcn.com/package/%40adonisjs/framework/

版本：5\.0\.13
npm 元数据更新时间：2023-05-08T04:48:29.082Z
中文译文更新时间：2026-11-05T21:02:09.666Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40adonisjs/framework
原文对照：https://npmcn.com/package/%40adonisjs/framework/?lang=original
项目主页：https://github.com/adonisjs/adonis-framework#readme
源码仓库：https://github.com/adonisjs/adonis-framework

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：214 kB，53 个文件
- 模块格式：CommonJS
- TypeScript 类型：未声明
- 运行依赖：24 个
- 首次发布：2017-06-21T17:36:28.150Z
- 最新版本发布：2019-02-16T13:25:59.154Z
- 近 30 天下载量：21898（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：45（近 12 个月 0 个）

## 中文简介

Adonis 框架使您很容易用更少的代码写出 Webapps

## 安装

```sh
npm install @adonisjs/framework
```

也可以使用：`pnpm add @adonisjs/framework`、`yarn add @adonisjs/framework`、`bun add @adonisjs/framework`

## README

# 阿多尼斯框架: 三相通 规则:

这个repo包含了AdonisJs框架的核心模块. 您必须在官方网站上查看源代码或API docs以学习更多.

  

* * *

  

[![NPM Version](https://img.shields.io/npm/v/@adonisjs/framework.svg?style=flat-square)](https://npmjs.org/package/@adonisjs/framework) [![Build Status](https://img.shields.io/travis/adonisjs/adonis-framework/master.svg?style=flat-square)](https://travis-ci.org/adonisjs/adonis-framework) [![Appveyor](https://img.shields.io/appveyor/ci/thetutlage/adonis-framework/master.svg?style=flat-square)](https://ci.appveyor.com/project/thetutlage/adonis-framework) [![Coveralls](https://img.shields.io/coveralls/adonisjs/adonis-framework/develop.svg?style=flat-square)](https://coveralls.io/github/adonisjs/adonis-framework) [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework?ref=badge_shield) [![Pr's Welcome](https://img.shields.io/badge/PRs%20-welcome-brightgreen.svg)](https://adonisjs.com/docs/contribution-guide)

![](https://res.cloudinary.com/adonisjs/image/upload/q_100/v1497112678/adonis-purple_pzkmzt.svg)

## 盒子里装的是什么?

此 repo 包含以下提供者 .

1.  路由器
2.  请求回复( R)
3.  Http 服务器
4.  配置
5.  信封
6.  视图
7.  静态文件中端软件
8.  吸气模块
9.  加密器
10.  锁定器
11.  例外处理器

## 节点/操作系统目标

此回波/ 分支应该可以运行在所有主要OS平台和目标上 `Node.js >= 8.0.0`

## 发展

赞! 如果你们计划为该框架作出贡献,确保遵守以下公约,因为一贯的守则基础总是令人高兴.

运行以下命令以查看可用的 npm 脚本列表 .

```
npm run
```

### 测试( L)

1.  用标准J来解码 运行 `npm run lint` 命令以检查是否有折叠出错.
2.  确保您为所有更改/出错修正写入测试 .
3.  你也可以写 **回归测试**显示有些东西正在失败 但不会破坏建筑 这其实是一个很好的方式 来显示一些失败。 返回测试使用 `test.failing()` 方法.
4.  确保所有测试都通过 `travis` 财务报告和审定财务报表 `appveyor`。 。 。 .

### 一般做法

既然Es6已经进入,你应该努力使用最新的特性. 例如:

1.  使用 `Spread` 结束 `arguments` 关键词.
2.  永远不要使用 `bind` 或者说 `call`在调用这些方法后,我们无法保证任何方法的范围,在AdonisJs代码库中,我们不会超越方法的范围.
3.  一定要写好文件.

## 问题和公关

如果我们在制造问题或公关时努力遵循某些做法,总是有帮助的,因为这将节省每个人的时间.

1.  找到错误时总是尝试创建回归测试( 如果可能) .
2.  分享一些关于你试图做什么的背景, 有足够的代码来复制这个问题.
3.  对于一般问题,请创建论坛线.
4.  在为一个功能创建 PR 时, 确保为 docs 创建并行 PR .

## 回归测试

后退测试是测试,它表明一个代码片段在特定情况下是如何失败的,但是在失败后美也一样,测试套件永远不会失败. 其实是通知虫子的好方法 但要确保一切都是绿色的.

回归测试是使用

```
test.failing('2 + 2 is always 4, but add method returns 6', (assert) => {
 assert.true(add(2, 2), 4)
})
```

现在,自从 `add` 方法有错误, 它会返回 `6` 改为 `4`但建筑会过去的.

## 许可证

[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fadonisjs%2Fadonis-framework?ref=badge_large)

## 常见问题

### @adonisjs/framework 是什么？

Adonis 框架使您很容易用更少的代码写出 Webapps

### 如何安装 @adonisjs/framework？

在项目目录运行 npm install @adonisjs/framework，或使用 pnpm add / yarn add / bun add。它还提供命令行工具 framework，可以用 npx framework 直接运行。

### @adonisjs/framework 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/adonisjs\_\_framework 是否存在。

### @adonisjs/framework 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @adonisjs/framework 可以商用吗？

@adonisjs/framework 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @adonisjs/framework 的下载量有多少？

根据 npm 官方下载统计，@adonisjs/framework 在 2026/10/05 – 2026/11/03 这 30 天内被下载 21,898 次，日均约 730 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @adonisjs/framework 还在维护吗？

最新版本 5\.0\.13 发布于 2019/02/16（7 年前）；至今共发布 45 个版本，其中过去 12 个月发布了 0 个；首次发布于 2017/06/22。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。