Elysia 项目教程

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

Elysia 项目的目录结构如下：

elysia/
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   └── index.ts
├── config/
│   └── config.ts
├── public/
├── tests/
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• src/: 项目的源代码目录，包含所有 TypeScript 文件。

  • controllers/: 存放控制器文件，处理 HTTP 请求和响应。
  • models/: 存放数据模型文件，定义数据结构和数据库操作。
  • routes/: 存放路由文件，定义 API 路由和处理逻辑。
  • services/: 存放服务文件，处理业务逻辑。
  • index.ts: 项目的入口文件，启动服务器。

• config/: 存放配置文件，如数据库连接配置等。

  • config.ts: 配置文件，定义项目的环境变量和配置项。

• public/: 存放静态资源文件，如图片、CSS、JavaScript 等。

• tests/: 存放测试文件，用于单元测试和集成测试。

• package.json: 项目的依赖管理文件，定义项目依赖和脚本。

• tsconfig.json: TypeScript 配置文件，定义 TypeScript 编译选项。

• README.md: 项目的说明文档，介绍项目的基本信息和使用方法。

2. 项目的启动文件介绍

项目的启动文件是 src/index.ts。该文件是整个项目的入口点，负责启动服务器并初始化应用。

src/index.ts 文件内容概述

import { Elysia } from 'elysia';
import { config } from '../config/config';

const app = new Elysia();

app.get('/', () => 'Hello Elysia');

app.listen(config.port, () => {
  console.log(`Server is running on http://localhost:${config.port}`);
});

启动文件功能介绍

• 导入依赖: 导入 Elysia 框架和配置文件。
• 创建应用实例: 使用 Elysia 创建应用实例 app。
• 定义路由: 定义根路由 /，返回 "Hello Elysia"。
• 启动服务器: 使用 app.listen 方法启动服务器，监听配置文件中定义的端口。

3. 项目的配置文件介绍

项目的配置文件是 config/config.ts。该文件定义了项目的环境变量和配置项，如服务器端口、数据库连接信息等。

config/config.ts 文件内容概述

export const config = {
  port: process.env.PORT || 3000,
  database: {
    host: process.env.DB_HOST || 'localhost',
    port: process.env.DB_PORT || 5432,
    name: process.env.DB_NAME || 'elysia_db',
    user: process.env.DB_USER || 'elysia_user',
    password: process.env.DB_PASSWORD || 'elysia_password',
  },
};

配置文件功能介绍

• 端口配置: 定义服务器监听的端口，默认值为 3000。
• 数据库配置: 定义数据库连接信息，包括主机、端口、数据库名称、用户名和密码。
• 环境变量: 使用 process.env 获取环境变量，如果没有定义则使用默认值。

通过以上配置文件，项目可以根据不同的环境（如开发、测试、生产）加载不同的配置，确保应用的灵活性和可扩展性。