TypeScript-Node-Starter 项目教程

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

TypeScript-Node-Starter/
├── src/
│   ├── controllers/
│   ├── models/
│   ├── routes/
│   ├── services/
│   ├── types/
│   ├── app.ts
│   └── server.ts
├── config/
│   ├── custom-environment-variables.json
│   ├── default.json
│   └── production.json
├── public/
│   ├── css/
│   ├── js/
│   └── images/
├── views/
│   └── index.pug
├── .env
├── .gitignore
├── package.json
├── tsconfig.json
└── README.md

目录结构介绍

• src/: 包含所有TypeScript源代码文件。
  • controllers/: 处理HTTP请求的控制器。
  • models/: 数据库模型定义。
  • routes/: 路由定义。
  • services/: 业务逻辑服务。
  • types/: TypeScript类型定义。
  • app.ts: 应用程序的入口文件，配置中间件和路由。
  • server.ts: 启动服务器文件。
• config/: 配置文件目录。
  • custom-environment-variables.json: 环境变量映射。
  • default.json: 默认配置。
  • production.json: 生产环境配置。
• public/: 静态资源文件目录。
  • css/: CSS文件。
  • js/: JavaScript文件。
  • images/: 图片文件。
• views/: 视图模板文件目录。
  • index.pug: 主页模板。
• .env: 环境变量配置文件。
• .gitignore: Git忽略文件配置。
• package.json: 项目依赖和脚本配置。
• tsconfig.json: TypeScript编译配置。
• README.md: 项目说明文档。

2. 项目的启动文件介绍

server.ts

server.ts 是项目的启动文件，负责启动Express服务器并监听指定端口。

import app from './app';
import http from 'http';
import { AddressInfo } from 'net';

const server = http.createServer(app);

const port = process.env.PORT || '3000';
app.set('port', port);

server.listen(port);
server.on('error', onError);
server.on('listening', onListening);

function onError(error: NodeJS.ErrnoException): void {
  if (error.syscall !== 'listen') {
    throw error;
  }
  const bind = typeof port === 'string' ? `Pipe ${port}` : `Port ${port}`;
  switch (error.code) {
    case 'EACCES':
      console.error(`${bind} requires elevated privileges`);
      process.exit(1);
      break;
    case 'EADDRINUSE':
      console.error(`${bind} is already in use`);
      process.exit(1);
      break;
    default:
      throw error;
  }
}

function onListening(): void {
  const addr = server.address() as AddressInfo;
  const bind = typeof addr === 'string' ? `pipe ${addr}` : `port ${addr.port}`;
  console.log(`Listening on ${bind}`);
}

app.ts

app.ts 是应用程序的入口文件，负责配置中间件和路由。

import express from 'express';
import path from 'path';
import logger from 'morgan';
import cookieParser from 'cookie-parser';
import bodyParser from 'body-parser';
import dotenv from 'dotenv';
import mongoose from 'mongoose';

import index from './routes/index';
import users from './routes/users';

dotenv.config();

const app = express();

// 连接数据库
mongoose.connect(process.env.MONGODB_URI || 'mongodb://localhost:27017/test');

// 视图引擎设置
app.set('views', path.join(__dirname, 'views'));
app.set('view engine',