TypeScript 和 Node.js 项目教程
1. 项目的目录结构及介绍
typescript-node-projects/
├── src/
│ ├── controllers/
│ ├── models/
│ ├── routes/
│ ├── services/
│ ├── utils/
│ └── index.ts
├── config/
│ ├── config.ts
├── test/
├── package.json
├── tsconfig.json
└── README.md
- src/: 包含项目的源代码文件。
- controllers/: 处理请求和响应的逻辑。
- models/: 定义数据模型。
- routes/: 定义API路由。
- services/: 包含业务逻辑。
- utils/: 包含工具函数。
- index.ts: 项目的入口文件。
- config/: 包含项目的配置文件。
- config.ts: 配置文件,如数据库连接、环境变量等。
- test/: 包含测试文件。
- package.json: 项目的依赖和脚本配置。
- tsconfig.json: TypeScript 编译配置文件。
- README.md: 项目说明文档。
2. 项目的启动文件介绍
项目的启动文件是 src/index.ts
。这个文件负责初始化服务器并启动应用程序。以下是 index.ts
的基本结构:
import express from 'express';
import { config } from '../config/config';
const app = express();
const port = config.port;
app.get('/', (req, res) => {
res.send('Hello TypeScript + Node.js + Express');
});
app.listen(port, () => {
console.log(`Server is running on http://localhost:${port}`);
});
- 导入模块: 导入
express
和配置文件。 - 创建应用实例: 使用
express()
创建应用实例。 - 定义路由: 定义一个简单的路由处理程序。
- 启动服务器: 使用
app.listen
启动服务器并监听指定端口。
3. 项目的配置文件介绍
项目的配置文件位于 config/config.ts
。这个文件负责管理应用程序的配置,如端口号、数据库连接等。以下是 config.ts
的基本结构:
import dotenv from 'dotenv';
dotenv.config();
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 || 'mydb',
},
};
- 导入模块: 导入
dotenv
模块用于加载环境变量。 - 配置对象: 定义一个配置对象,包含端口号和数据库配置。
- 环境变量: 使用
process.env
获取环境变量,并提供默认值。
通过以上介绍,您可以更好地理解和使用 typescript-node-projects
项目。希望这篇教程对您有所帮助!