TypeORM-Extension 项目启动与配置教程

1. 项目目录结构及介绍

typeorm-extension 项目采用清晰的目录结构来组织代码，以下是项目的主要目录和文件说明：

• src/

  • 项目源代码存放目录。
  • entities/: 存放实体（Entity）定义的目录。
  • repositories/: 存放数据仓库（Repository）的目录。
  • services/: 业务逻辑（Service）相关的代码。
  • controllers/: 控制器（Controller）相关的代码。
  • middlewares/: 中间件（Middleware）相关的代码。
  • config/: 配置文件存放目录。
  • models/: 可能包含与实体相关的模型（Model）代码。
  • views/: 视图（View）或模板文件存放目录。
  • index.ts: 项目入口文件，用于引导程序启动。

• test/

  • 测试代码存放目录。
  • 包含对项目各个模块的单元测试和集成测试。

• dist/

  • 编译后的代码目录，通常用于生产环境。

• node_modules/

  • 项目依赖的第三方库和模块。

• package.json

  • 定义了项目的依赖、脚本和元数据。

• tsconfig.json

  • TypeScript 配置文件，定义了编译规则和配置。

• README.md

  • 项目说明文件，通常包含项目介绍、安装步骤、使用说明等。

2. 项目的启动文件介绍

项目的启动文件位于 src/index.ts，以下是启动文件的基本结构：

import { createConnection } from 'typeorm';
import { AppServer } from './AppServer';

async function main() {
  const appServer = new AppServer();
  await appServer.init();
  await appServer.start();
}

main().catch((error) => {
  console.error('启动失败:', error);
  process.exit(1);
});

在这里，首先导入 typeorm 的 createConnection 方法来创建数据库连接，然后实例化 AppServer 类并调用 init() 和 start() 方法来初始化和启动服务器。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，通常包含以下配置：

• database.config.ts: 数据库配置文件，定义了数据库连接的参数，例如：

export default {
  type: 'postgres',
  host: 'localhost',
  port: 5432,
  username: 'typeorm',
  password: 'password',
  database: 'typeorm',
  entities: [__dirname + '/entities/**/*{.ts,.js}'],
  synchronize: true,
  logging: false,
};

• server.config.ts: 服务器配置文件，定义了服务器运行的参数，例如端口号、日志级别等。

export default {
  port: 3000,
  logLevel: 'info',
};

这些配置文件通过模块导出配置对象，供项目中的其他模块使用，使得配置的修改更加集中和维护。

以上是 typeorm-extension 项目的启动和配置文档，希望对您有所帮助。