Egg.js 应用部署与上线指南

┌─────────────┐         ┌──────────────────────────────────────────┐
│   用户      │         │          服务器 (Linux)                  │
│  (浏览器)   │         │                                          │
└──────┬──────┘         │  ┌─────────────────────────────────────┐ │
       │                │  │         Nginx (反向代理)            │ │
       │ HTTPS (443)    │  │  - SSL 终止                         │ │
       │ HTTP  (80)     │  │  - 负载均衡                         │ │
       └────────────────┼─→│  - 静态资源服务                     │ │
                        │  └──────────────┬──────────────────────┘ │
                        │                 │ proxy_pass              │
                        │                 │ 127.0.0.1:7001          │
                        │  ┌──────────────▼──────────────────────┐ │
                        │  │      PM2 (进程管理器)               │ │
                        │  │  ┌───────────┐  ┌───────────┐       │ │
                        │  │  │ Worker 1  │  │ Worker 2  │ ...   │ │
                        │  │  │ (Egg.js)  │  │ (Egg.js)  │       │ │
                        │  │  └─────┬─────┘  └─────┬─────┘       │ │
                        │  └────────┼──────────────┼─────────────┘ │
                        │           │              │               │
                        │  ┌────────▼──────────────▼─────────────┐ │
                        │  │      MongoDB (数据库)               │ │
                        │  └─────────────────────────────────────┘ │
                        └──────────────────────────────────────────┘

┌──────────────────────────────────────────────────────────────────┐
│                    CI/CD 流程 (GitHub Actions)                   │
│  ┌────────┐    ┌────────┐    ┌────────┐    ┌────────────────┐  │
│  │ 代码   │───→│ 测试   │───→│ 构建   │───→│ 自动部署服务器 │  │
│  │ 推送   │    │        │    │        │    │                │  │
│  └────────┘    └────────┘    └────────┘    └────────────────┘  │
└──────────────────────────────────────────────────────────────────┘

sudo apt update && sudo apt upgrade -y

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

source ~/.bashrc

export NVM_NODEJS_ORG_MIRROR=https://npm.taobao.org/mirrors/node
echo 'export NVM_NODEJS_ORG_MIRROR=https://npm.taobao.org/mirrors/node' >> ~/.bashrc

nvm install --lts
nvm use --lts
nvm alias default lts

node -v
npm -v

npm config set registry https://registry.npm.taobao.org/

wget -qO - https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add -

echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list

sudo apt-get update
sudo apt-get install -y mongodb-org

# 启动 MongoDB 服务
sudo systemctl start mongod

# 查看服务状态
sudo systemctl status mongod

# 设置为开机自启
sudo systemctl enable mongod

# 停止服务
sudo systemctl stop mongod

# 重启服务
sudo systemctl restart mongod

sudo apt install nginx -y

# 启动 Nginx
sudo systemctl start nginx

# 查看 Nginx 状态
sudo systemctl status nginx

# 设置为开机自启
sudo systemctl enable nginx

# 重启 Nginx
sudo systemctl restart nginx

# 重新加载配置 (在不中断服务的情况下)
sudo systemctl reload nginx

sudo apt install git -y
git --version # 验证安装

# 推荐将项目放在 /var/www 目录下
cd /var/www
git clone <你的 Git 仓库地址>
cd <你的项目目录>

// config/config.prod.js
'use strict';

exports.keys = 'your-production-secret-keys-change-it';

// 安全配置
exports.security = {
  csrf: {
    enable: true, // 生产环境必须开启
  },
  xframe: {
    enable: true,
  },
};

// 日志配置
exports.logger = {
  level: 'INFO', // 生产环境使用 INFO 级别
  consoleLevel: 'ERROR', // 控制台只输出 ERROR
  dir: '/var/log/egg-app', // 日志存放目录
};

// 集群配置
exports.cluster = {
  listen: {
    port: 7001,
    hostname: '127.0.0.1', // 仅监听本地地址
  },
};

// 性能优化
exports.middleware = [
  'gzip', // 启用 gzip 压缩
];

exports.gzip = {
  threshold: 1024, // 大于 1KB 才压缩
};

// 静态资源缓存
exports.static = {
  maxAge: 31536000, // 1年
  gzip: true,
};

# .env
NODE_ENV=production
EGG_SERVER_ENV=prod

# 数据库配置
MONGODB_URL=mongodb://localhost:27017/your-database
MONGODB_USER=your-username
MONGODB_PASSWORD=your-password

# 应用密钥
APP_KEYS=your-secret-keys

# 其他配置
PORT=7001

{
  "scripts": {
    "start": "egg-scripts start --daemon --title=my-egg-app",
    "stop": "egg-scripts stop --title=my-egg-app",
    "start:prod": "EGG_SERVER_ENV=prod npm start"
  }
}

npm install --production

netstat -tlnp | grep 7001
# 或
lsof -i :7001

npm install pm2 -g

// ecosystem.config.js
module.exports = {
  apps: [
    {
      name: 'my-egg-app',
      script: 'npm',
      args: 'start',
      cwd: '/var/www/my-egg-app',
      instances: 'max', // 启动最大 CPU 核心数的实例
      exec_mode: 'cluster', // 集群模式
      watch: false, // 生产环境不建议开启 watch
      max_memory_restart: '500M', // 内存达到 500M 自动重启
      env_production: {
        NODE_ENV: 'production',
        EGG_SERVER_ENV: 'prod',
      },
      // 日志配置
      error_file: '/var/log/egg-app/pm2-error.log',
      out_file: '/var/log/egg-app/pm2-out.log',
      log_date_format: 'YYYY-MM-DD HH:mm:ss Z',
      merge_logs: true,
      // 重启策略
      exp_backoff_restart_delay: 100, // 指数退避重启延迟
      max_restarts: 10, // 最大重启次数
      restart_delay: 1000, // 重启延迟 1 秒
      autorestart: true, // 自动重启
    },
  ],
};

# 进入项目目录
cd /var/www/<你的项目目录>

# 使用配置文件启动
pm2 start ecosystem.config.js --env production

# 或者使用命令行方式启动
pm2 start npm --name "my-egg-app" -- run start -- -i max

# 列出所有由 PM2 管理的应用
pm2 list

# 查看特定应用的详细信息
pm2 show my-egg-app

# 查看特定应用的实时日志
pm2 logs my-egg-app

# 查看最近 100 行日志
pm2 logs my-egg-app --lines 100

# 监控应用的 CPU 和内存使用情况
pm2 monit

# 停止应用
pm2 stop my-egg-app

# 重启应用 (硬重启)
pm2 restart my-egg-app

# 重载应用 (零停机重启)
pm2 reload my-egg-app

# 删除应用
pm2 delete my-egg-app

# 查看进程状态
pm2 status

pm2 startup

pm2 save

# 连接到 PM2 Plus (需要注册账号)
pm2 link <secret_key> <public_key>

# -t 指定密钥类型，-b 指定密钥长度，-C 添加注释
ssh-keygen -t rsa -b 4096 -C "github_actions_deploy_key"

cat ~/.ssh/id_rsa.pub

ssh -T git@github.com

# .github/workflows/deploy.yml

name: Deploy to Server

# 触发条件：当有代码 push 到 main 分支时触发
on:
  push:
    branches: [main] # 或者 master

jobs:
  deploy:
    # 运行环境
    runs-on: ubuntu-latest

    steps:
      # 步骤1: 使用 appleboy/ssh-action 连接到服务器并执行部署脚本
      - name: Deploy to Server
        uses: appleboy/ssh-action@master
        with:
          host: ${{ secrets.HOST }}
          username: ${{ secrets.USERNAME }}
          key: ${{ secrets.SSH_PRIVATE_KEY }}
          port: ${{ secrets.PORT }}
          script: |
            # 进入项目目录
            cd ${{ secrets.PROJECT_PATH }}

            # 从 main 分支拉取最新代码
            git pull origin main

            # 使用 nvm 加载正确的 Node.js 版本
            # 注意：这里的路径可能需要根据您的 nvm 安装情况进行调整
            export NVM_DIR="$HOME/.nvm"
            [ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

            # 安装生产依赖
            npm install --production

            # 使用 PM2 重新加载应用，实现零停机更新
            pm2 reload ${{ secrets.APP_NAME }}

git add .
git commit -m "feat: Add GitHub Actions for auto-deployment"
git push origin main

sudo nano /etc/nginx/sites-available/my-egg-app.conf

server {
    listen 80;
    server_name your_domain.com; # 替换为您的域名

    location / {
        proxy_pass http://127.0.0.1:7001; # 转发到本地的 Egg.js 应用
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_cache_bypass $http_upgrade;
    }
}

sudo ln -s /etc/nginx/sites-available/my-egg-app.conf /etc/nginx/sites-enabled/

sudo nginx -t

sudo systemctl restart nginx

sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/bin/certbot

# --nginx: 指定使用 Nginx 插件
# -d: 指定要为其申请证书的域名
sudo certbot --nginx -d your_domain.com

sudo certbot renew --dry-run

# 使用 Node.js 官方镜像
FROM node:16-alpine

# 设置工作目录
WORKDIR /app

# 复制 package.json 和 package-lock.json
COPY package*.json ./

# 安装依赖
RUN npm install --production

# 复制应用代码
COPY . .

# 暴露端口
EXPOSE 7001

# 设置环境变量
ENV NODE_ENV=production \
    EGG_SERVER_ENV=prod

# 启动应用
CMD ["npm", "start"]

version: '3.8'

services:
  app:
    build: .
    container_name: egg-app
    restart: always
    ports:
      - "7001:7001"
    environment:
      - NODE_ENV=production
      - EGG_SERVER_ENV=prod
      - MONGODB_URL=mongodb://mongo:27017/egg-db
    depends_on:
      - mongo
    networks:
      - egg-network

  mongo:
    image: mongo:4.4
    container_name: egg-mongo
    restart: always
    ports:
      - "27017:27017"
    volumes:
      - mongo-data:/data/db
    environment:
      - MONGO_INITDB_ROOT_USERNAME=admin
      - MONGO_INITDB_ROOT_PASSWORD=password
    networks:
      - egg-network

  nginx:
    image: nginx:alpine
    container_name: egg-nginx
    restart: always
    ports:
      - "80:80"
      - "443:443"
    volumes:
      - ./nginx.conf:/etc/nginx/nginx.conf
      - ./ssl:/etc/nginx/ssl
    depends_on:
      - app
    networks:
      - egg-network

volumes:
  mongo-data:

networks:
  egg-network:
    driver: bridge

# 构建镜像
docker build -t my-egg-app:latest .

# 使用 Docker Compose 启动
docker-compose up -d

# 查看日志
docker-compose logs -f app

# 停止服务
docker-compose down

# 启动监控
pm2 monit

# 查看进程详情
pm2 describe my-egg-app

npm install egg-apm --save

// config/plugin.js
exports.apm = {
  enable: true,
  package: 'egg-apm',
};

// config/config.prod.js
exports.apm = {
  serverUrl: 'http://your-apm-server:8200',
  serviceName: 'my-egg-app',
};

// config/config.prod.js
exports.logger = {
  level: 'INFO',
  dir: '/var/log/egg-app',
  // 自定义日志格式
  formatter(meta) {
    return `${meta.date} ${meta.level} ${meta.pid} ${meta.message}`;
  },
};

# 安装 pm2-logrotate 插件
pm2 install pm2-logrotate

# 配置日志切割
pm2 set pm2-logrotate:max_size 10M
pm2 set pm2-logrotate:retain 30

#!/bin/bash

# 健康检查脚本
APP_URL="http://localhost:7001/health"
WEBHOOK_URL="https://hooks.slack.com/services/YOUR/WEBHOOK/URL"

# 发送 HTTP 请求
response=$(curl -s -o /dev/null -w "%{http_code}" $APP_URL)

if [ $response != "200" ]; then
  # 发送告警到 Slack
  curl -X POST -H 'Content-type: application/json' \
    --data "{\"text\":\"⚠️ Egg.js 应用健康检查失败! HTTP 状态码: $response\"}" \
    $WEBHOOK_URL
  
  # 尝试重启应用
  pm2 restart my-egg-app
fi

# 每 5 分钟检查一次
*/5 * * * * /var/www/my-egg-app/scripts/health-check.sh

// app.js
const perfHooks = require('perf_hooks');

// 监控事件循环延迟
const monitor = new perfHooks.Monitor({
  sampleInterval: 2000,
});

monitor.enable();

setInterval(() => {
  const lag = monitor.eventLoopLag;
  if (lag > 100) {
    console.warn(`事件循环延迟过高: ${lag}ms`);
  }
}, 10000);

# 生成堆快照分析内存
kill -USR2 <pid>  # 生成 heapdump

# 零停机重启
pm2 reload my-egg-app

# 配合 graceful shutdown
// app.js
module.exports = app => {
  app.beforeClose(() => {
    // 清理工作，如关闭数据库连接
    return new Promise(resolve => setTimeout(resolve, 1000));
  });
};

开始
  │
  ├── 检查进程状态
  │   └─ pm2 list / pm2 logs
  │
  ├── 检查端口监听
  │   └─ netstat -tlnp | grep 7001
  │
  ├── 检查应用日志
  │   └─ /var/log/egg-app/
  │
  ├── 检查系统资源
  │   ├─ top / htop (CPU/内存)
  │   └─ df -h (磁盘空间)
  │
  ├── 检查网络连接
  │   ├─ curl http://localhost:7001
  │   └─ ping your_domain.com
  │
  └── 检查数据库连接
      └─ mongo --eval "db.stats()"

// config/config.prod.js
exports.logger = {
  level: 'INFO',
  dir: '/var/log/egg-app',
  bufferLogs: true, // 启用日志缓冲
  outputJSON: true, // JSON 格式输出
  consoleLevel: 'NONE', // 生产环境不输出到控制台
};

// 自定义日志分类
exports.customLogger = {
  accessLogger: {
    file: '/var/log/egg-app/access.log',
    formatter: meta => `${meta.timestamp} ${meta.method} ${meta.url} ${meta.status}`,
  },
};

// config/config.prod.js
exports.security = {
  csrf: {
    enable: true,
    ignoreJSON: false,
  },
  xframe: {
    enable: true,
    value: 'SAMEORIGIN',
  },
  hsts: {
    enable: true,
    maxAge: 31536000,
  },
  xssProtection: {
    enable: true,
  },
  csp: {
    enable: true,
    policy: {
      'default-src': ["'self'"],
      'script-src': ["'self'"],
      'style-src': ["'self'"],
    },
  },
};

// 限流配置
exports.ratelimit = {
  enable: true,
  max: 100, // 每分钟最大请求数
  duration: 60000, // 时间窗口（毫秒）
};

# 检查 npm 依赖漏洞
npm audit

# 自动修复
npm audit fix

# 检查服务器开放端口
netstat -tlnp

# 检查防火墙状态
sudo ufw status verbose

// config/config.prod.js
exports.mongoose = {
  url: process.env.MONGODB_URL,
  options: {
    poolSize: 10, // 连接池大小
    bufferMaxEntries: 0,
    useNewUrlParser: true,
    useUnifiedTopology: true,
    serverSelectionTimeoutMS: 5000,
    socketTimeoutMS: 45000,
  },
};

// Redis 连接池
exports.redis = {
  client: {
    port: 6379,
    host: '127.0.0.1',
    password: process.env.REDIS_PASSWORD,
    db: 0,
    pool: {
      max: 10, // 最大连接数
      min: 2, // 最小连接数
    },
  },
};

#!/bin/bash
# backup-mongodb.sh

DATE=$(date +%Y%m%d_%H%M%S)
BACKUP_DIR="/var/backups/mongodb"
DB_NAME="egg-db"

# 创建备份目录
mkdir -p $BACKUP_DIR

# 执行备份
mongodump --db $DB_NAME --out $BACKUP_DIR/$DATE

# 压缩备份文件
tar -czf $BACKUP_DIR/$DATE.tar.gz -C $BACKUP_DIR/$DATE .

# 删除临时目录
rm -rf $BACKUP_DIR/$DATE

# 删除 7 天前的备份
find $BACKUP_DIR -name "*.tar.gz" -mtime +7 -delete

# 上传到云存储 (示例使用 AWS S3)
aws s3 cp $BACKUP_DIR/$DATE.tar.gz s3://your-bucket/mongodb-backups/

# 编辑 crontab
crontab -e

# 每天凌晨 2 点执行备份
0 2 * * * /var/www/scripts/backup-mongodb.sh >> /var/log/mongodb-backup.log 2>&1

                    ┌─────────────┐
                    │   负载均衡  │
                    │ (Nginx/ALB) │
                    └──────┬──────┘
                           │
              ┌────────────┼────────────┐
              │            │            │
        ┌─────▼─────┐ ┌───▼────┐ ┌────▼─────┐
        │  Server 1 │ │Server 2│ │ Server 3 │
        │  (Egg.js) │ │(Egg.js)│ │ (Egg.js) │
        └─────┬─────┘ └───┬────┘ └────┬─────┘
              │            │            │
              └────────────┼────────────┘
                           │
                    ┌──────▼──────┐
                    │   MongoDB   │
                    │  (主从复制)  │
                    └─────────────┘

准备阶段
  │
  ├── 1. 准备服务器和域名
  ├── 2. 安装基础环境 (Node.js, MongoDB, Nginx, Git)
  └── 3. 配置防火墙和安全组
  │
部署阶段
  │
  ├── 4. 克隆代码到服务器
  ├── 5. 配置生产环境参数
  ├── 6. 安装依赖
  ├── 7. 使用 PM2 启动应用
  └── 8. 配置 Nginx 反向代理
  │
优化阶段
  │
  ├── 9. 配置 HTTPS 证书
  ├── 10. 配置自动化部署
  ├── 11. 配置监控和告警
  └── 12. 配置定期备份
  │
维护阶段
  │
  ├── 定期更新依赖
  ├── 监控应用性能
  ├── 检查安全漏洞
  └── 优化和扩容

# Egg.js 生产环境推荐插件
npm install egg-scripts --save          # 启动脚本
npm install egg-logger --save           # 日志管理
npm install egg-mongoose --save         # MongoDB 连接
npm install egg-redis --save            # Redis 连接
npm install egg-cors --save             # CORS 支持
npm install egg-validate --save         # 参数验证
npm install egg-jwt --save              # JWT 认证
npm install egg-ratelimit --save        # 限流
npm install egg-helmet --save           # 安全头设置
npm install egg-compress --save         # 响应压缩