如何在 Nodejs 环境中设置用于生产的全栈项目

php中文网 2024-10-15 11:30:05

建立生产级全栈 node.js 项目不仅仅涉及编写代码。它需要仔细的规划、强大的架构以及遵守最佳实践。本指南将引导您完成使用 node.js、express 和 react 创建可扩展、可维护且安全的全栈应用程序的过程。

无论您是想要了解生产级设置的初学者，还是旨在完善项目结构的经验丰富的开发人员，本指南都将为创建专业级应用程序提供宝贵的见解。

先决条件

在我们开始之前，请确保您的系统上安装了以下软件：

node.js（最新 lts 版本）
npm（node 包管理器，node.js 自带）
git（用于版本控制）

一、项目结构

组织良好的项目结构对于可维护性和可扩展性至关重要。以下是全栈 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

说明：

服务器目录包含所有后端相关代码。
客户端目录包含前端应用程序。
在后端分离关注点（控制器、模型、路由）可以促进模块化。
.env.example 文件用作环境变量的模板。
docker 配置允许一致的开发和部署环境。

2. 后台设置

设置强大的后端对于生产级应用程序至关重要。这是分步指南：

初始化项目：

   mkdir server &amp;&amp; cd server
   npm init -y

安装必要的依赖项：

   npm i express mongoose dotenv helmet cors winston
   npm i -d nodemon jest supertest

创建主应用程序文件（src/app.js）：

   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;

说明：

使用express作为web框架。
头盔添加了与安全相关的 http 标头。
cors 实现跨源资源共享。
模块化路由和错误处理可以改善代码组织。

3. 前端设置

结构良好的前端对于流畅的用户体验至关重要：

创建一个新的 react 应用程序：

   npx create-react-app client
   cd client

安装附加包：

   npm i axios react-router-dom

设置api服务（src/services/api.js）：

   import axios from 'axios';

   const api = axios.create({
     baseurl: process.env.react_app_api_url || 'http://localhost:5000/api',
   });

   export default api;

说明：

使用 create react app 为最佳实践奠定了坚实的基础。
axios 简化了 api 调用。
集中api配置使管理端点变得更加容易。

4. docker 设置

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:

说明：

定义后端、前端和数据库的服务。
使用环境变量进行配置。
使用卷保存数据库数据。

5. 测试

实施全面测试以确保可靠性：

后端测试（server/tests/app.test.js）：

   const request = require('supertest');
   const app = require('../src/app');

   describe('app', () =&gt; {
     it('should respond to health check', async () =&gt; {
       const res = await request(app).get('/api/health');
       expect(res.statuscode).tobe(200);
     });
   });

前端测试：利用 react 测试库进行组件测试。

说明：

后端测试使用 jest 和 supertest 进行 api 测试。
前端测试确保组件正确渲染和行为。

6. ci/cd 管道

使用 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 &amp;&amp; npm ci
    - run: cd server &amp;&amp; npm test
    - run: cd client &amp;&amp; npm ci
    - run: cd client &amp;&amp; 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

说明：

自动对推送和拉取请求运行测试。
在主分支上测试成功后部署到生产环境。

7. 安全最佳实践

使用头盔设置安全 http 标头
实施速率限制
在生产中使用 https
净化用户输入
实施适当的身份验证和授权

8. 性能优化

使用压缩中间件
实施缓存策略
优化数据库查询
使用pm2或类似产品进行生产过程管理

下一步

实施身份验证（jwt、oauth）
设置数据库迁移
实施日志记录和监控
为静态资产配置cdn
设置错误跟踪（例如 sentry）

记住永远不要提交 api 密钥或数据库凭据等敏感信息。使用环境变量进行配置。

结论

建立生产级全栈 node.js 项目需要关注细节并遵守最佳实践。通过遵循本指南，您已经为可扩展、可维护且安全的应用程序奠定了基础。请记住，这是一个起点 - 随着您的项目的发展，您可能需要调整和扩展这些实践以满足您的特定需求。

常见问题解答

1. 为什么使用docker进行开发？**

docker 确保不同开发环境之间的一致性，简化新团队成员的设置，并紧密模仿生产环境。

2. 如何安全地处理环境变量？**

使用 .env 文件进行本地开发，但切勿将它们提交到版本控制。对于生产，请使用托管平台提供的环境变量。

3.前后端分离有什么好处？**

这种分离允许独立扩展，更容易维护，并且可以为堆栈的每个部分使用不同的技术。

4. 如何确保我的应用程序安全？**

实施身份验证和授权，使用 https，清理用户输入，保持依赖项更新，并遵循 owasp 安全指南。

5. 对于生产中的数据库性能，我应该考虑什么？**

优化查询，有效使用索引，实施缓存策略，并考虑数据库扩展选项，例如针对高流量应用程序的分片或只读副本。

6. 如何处理生产环境中的日志记录？**

使用像 winston 这样的日志库，使用 elk 堆栈（elasticsearch、logstash、kibana）或基于云的解决方案等服务集中日志，并确保您不会记录敏感信息。

7. 如何确保我的应用程序具有可扩展性？

可扩展性对于生产应用程序至关重要。考虑使用负载均衡器、实施缓存策略、优化数据库查询以及将应用程序设计为无状态。您还可以探索大型应用程序的微服务架构。

8. 保护 node.js 应用程序安全的最佳实践是什么？

安全是最重要的。实施适当的身份验证和授权、使用 https、保持依赖项更新、清理用户输入并遵循 owasp 安全准则。考虑使用 helmet.js 等注重安全的中间件并实施速率限制以防止滥用。

9. 我应该如何管理环境变量和配置？

使用 .env 文件进行本地开发，但切勿将它们提交到版本控制。对于生产，请使用托管平台提供的环境变量。考虑使用配置管理工具来进行复杂的设置。

10. 生产中处理日志记录和监控最有效的方法是什么？

使用 winston 或 bunyan 等库实施强大的日志记录策略。使用 elk 堆栈（elasticsearch、logstash、kibana）或基于云的解决方案等工具设置集中式日志记录。对于监控，请考虑 new relic、datadog 或带有 grafana 的 prometheus 等工具。