使用Node.js和Express.js构建本地API服务器教程-js教程-PHP中文网

使用Node.js和Express.js构建本地API服务器教程

碧海醫心

发布： 2025-11-26 16:46:25

原创

809人浏览过

使用Node.js和Express.js构建本地API服务器教程

本教程旨在指导开发者如何利用node.js和express.js在本地pc上快速搭建api服务器，以响应flutter应用的http请求。文章将详细介绍node.js与express.js的角色，并提供使用yeoman生成器快速初始化项目的方法，帮助您高效开始后端功能开发，包括请求处理、请求验证与数据库交互的初步思路。

理解Node.js与Express.js

在构建API服务器时，常常会遇到Node.js和Express.js这两个概念。它们各自扮演着不同的角色：

Node.js：它是一个JavaScript运行时环境，允许开发者在浏览器之外执行JavaScript代码。Node.js是构建服务器端应用程序的基础，提供了文件系统、网络I/O等核心功能。
Express.js：它是一个基于Node.js的Web应用框架，提供了构建Web应用和API所需的一系列强大功能，如路由、中间件、模板引擎等。简而言之，Node.js是引擎，Express.js则是在这个引擎上构建的车辆骨架，让开发Web应用变得更加高效和便捷。

因此，要构建HTTP/HTTPS服务器来处理Flutter应用的请求，我们通常会选择Node.js作为运行时环境，并结合Express.js框架来简化开发流程。

快速搭建本地API服务器

为了快速启动一个Express.js项目，我们可以利用项目模板和生成器。Yeoman是一个流行的脚手架工具，可以帮助我们快速生成项目结构。这里我们推荐使用 generator-express-no-stress 模板，它提供了一个开箱即用的Express API项目骨架。

1. 安装Node.js和npm

在开始之前，请确保您的PC上已安装Node.js和npm（Node.js包管理器）。您可以访问Node.js官方网站下载并安装。

2. 安装Yeoman和Express生成器

打开您的命令行工具（如CMD、PowerShell或Terminal），运行以下命令全局安装Yeoman和 generator-express-no-stress：

npm install -g yo generator-express-no-stress

登录后复制

npm install -g yo: 全局安装Yeoman脚手架工具。
npm install -g generator-express-no-stress: 全局安装用于生成Express API项目的特定Yeoman生成器。

3. 创建您的API项目

选择一个您希望创建项目的目录，然后运行以下命令来生成一个新的Express API项目：

yo express-no-stress myapp

登录后复制

yo express-no-stress: 调用 generator-express-no-stress 生成器。
myapp: 这是您新项目的名称，您可以根据需要更改它。

4. 进入项目目录并启动服务器

项目生成完成后，进入新创建的项目目录，并启动开发服务器：

cd myapp
npm run dev

登录后复制

cd myapp: 切换到您的项目目录。
npm run dev: 运行项目中定义的开发脚本，通常会启动一个本地的Express服务器。

此时，您的本地API服务器应该已经在运行中，并提供了一个初始的设置，您可以基于此开始开发您的后端功能。

实现API逻辑

在服务器启动后，您可以开始编写处理HTTP请求的逻辑。

1. 定义API路由

Express.js通过路由来处理不同的HTTP请求。在生成的项目中，您会找到一个 routes 文件夹，其中包含示例路由文件。您可以创建新的路由文件或修改现有文件来定义您的API端点。

例如，创建一个处理用户登录的路由：

WampServer

WampServer是一个在Windows上的Web开发平台，它允许您使用Apache2、PHP、MySQL和MariaDB创建动态Web应用程序。WampServer会自动安装您需要的一切，以直观地开发Web应用程序。您甚至可以在不触碰设置文件的情况下调整服务器。最重要的是，WampServer提供免费版本（在GPML许可下），包括32位和64位版本。WampServer不兼容Windows XP、SP3或Windows Server 2003。

查看详情

// routes/auth.js
const express = require('express');
const router = express.Router();

router.post('/login', (req, res) => {
  // 在这里处理登录逻辑
  const { deviceId, username, password } = req.body;

  // 1. 请求验证
  if (!deviceId || !username || !password) {
    return res.status(400).json({ message: '缺少必要的请求参数' });
  }

  // 2. 进一步验证（设备ID、用户登录凭据、网络等）
  // 假设有一个验证函数
  if (!isValidDevice(deviceId) || !authenticateUser(username, password)) {
    return res.status(401).json({ message: '设备或凭据无效' });
  }

  // 验证通过，执行业务逻辑
  // ...
  res.json({ message: '登录成功', token: 'some_jwt_token' });
});

module.exports = router;

登录后复制

然后在主应用文件（通常是 app.js 或 server.js）中引入并使用这个路由：

// app.js (或 server.js)
const authRouter = require('./routes/auth');
app.use('/api/auth', authRouter); // 将 /api/auth 路径下的请求导向 authRouter

登录后复制

2. 请求验证

如问题所述，API需要验证传入请求的设备ID、用户登录和网络。这通常通过中间件或在路由处理函数内部实现：

设备ID验证：可以在请求头中携带设备ID，然后在服务器端验证其合法性。
用户登录验证：通常涉及用户提供的凭据（如用户名/密码），与数据库中存储的信息进行比对。成功后，可以生成一个JSON Web Token (JWT) 返回给客户端，后续请求携带此Token进行身份验证。
网络验证：这可能意味着限制特定IP地址的访问，或者确保请求来自可信的网络环境。

这些验证逻辑应在处理实际业务逻辑之前执行，以确保只有合法的请求才能进入后端核心处理流程。

3. 与SQL Server交互

当验证通过后，您需要将参数发送到SQL Server执行存储过程，并获取结果返回给客户端。在Node.js中，您可以使用像 mssql 这样的npm包来连接SQL Server。

首先，安装 mssql 包：

npm install mssql

登录后复制

然后，在您的路由处理函数中集成SQL Server交互逻辑：

// 假设在某个服务文件中或直接在路由中
const sql = require('mssql');

const config = {
  user: 'your_sql_user',
  password: 'your_sql_password',
  server: 'localhost', // 或您的SQL Server地址
  database: 'your_database_name',
  options: {
    encrypt: false, // For Azure SQL Database, set to true
    trustServerCertificate: true // Change to true for local dev / self-signed certs
  }
};

router.post('/executeProc', async (req, res) => {
  const { param1, param2 } = req.body;

  try {
    await sql.connect(config);
    const request = new sql.Request();

    // 添加存储过程参数
    request.input('inputParam1', sql.NVarChar, param1);
    request.input('inputParam2', sql.Int, param2);

    // 执行存储过程
    const result = await request.execute('YourStoredProcedureName');

    // 将结果返回给客户端
    res.json({ success: true, data: result.recordset });

  } catch (err) {
    console.error('SQL Server error:', err);
    res.status(500).json({ success: false, message: '服务器内部错误或数据库操作失败' });
  } finally {
    sql.close(); // 确保每次请求后关闭连接池
  }
});

登录后复制

注意事项：

连接池管理：在生产环境中，应使用SQL Server连接池来管理数据库连接，而不是每次请求都打开和关闭连接。mssql 库支持连接池。
错误处理：务必捕获并处理数据库操作可能产生的错误，向客户端返回有意义的错误信息，但不要暴露敏感的数据库错误细节。
参数化查询：使用 request.input() 来参数化查询，可以有效防止SQL注入攻击。

总结与注意事项

通过上述步骤，您已经成功在本地PC上搭建了一个Node.js和Express.js的API服务器，并了解了如何开始编写请求处理、验证以及与SQL Server交互的逻辑。

在开发过程中，请注意以下几点：

CORS (跨域资源共享)：由于您的Flutter应用可能运行在不同的端口或域上，您需要配置Express.js来允许跨域请求。可以使用 cors npm包来轻松实现。
错误处理：建立健壮的全局错误处理机制，捕获未处理的异常，并向客户端返回统一的错误响应格式。
环境变量：数据库连接字符串、API密钥等敏感信息应通过环境变量进行管理，而不是硬编码在代码中。
日志记录：使用日志库（如 winston 或 morgan）记录请求、响应和错误信息，便于调试和监控。
安全性：除了基本的请求验证，还需考虑数据加密、API限流、CSRF防护等更高级的安全措施。