跳到主要内容

安装配置

本章节介绍 Express.js 的环境搭建与项目初始化。

环境要求​

  • Node.js: 18.x 或更高版本
  • npm: 9.x 或更高版本（随 Node.js 安装）
  • 代码编辑器: VS Code（推荐）

检查环境​

node --version
npm --version

项目初始化​

方式一：手动创建​

mkdir my-express-app
cd my-express-app
npm init -y
npm install express

方式二：使用 Express 生成器​

npm install -g express-generator
express my-express-app
cd my-express-app
npm install

项目结构​

推荐的项目目录结构：

my-express-app/
├── src/
│   ├── routes/          # 路由文件
│   │   ├── index.js
│   │   └── users.js
│   ├── controllers/     # 控制器
│   ├── middleware/      # 自定义中间件
│   ├── models/          # 数据模型
│   ├── config/          # 配置文件
│   └── app.js           # 应用入口
├── public/              # 静态文件
├── tests/               # 测试文件
├── package.json
└── .env                 # 环境变量

基础配置​

package.json 脚本​

{
  "scripts": {
    "start": "node src/app.js",
    "dev": "nodemon src/app.js",
    "test": "jest"
  }
}

环境变量​

安装 dotenv：

npm install dotenv

创建 .env 文件：

PORT=3000
NODE_ENV=development

使用环境变量：

require('dotenv').config();
const express = require('express');
const app = express();

const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on port ${PORT}`);
});

开发工具​

Nodemon 热重载​

npm install -D nodemon

ESLint 代码检查​

npm install -D eslint
npx eslint --init

Prettier 代码格式化​

npm install -D prettier

TypeScript 支持​

npm install -D typescript @types/express @types/node
npx tsc --init

tsconfig.json 配置：

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "commonjs",
    "outDir": "./dist",
    "rootDir": "./src",
    "strict": true,
    "esModuleInterop": true
  }
}

TypeScript 示例：

import express, { Request, Response, NextFunction } from 'express';

const app = express();

app.get('/', (req: Request, res: Response) => {
  res.json({ message: 'Hello Express with TypeScript!' });
});

app.listen(3000, () => {
  console.log('Server running on port 3000');
});