本文旨在指导开发者利用node.js运行时和express.js框架，配合yeoman脚手架工具，快速在本地pc上搭建一个能够处理http请求的api服务器。教程将详细介绍如何通过`generator-express-no-stress`模板初始化项目、启动服务，并探讨实现请求验证、与sql server交互等核心api功能。通过本文，您将掌握构建本地后端服务的实用方法，为flutter等客户端应用提供数据支持。
1. Node.js与Express.js基础概念
在开始搭建API服务器之前，我们首先需要理解Node.js和Express.js的角色。
- Node.js: Node.js是一个基于Chrome V8 JavaScript引擎的JavaScript运行时。它允许JavaScript在浏览器之外运行，特别适用于构建高性能、可伸缩的网络应用。
- Express.js: Express.js是Node.js的一个快速、开放、极简的Web框架。它提供了一系列强大的功能，帮助开发者更便捷地创建HTTP/HTTPS服务器，处理路由、中间件、模板引擎等Web开发中的常见任务。简而言之，Node.js是运行环境，而Express.js则是在这个环境下构建Web应用的工具集。
2. 快速启动本地API服务器：Yeoman与Express模板
对于初次创建API的开发者，从零开始配置服务器可能会有些复杂。推荐使用Yeoman这样的脚手架工具，它能帮助我们快速生成一个包含基本配置的项目骨架。这里我们将使用generator-express-no-stress模板，它为Express API提供了一个精简且功能完善的初始设置。
2.1 安装Yeoman及Express模板
首先，确保您的系统已安装Node.js和npm（Node.js包管理器）。然后，通过npm全局安装Yeoman及其Express模板：
# 全局安装Yeoman CLI npm install -g yo # 全局安装generator-express-no-stress模板 npm install -g generator-express-no-stress
2.2 生成并启动API项目
安装完成后，您可以按照以下步骤生成并启动您的第一个Express API项目：
-
创建项目目录并进入: 在您希望创建项目的目录下，打开命令行工具，执行以下命令：
# 使用yo命令和模板名生成一个名为myapp的项目 yo express-no-stress myapp
这会创建一个名为myapp的新目录，并在其中生成Express项目的初始文件结构。
-
进入项目目录:
cd myapp
-
启动开发服务器: 项目生成后，进入项目目录，运行以下命令启动开发服务器：
npm run dev
此命令会启动一个本地的HTTP服务器，通常在http://localhost:3000（或控制台指示的其他端口）上监听请求。现在，您已经拥有了一个可以开始编写后端功能的API服务器。
3. API核心功能实现思路
您的API需要处理请求验证、与SQL Server交互并返回结果。以下是实现这些功能的思路：
3.1 请求验证
为了确保API请求的合法性，您需要实现设备ID、用户登录和网络验证。这些通常作为Express的中间件来实现。
- 设备ID验证: 可以在HTTP请求头中携带设备ID，服务器端编写一个中间件，检查请求头中是否存在有效的设备ID。
- 用户登录验证: 这通常涉及JSON Web Token (JWT) 或Session机制。用户登录成功后，服务器会生成一个Token并返回给客户端。后续请求客户端需携带此Token，服务器端中间件负责验证Token的有效性和用户权限。
- 网络验证: 这可能指的是限制特定IP地址访问，或确保请求来自受信任的网络环境。同样可以通过中间件获取请求的IP地址进行判断。
示例中间件结构（伪代码）:
// authMiddleware.js
function validateDevice(req, res, next) {
const deviceId = req.headers['x-device-id'];
if (!deviceId || !isValidDeviceId(deviceId)) {
return res.status(401).send('Unauthorized: Invalid Device ID');
}
next(); // 继续处理下一个中间件或路由
}
function validateUserToken(req, res, next) {
const token = req.headers['authorization']?.split(' ')[1]; // Bearer
if (!token || !verifyJwt(token)) { // 假设有一个verifyJwt函数
return res.status(401).send('Unauthorized: Invalid User Token');
}
req.user = decodeJwt(token); // 将用户信息附加到请求对象
next();
}
// 在您的路由文件中使用
// const authMiddleware = require('./authMiddleware');
// app.get('/api/data', authMiddleware.validateDevice, authMiddleware.validateUserToken, (req, res) => {
// // 处理业务逻辑
// }); 3.2 与SQL Server交互
Node.js生态系统中有多种库可以连接和操作SQL Server，例如mssql或tedious。
-
安装SQL Server驱动:
npm install mssql
-
建立数据库连接: 在您的应用中配置数据库连接信息，并建立连接池以提高性能。
const sql = require('mssql'); const config = { user: 'your_username', password: 'your_password', server: 'localhost', // 或您的SQL Server地址 database: 'your_database', options: { encrypt: false, // For Azure SQL Database, set true trustServerCertificate: true // Change to true for local dev / self-signed certs } }; let pool; // 声明一个连接池变量 async function connectDb() { try { pool = await new sql.ConnectionPool(config).connect(); console.log('Connected to SQL Server'); } catch (err) { console.error('Database Connection Failed!', err); process.exit(1); // 连接失败则退出应用 } } connectDb(); // 应用启动时调用 -
处理请求参数并调用存储过程: 当API接收到客户端请求时，从req.body或req.query中提取参数。然后，使用mssql库执行SQL Server的存储过程，并将参数传递给它。
// apiRoutes.js const express = require('express'); const router = express.Router(); const sql = require('mssql'); // 确保已连接数据库 router.post('/processData', async (req, res) => { try { const { param1, param2 } = req.body; // 从请求体获取参数 // 创建请求对象，并添加输入参数 const request = new sql.Request(pool); // 使用之前创建的连接池 request.input('InputParam1', sql.NVarChar, param1); request.input('InputParam2', sql.Int, param2); // 执行存储过程 const result = await request.execute('YourStoredProcedureName'); // 将存储过程的结果返回给客户端 res.status(200).json({ message: 'Data processed successfully', data: result.recordsets[0] // 存储过程可能返回多个结果集 }); } catch (err) { console.error('Error processing data:', err); res.status(500).json({ message: 'Failed to process data', error: err.message }); } }); module.exports = router;
3.3 错误处理与响应
良好的API应该提供清晰的错误信息和统一的响应格式。在Express中，可以通过自定义错误处理中间件来捕获和响应错误。
// app.js (或您的主应用文件)
// ... 其他中间件和路由
// 捕获404错误的中间件
app.use((req, res, next) => {
const error = new Error('Not Found');
error.status = 404;
next(error);
});
// 全局错误处理中间件
app.use((error, req, res, next) => {
res.status(error.status || 500);
res.json({
message: error.message,
error: process.env.NODE_ENV === 'development' ? error : {} // 生产环境不暴露详细错误栈
});
});4. 开发注意事项
在开发本地API服务器时，请注意以下几点：
- 数据库连接安全: 不要将数据库凭据硬编码在代码中。使用环境变量（例如.env文件配合dotenv库）来管理敏感信息。
- API路由设计: 采用RESTful风格设计API路由，使接口清晰易懂。例如，GET /users获取用户列表，POST /users创建新用户。
- 跨域资源共享 (CORS): 如果您的Flutter应用运行在与API不同的端口或域名下，您需要配置CORS，允许客户端请求。可以使用cors npm包。
- 日志记录: 在开发和生产环境中，记录API请求、响应和错误日志非常重要，有助于调试和监控。
- 代码组织: 随着项目规模的增长，将路由、中间件、数据库操作等模块化，保持代码结构清晰。
- 测试: 编写单元测试和集成测试，确保API功能的正确性和稳定性。
5. 总结
通过本教程，您应该已经掌握了使用Node.js和Express.js，并借助Yeoman脚手架工具，快速搭建本地API服务器的基本方法。我们探讨了如何利用中间件实现请求验证，以及如何与SQL Server进行数据交互。请记住，这只是一个起点，实际的API开发还需要考虑安全性、可伸缩性、性能优化等更多方面。持续学习和实践，您将能够构建出强大而健壮的后端服务。
