Adonis.js TypeScript 应用创建与配置教程

1. 项目的目录结构及介绍

Adonis.js 是一个强大的 Node.js 框架，用于快速开发现代的、可维护的 HTTP 应用程序。以下是基于 create-adonis-ts-app 模板创建的 Adonis.js TypeScript 应用的目录结构及其说明：

项目名称/
├── app/                           # 应用核心代码存放目录
│   ├── controllers/              # 控制器目录
│   ├── models/                   # 数据模型目录
│   ├── services/                 # 服务类目录
│   └── utils/                    # 工具类目录
├── database/                     # 数据库相关文件目录
│   ├── schema/                   # 数据库迁移文件目录
│   └── seeds/                    # 数据库种子文件目录
├── public/                       # 静态文件目录
├── resources/                    # 资源文件目录
│   ├── assets/                   # 静态资源文件，如CSS、JS等
│   ├── views/                    # 视图文件目录
│   └── locales/                  # 国际化资源文件目录
├── routes/                       # 路由文件目录
├── config/                       # 配置文件目录
├── scripts/                      # 脚本文件目录
├── src/                          # 源代码目录
│   ├── entrypoint.ts             # 应用程序入口文件
│   └── server.ts                 # HTTP 服务器配置文件
├── .env                          # 环境变量配置文件
├── .gitignore                    # Git 忽略文件
├── package.json                  # 项目配置文件
└── tsconfig.json                 # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动文件主要位于 src/entrypoint.ts 和 src/server.ts。

• src/entrypoint.ts：这是 Adonis.js 应用程序的入口文件。它负责初始化 Adonis.js 应用程序并启动 HTTP 服务器。

import { createApp } from '@adonisjs/core'
import { Ignitor } from '@adonisjs/core/build/ignitor'

const app = new Ignitor(__dirname).create()

app.booting(() => {
  // 应用启动时的初始化代码
})

app.ready(() => {
  // 应用启动并准备就绪后的代码
})

app|--------------------------------------------------------------------------
| HTTP Server
|--------------------------------------------------------------------------
|
| This is where we define our HTTP server settings. AdonisJS makes use of
| Node.js HTTP servers, so configuration here would be the same as in
|
| Node.js: https://nodejs.org/api/http.html#http_http_createserver_options_callback
|
*/
app.http.server()
  . supervision()
  . start(process.env.PORT || 3333)

• src/server.ts：该文件负责配置 HTTP 服务器，如端口、中间件、路由等。

import { Server } from '@adonisjs/core/server'

export default function (server: Server) {
  server.afterMiddleware('logger')

  // 定义路由
  server.route(() => {
    Route.get('/', 'Home.index')
  })
}

3. 项目的配置文件介绍

Adonis.js 的配置文件位于 config/ 目录中，主要包括以下文件：

• config/app.ts：应用程序的基本配置，如应用名称、环境等。
• config/database.ts：数据库连接配置，包括数据库类型、连接字符串、迁移等。
• config/http.ts：HTTP 服务器配置，包括端口、中间件、路由等。
• config/server.ts：Node.js 服务器配置，如信任代理、超时设置等。

以下是 config/app.ts 的示例配置：

import { ConfigContract } from '@adonisjs/core/types'

const config: ConfigContract = {
  appKey: 'app_key',
  http: {
    port: process.env.PORT || 3333,
    host: process.env.HOST || '0.0.0.0',
  },
  // 其他配置...
}

export default config

通过以上介绍，您应该对 Adonis.js TypeScript 应用的目录结构、启动文件和配置文件有了基本的了解。接下来，您可以开始进行具体的开发工作。