Express.js 是一个广受欢迎的 Node.js Web 框架，使用它可以快速搭建 Web 应用程序。RESTful API 开发是目前前端类开发中非常重要的一项技能，因此很多开发者都想使用 Express.js 来进行 RESTful API 的开发。然而，纵观网上相关的教程和资料，我们会发现一些开发者在使用 Express.js 进行 RESTful API 开发时容易犯一些错误。本文将详细介绍 Express.js 进行 RESTful API 开发的九大误区，并为大家提供解决方案和示例代码。
误区一：忽略全局错误处理
全局错误处理是指程序执行中产生错误时，如何响应并向客户端返回错误信息。忽略全局错误处理会导致程序出现异常时服务器直接崩溃，客户端无法得到正确的错误信息。
解决方案：使用 Express.js 中的 error handling middleware 进行全局错误处理。
例如：
app.use((err, req, res, next) => { console.error(err.stack) res.status(500).send('Something broke!') })
误区二：忽略请求体解析
在 RESTful API 的开发中，请求体解析是非常关键的环节。请求体包含了客户端提交的数据，而服务器需要从请求体中解析出这些数据。忽略请求体解析会导致服务器无法正确接收和解析客户端提交的数据。
解决方案：使用 Express.js 的中间件 body-parser 进行请求体解析。
例如：
const express = require('express') const bodyParser = require('body-parser') const app = express() app.use(bodyParser.urlencoded({extended: true})) app.use(bodyParser.json())
误区三：未对请求地址进行校验
RESTful API 需要对客户端提交的请求地址进行校验，以防止未经授权的访问。如果未对请求地址进行校验，可能会导致客户端请求了非法地址，造成服务器资源的浪费。
解决方案：使用 Express.js 的路由校验功能，防止客户端请求未被授权的地址。
例如：
app.use('/user', userRouter)
误区四：未对请求参数进行校验
RESTful API 需要对客户端提交的请求参数进行校验，以确保请求参数符合要求。如果未对请求参数进行校验，可能会导致服务器接收到非法的请求参数，造成程序出错。
解决方案：使用 Express.js 的验证中间件进行请求参数校验。
例如：
-- -------------------- ---- ------- ----- ------- - ------------------ ----- --- - -------------- ----- --- - --------- ----------------- ----- ---- -- - ----- ------ - ------------ --------- -------------------------------------------------- ------ -------------------------------- --------- ------------------------ ------------------------------------------ ---------------- -------------------- -- ----- ------- - ------------------------- -- ------- - ---------------------------------------------- ------ - -------------- ------- -------------- --展开代码
误区五：忽略请求的 HTTP 方法
RESTful API 使用 HTTP 方法来指定客户端对服务器资源的操作。如果客户端提交的请求的 HTTP 方法不正确，可能会导致服务器资源的浪费。
解决方案：使用 Express.js 的路由校验功能，指定客户端请求的 HTTP 方法。
例如：
app.get('/user/:id', (req, res) => { res.send('user ' + req.params.id) })
误区六：忽略路由模块化
如果 Express.js 的路由模块化被忽略，可能会导致程序结构不清晰，代码难以维护。
解决方案：对路由进行模块化，让代码结构更清晰。
例如：
const express = require('express') const app = express() const userRouter = require('./user') app.use('/user', userRouter)
误区七：在路由中执行业务逻辑
将业务逻辑放在路由中会导致路由逻辑不清晰，这在大型的项目中会导致混乱和不易维护。
解决方案：将业务逻辑从路由中分离出来，形成独立的服务层。
例如：
-- -------------------- ---- ------- ----- ----------- - ------------------------ ----------------- ----- ----- ---- -- - --- - ----- ---- - ----- -------------------------------- -------------- - ----- ----- - --------------------------------- - --展开代码
误区八：未进行身份认证和授权
RESTful API 中，身份认证和授权非常重要。如果未进行身份认证和授权，可能会导致未经授权的客户端获取敏感信息或操作重要数据。
解决方案：使用 Express.js 的中间件对需要身份认证和授权的 API 进行权限控制。
例如：
const auth = require('./auth') const adminRouter = require('./admin') app.use('/admin', auth, adminRouter)
误区九：忽略了 API 文档化
RESTful API 的开发需要一个规范的 API 文档，API 文档能够对开发者和使用者提供方便。忽略 API 的文档化，可能会导致项目难以维护和使用。
解决方案：使用开源的 API 文档工具，如 Swagger 或 Apiary 等。
例如：
const swaggerUi = require('swagger-ui-express') const swaggerDocument = require('./swagger.json') app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
通过本文介绍的这九大误区的解决方案，我们可以更好地使用 Express.js 进行 RESTful API 的开发，并且在开发过程中保持清晰、规范的项目结构，提高项目代码的可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6794807d504e4ea9bd90d059
