Express-TypeScript-2024 项目启动与配置教程

1. 项目目录结构及介绍

express-typescript-2024/
├── .vscode/                      # VSCode 项目配置目录
├── node_modules/                 # 项目依赖库目录
├── public/                       # 公共静态文件目录
│   └── index.html                # 默认的 HTML 文件
├── src/                          # 源代码目录
│   ├── config/                   # 配置文件目录
│   │   ├── database.ts           # 数据库配置文件
│   │   ├── server.ts             # 服务器配置文件
│   │   └── types.ts              # TypeScript 类型定义文件
│   ├── controllers/              # 控制器目录
│   │   └── indexController.ts     # 默认控制器
│   ├── middlewares/              # 中间件目录
│   │   └── loggerMiddleware.ts    # 日志中间件
│   ├── models/                   # 数据模型目录
│   │   └── user.ts               # 用户模型
│   ├── routes/                   # 路由目录
│   │   └── indexRoutes.ts        # 默认路由
│   ├── services/                 # 服务层目录
│   │   └── userService.ts        # 用户服务
│   ├── app.ts                    # 应用启动文件
│   └── main.ts                   # 主入口文件
├── package.json                  # 项目依赖和配置文件
└── tsconfig.json                 # TypeScript 配置文件

• .vscode/: 存放 Visual Studio Code 的项目配置文件。
• node_modules/: 存放项目的所有依赖库。
• public/: 存放公共静态文件，如 HTML、CSS 和 JavaScript 文件。
• src/: 源代码目录，包含了项目的核心逻辑。
  • config/: 配置文件目录。
  • controllers/: 控制器目录，处理 HTTP 请求。
  • middlewares/: 中间件目录，处理请求和响应的中间处理。
  • models/: 数据模型目录，定义数据结构。
  • routes/: 路由目录，定义 URL 路径与控制器的映射。
  • services/: 服务层目录，处理业务逻辑。
  • app.ts: 应用启动文件，设置应用的基本配置。
  • main.ts: 主入口文件，启动应用。

2. 项目的启动文件介绍

项目的启动文件是 src/app.ts，该文件负责初始化和配置 Express 应用。以下是 app.ts 文件的基本结构：

import express from 'express';
import * as http from 'http';
import { serverConfig } from './config/server';
import { indexRoutes } from './routes/indexRoutes';

const app = express();
const server = http.createServer(app);

// 配置中间件
app.use(express.json());
app.use(express.urlencoded({ extended: true }));

// 注册路由
app.use(indexRoutes);

// 配置服务器
server.listen(serverConfig.port, () => {
  console.log(`Server running on port ${serverConfig.port}`);
});

• 初始化 Express 应用和 HTTP 服务器。
• 使用 express.json() 和 express.urlencoded() 中间件解析请求体。
• 注册路由，将请求分发到相应的控制器。
• 配置服务器监听指定端口。

3. 项目的配置文件介绍

项目的配置文件位于 src/config/ 目录下，主要包括以下文件：

• database.ts: 数据库配置文件，定义数据库连接参数。
• server.ts: 服务器配置文件，定义服务器端口等信息。
• types.ts: TypeScript 类型定义文件，定义全局类型。

以下是 server.ts 配置文件的一个例子：

// src/config/server.ts
export const serverConfig = {
  port: 3000, // 服务器端口
  // 其他服务器相关配置...
};

配置文件使得项目的配置集中管理，便于维护和修改。