首页  >  文章  >  web前端  >  使用 Node.js 构建自定义后端:分步指南

使用 Node.js 构建自定义后端:分步指南

Barbara Streisand
Barbara Streisand原创
2024-10-18 22:43:02723浏览

Building a Custom Backend with Node.js: A Step-by-Step Guide

在 Node.js 中创建自定义后端涉及多个步骤,从设置 Node.js 环境到构建和部署 API。以下是使用 Node.js 创建自定义后端的详细分步指南:

第 1 步:设置您的开发环境

开始编码之前,您需要在计算机上安装以下软件:

  • Node.js:在服务器端运行 JavaScript 的运行时。您可以从nodejs.org下载它。
  • NPM(节点包管理器):它与 Node.js 捆绑在一起。您将使用它来安装和管理库。

要检查 Node.js 和 NPM 是否已安装,请运行:

node -v
npm -v

如果安装了它们,您将看到它们的版本号。如果没有,请安装 Node.js。

第2步:创建一个新项目

  1. 创建项目文件夹
mkdir my-custom-backend
cd my-custom-backend
  1. 初始化package.json文件
npm init -y

此命令创建一个基本的 package.json 文件,它将管理您的依赖项。

第 3 步:安装所需的软件包

您需要安装一些软件包来构建后端。

  • Express:一个最小且灵活的 Node.js Web 应用程序框架,为构建 Web 和移动应用程序提供了一组强大的功能。
  • Nodemon:一种帮助开发 Node.js 应用程序的工具,当检测到目录中的文件更改时自动重新启动服务器。
  • Body-parser:处理 JSON 和 URL 编码表单数据的中间件。
  • dotenv:管理环境变量。

通过运行安装这些依赖项:

npm install express body-parser dotenv
npm install --save-dev nodemon
  • express:处理 HTTP 请求的核心框架。
  • body-parser:用于在处理程序之前解析中间件中传入请求的中间件,可通过 req.body 访问。
  • dotenv:将环境变量从 .env 文件加载到 process.env。
  • nodemon:代码更改时自动重新启动服务器(用于开发目的)。

第 4 步:创建服务器文件

在项目根目录中,创建一个名为 server.js 的文件。该文件将处理 Express 服务器的设置。

touch server.js

在server.js中,添加以下代码:

// Import necessary modules
const express = require('express');
const bodyParser = require('body-parser');
const dotenv = require('dotenv');

// Load environment variables
dotenv.config();

// Initialize the app
const app = express();

// Middleware to parse JSON data
app.use(bodyParser.json());

// Define a basic route
app.get('/', (req, res) => {
  res.send('Welcome to my custom Node.js backend!');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on http://localhost:${PORT}`);
});

此文件设置一个 Express 服务器,用于侦听请求并用简单的消息进行响应。

第 5 步:运行服务器

要运行您的服务器,您可以使用节点命令:

node -v
npm -v

但是,对于开发来说,最好使用nodemon在更改时自动重新启动服务器:

mkdir my-custom-backend
cd my-custom-backend

现在,在浏览器中访问 http://localhost:3000。您应该看到:

npm init -y

第 6 步:定义路由和处理程序

接下来,您需要为后端添加一些自定义路由。例如,您可以创建一个处理用户信息的 API:

npm install express body-parser dotenv
npm install --save-dev nodemon
  • GET /users:获取所有用户。
  • GET /users/:id:通过 ID 获取用户。
  • POST /users:添加新用户。
  • DELETE /users/:id:通过 ID 删除用户。

第7步:使用环境变量

您可以使用 dotenv 包配置环境变量。在根目录创建.env文件:

touch server.js

在 .env 中,您可以定义如下变量:

// Import necessary modules
const express = require('express');
const bodyParser = require('body-parser');
const dotenv = require('dotenv');

// Load environment variables
dotenv.config();

// Initialize the app
const app = express();

// Middleware to parse JSON data
app.use(bodyParser.json());

// Define a basic route
app.get('/', (req, res) => {
  res.send('Welcome to my custom Node.js backend!');
});

// Start the server
const PORT = process.env.PORT || 3000;
app.listen(PORT, () => {
  console.log(`Server running on http://localhost:${PORT}`);
});

此变量将在您的 server.js 中用于动态设置端口:

node server.js

第 8 步:添加错误处理和中间件

Express 中的中间件是一个可以访问请求对象 (req)、响应对象 (res) 以及应用程序请求-响应周期中的下一个中间件函数的函数。

您可以创建自定义中间件来处理错误:

npx nodemon server.js

这会捕获应用程序中任何未处理的错误,并以 500 状态代码进行响应。

第 9 步:构建您的项目(可选)

随着应用程序的增长,正确组织它是一个好主意:

Welcome to my custom Node.js backend!
  • controllers/:处理 API 路由的逻辑。
  • routes/:定义端点并将它们连接到控制器。
  • models/:处理数据结构,将来可能使用数据库。

第 10 步:连接到数据库(可选)

如果你想持久化数据,你可以将你的后端连接到数据库。例如:

  • MongoDB:使用 mongoose 与 MongoDB 数据库交互。
  • MySQL/PostgreSQL:使用sequelize或pg与SQL数据库交互。

对于 MongoDB,安装 mongoose:

// Example user data
let users = [
  { id: 1, name: 'John Doe' },
  { id: 2, name: 'Jane Doe' }
];

// Route to get all users
app.get('/users', (req, res) => {
  res.json(users);
});

// Route to get a user by ID
app.get('/users/:id', (req, res) => {
  const userId = parseInt(req.params.id);
  const user = users.find((u) => u.id === userId);

  if (user) {
    res.json(user);
  } else {
    res.status(404).send('User not found');
  }
});

// Route to create a new user
app.post('/users', (req, res) => {
  const newUser = {
    id: users.length + 1,
    name: req.body.name
  };
  users.push(newUser);
  res.status(201).json(newUser);
});

// Route to delete a user by ID
app.delete('/users/:id', (req, res) => {
  const userId = parseInt(req.params.id);
  users = users.filter((u) => u.id !== userId);
  res.status(204).send();
});

在 server.js 中:

touch .env

第 11 步:使用 Postman 或 Curl 测试您的 API

要测试您的API,您可以使用Postman或curl:

PORT=3000

或者,您可以安装Postman,它提供了一个用于发出请求和查看响应的GUI。

第 12 步:部署您的后端

后端准备就绪后,您可以使用云平台进行部署,例如:

  • Heroku:用于快速部署。
  • AWS EC2:对服务器进行更多控制。
  • DigitalOcean:用于简单的云托管。

对于部署,请确保您的 PORT 是动态的,并且 API 密钥等敏感信息存储在环境变量中。

结论

通过执行这些步骤,您现在已经有了一个使用 Node.js 构建的基本自定义后端。您可以通过添加身份验证、连接到数据库以及处理高级功能(例如与 WebSocket 进行实时通信)来继续扩展此功能。

以上是使用 Node.js 构建自定义后端:分步指南的详细内容。更多信息请关注PHP中文网其他相关文章!

声明:
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn