Node+Express新手求助：如何使用express-boom的badRequest？

Hey there! 作为Node+Express新手，刚接触express-boom确实容易有点懵，我来一步步帮你搞定这个问题。

第一步：先搞定中间件的安装与注册 #

很多人踩坑都是因为漏了注册中间件这关键一步，先把基础工作做好：

• 首先安装模块：

  npm install express-boom
  # 或者用yarn
  yarn add express-boom
  

• 在你的主入口文件（比如app.js/server.js）里，一定要在路由之前注册boom中间件：
  如果你用CommonJS（require语法）：

  const express = require('express');
  const boom = require('express-boom');
  const app = express();
  
  // 注册boom中间件，这步必须在路由前面！
  app.use(boom());
  
  // 再引入你的控制器路由
  const mainController = require('./path/to/mainController');
  app.use('/api', mainController);
  

  如果你用ES模块（import语法）：

  import express from 'express';
  import boom from 'express-boom';
  const app = express();
  
  app.use(boom());
  
  import mainController from './path/to/mainController';
  app.use('/api', mainController);
  

第二步：在mainController.js里调用并返回reasons对象 #

你原来的写法是手动设置状态码和响应体，用express-boom可以更简洁地实现，同时完美带上reasons对象。举个贴合你场景的例子：

// mainController.js（CommonJS示例）
exports.checkBroker = (req, res) => {
  // 假设这里是你的校验逻辑
  const brokerName = req.body.brokerName;
  // 定义你的reasons对象，把所有校验失败的细节放这里
  const reasons = {
    brokerName: 'Unrecognized Broker name',
    // 还可以加其他校验失败项，比如：
    // requiredField: 'Broker ID is missing'
  };

  // 模拟校验失败的场景
  if (!brokerName || !['BrokerA', 'BrokerB'].includes(brokerName)) {
    // 直接调用res.boom.badRequest，第一个参数是提示消息，第二个就是reasons对象
    res.boom.badRequest('Validation didn\'t succeed', reasons);
  } else {
    // 校验通过后的正常响应
    res.send({ message: 'Broker validated successfully' });
  }
};

如果是ES模块的控制器：

export const checkBroker = (req, res) => {
  const brokerName = req.body.brokerName;
  const reasons = {
    brokerName: 'Unrecognized Broker name'
  };

  if (!brokerName || !['BrokerA', 'BrokerB'].includes(brokerName)) {
    res.boom.badRequest('Validation didn\'t succeed', reasons);
  } else {
    res.send({ message: 'Broker validated successfully' });
  }
};

最后说一下响应结构 #

当你调用res.boom.badRequest()后，express-boom会自动帮你设置400状态码，返回的响应体结构大概是这样的：

{
  "statusCode": 400,
  "error": "Bad Request",
  "message": "Validation didn't succeed",
  "reasons": {
    "brokerName": "Unrecognized Broker name"
  }
}

完全满足你返回reasons对象的需求，比手动写响应规范得多。

提醒个小坑：一定要确保app.use(boom())在所有路由之前注册，不然res对象上不会有boom方法，调用时会报错哦！

内容的提问来源于stack exchange，提问作者Shikha A