建立生产级全栈 node.js 项目不仅仅涉及编写代码。它需要仔细的规划、强大的架构以及遵守最佳实践。本指南将引导您完成使用 node.js、express 和 react 创建可扩展、可维护且安全的全栈应用程序的过程。
无论您是想要了解生产级设置的初学者，还是旨在完善项目结构的经验丰富的开发人员，本指南都将为创建专业级应用程序提供宝贵的见解。
在我们开始之前，请确保您的系统上安装了以下软件：
组织良好的项目结构对于可维护性和可扩展性至关重要。以下是全栈 node.js 项目的推荐结构：
project-root/ ├── server/ │ ├── src/ │ │ ├── config/ │ │ ├── controllers/ │ │ ├── models/ │ │ ├── routes/ │ │ ├── services/ │ │ ├── utils/ │ │ └── app.js │ ├── tests/ │ ├── .env.example │ └── package.json ├── client/ │ ├── public/ │ ├── src/ │ │ ├── components/ │ │ ├── pages/ │ │ ├── services/ │ │ ├── utils/ │ │ └── app.js │ ├── .env.example │ └── package.json ├── .gitignore ├── docker-compose.yml └── readme.md
说明：
设置强大的后端对于生产级应用程序至关重要。这是分步指南：
mkdir server && cd server npm init -y
npm i express mongoose dotenv helmet cors winston npm i -d nodemon jest supertest
const express = require('express');
const helmet = require('helmet');
const cors = require('cors');
const routes = require('./routes');
const errorhandler = require('./middleware/errorhandler');
const app = express();
app.use(helmet());
app.use(cors());
app.use(express.json());
app.use('/api', routes);
app.use(errorhandler);
module.exports = app;
说明：
结构良好的前端对于流畅的用户体验至关重要：
npx create-react-app client cd client
npm i axios react-router-dom
import axios from 'axios';
const api = axios.create({
baseurl: process.env.react_app_api_url || 'http://localhost:5000/api',
});
export default api;
说明：
docker 确保开发、测试和生产环境之间的一致性：
在项目根目录创建docker-compose.yml：
version: '3.8'
services:
server:
build: ./server
ports:
- "5000:5000"
environment:
- node_env=production
- mongodb_uri=mongodb://mongo:27017/your_database
depends_on:
- mongo
client:
build: ./client
ports:
- "3000:3000"
mongo:
image: mongo
volumes:
- mongo-data:/data/db
volumes:
mongo-data:
说明：
实施全面测试以确保可靠性：
const request = require('supertest');
const app = require('../src/app');
describe('app', () => {
it('should respond to health check', async () => {
const res = await request(app).get('/api/health');
expect(res.statuscode).tobe(200);
});
});
说明：
使用 ci/cd 管道自动化测试和部署。这是使用 github actions 的示例：
name: CI/CD
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Use Node.js
uses: actions/setup-node@v2
with:
node-version: '14.x'
- run: cd server && npm ci
- run: cd server && npm test
- run: cd client && npm ci
- run: cd client && npm test
deploy:
needs: test
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
steps:
- name: Deploy to production
run: |
# Add your deployment script here
说明：
使用压缩中间件
实施缓存策略
优化数据库查询
使用pm2或类似产品进行生产过程管理
实施身份验证（jwt、oauth）
设置数据库迁移
实施日志记录和监控
为静态资产配置cdn
设置错误跟踪（例如 sentry）
记住永远不要提交 api 密钥或数据库凭据等敏感信息。使用环境变量进行配置。
建立生产级全栈 node.js 项目需要关注细节并遵守最佳实践。通过遵循本指南，您已经为可扩展、可维护且安全的应用程序奠定了基础。请记住，这是一个起点 - 随着您的项目的发展，您可能需要调整和扩展这些实践以满足您的特定需求。
docker 确保不同开发环境之间的一致性，简化新团队成员的设置，并紧密模仿生产环境。
使用 .env 文件进行本地开发，但切勿将它们提交到版本控制。对于生产，请使用托管平台提供的环境变量。
这种分离允许独立扩展，更容易维护，并且可以为堆栈的每个部分使用不同的技术。
实施身份验证和授权，使用 https，清理用户输入，保持依赖项更新，并遵循 owasp 安全指南。
优化查询，有效使用索引，实施缓存策略，并考虑数据库扩展选项，例如针对高流量应用程序的分片或只读副本。
使用像 winston 这样的日志库，使用 elk 堆栈（elasticsearch、logstash、kibana）或基于云的解决方案等服务集中日志，并确保您不会记录敏感信息。
可扩展性对于生产应用程序至关重要。考虑使用负载均衡器、实施缓存策略、优化数据库查询以及将应用程序设计为无状态。您还可以探索大型应用程序的微服务架构。
安全是最重要的。实施适当的身份验证和授权、使用 https、保持依赖项更新、清理用户输入并遵循 owasp 安全准则。考虑使用 helmet.js 等注重安全的中间件并实施速率限制以防止滥用。
使用 .env 文件进行本地开发，但切勿将它们提交到版本控制。对于生产，请使用托管平台提供的环境变量。考虑使用配置管理工具来进行复杂的设置。
使用 winston 或 bunyan 等库实施强大的日志记录策略。使用 elk 堆栈（elasticsearch、logstash、kibana）或基于云的解决方案等工具设置集中式日志记录。对于监控，请考虑 new relic、datadog 或带有 grafana 的 prometheus 等工具。
优化查询、有效使用索引、实施缓存策略（例如 redis），并考虑数据库扩展选项，例如针对高流量应用程序的分片或只读副本。定期进行数据库维护和优化。
在 express 中实现全局错误处理中间件。全面记录错误，但避免向客户暴露敏感信息。考虑使用像 sentry 这样的错误监控服务来进行实时错误跟踪和警报。
使用 jest 在前端和后端进行单元和集成测试。使用 cypress 等工具实施端到端测试。以高测试覆盖率为目标，并将测试集成到 ci/cd 管道中。
考虑使用 url 版本控制（例如 /api/v1/）或自定义请求标头。对旧 api 版本实施明确的弃用政策，并向 api 消费者有效传达更改。
实施蓝绿部署或滚动更新。使用容器化 (docker) 和编排工具 (kubernetes) 来更轻松地扩展和部署。使用强大的 ci/cd 管道自动化您的部署过程。
实现多个级别的缓存：浏览器缓存、静态资源的 cdn 缓存、应用程序级缓存（例如 redis）和数据库查询缓存。注意缓存失效策略以确保数据一致性。
考虑使用 jwt（json web 令牌）进行无状态身份验证。实施安全令牌存储（httponly cookie），使用刷新令牌，并考虑使用 oauth2 进行第三方身份验证。对于 spa，请注意 xss 和 csrf 保护。
遵循原子设计原则。分离展示组件和容器组件。使用钩子实现共享逻辑，并考虑使用 redux 或 mobx 等状态管理库进行复杂的状态管理。
实现代码分割和延迟加载。使用 react.memo 和 usememo 进行昂贵的计算。使用 react devtools 等工具优化渲染。考虑服务器端渲染或静态站点生成以缩短初始加载时间。
考虑可扩展性、定价、易于部署、可用服务（数据库、缓存等）以及对技术堆栈的支持等因素。流行的选项包括 aws、google cloud platform、heroku 和 digitalocean。
使用数据库迁移工具（例如，用于 sql 数据库的 knex.js 或用于 mongodb 的 mongoose）。仔细规划迁移，始终制定回滚策略，并在应用于生产之前在暂存环境中彻底测试迁移。
请记住，构建生产级应用程序是一个迭代过程。根据实际使用情况和反馈持续监控、测试和改进您的应用程序。