如何在Sequelize中设置可选查询参数？解决酒店API查询异常

我正在用Sequelize写酒店查询的Controller，需要支持这些API场景：

• api/hotels（查询所有酒店）
• api/hotels/id（单酒店查询，该场景对应单独路由，当前代码为列表查询接口）
• api/hotels?featured=true（查询推荐酒店）
• api/hotels?featured=true&limit=SOMEVALUE（分页查询推荐酒店）
• api/hotels?featured=true&limit=SOMEVALUE&xxx=xxx（带其他自定义参数的查询）

目前已实现featured和limit的基础功能，但如果请求不带limit参数，后端会默认将其设为0，导致查询异常。想把所有查询参数都设为可选，另外还计划用min和max参数实现cheapestPrice的范围查询。当前Controller代码如下：

export const getHotels = async (req, res, next) => {
  try {
    const { min, max, limit, ...others } = req.query;
const parsedLimit = limit ? Number(limit) : null;
    const hotels = await Hotel.findAll({
      where: {
        ...others,
        // cheapestPrice: { $gt: min | 1, $lt: max | 100000 },
      },
      limit: Number(parsedLimit),
      [Op.or]: {},
    });
    res.status(200).json(hotels);
  } catch (err) {
    next(err);
  }
};

核心思路：只在参数存在且有效时，才将其加入Sequelize的查询配置，避免给参数设置不合理默认值（比如0）干扰查询逻辑。

修改后的完整代码 #

// 需导入Sequelize的Op对象，否则Op.gt/Op.lt会报错
import { Op } from 'sequelize';

export const getHotels = async (req, res, next) => {
  try {
    const { min, max, limit, ...others } = req.query;
    
    // 初始化基础查询条件
    const whereCondition = { ...others };
    
    // 处理min/max价格范围查询：仅当参数存在时添加对应条件
    if (min) {
      whereCondition.cheapestPrice = { ...whereCondition.cheapestPrice, [Op.gt]: Number(min) };
    }
    if (max) {
      whereCondition.cheapestPrice = { ...whereCondition.cheapestPrice, [Op.lt]: Number(max) };
    }

    // 构建findAll配置项：仅当limit存在且为有效正整数时添加该参数
    const findAllOptions = {
      where: whereCondition,
      // 若无需或查询逻辑，可移除空的[Op.or]配置
    };
    if (limit) {
      const parsedLimit = Number(limit);
      // 额外校验：确保limit是正整数，避免非法值导致的异常
      if (parsedLimit > 0) {
        findAllOptions.limit = parsedLimit;
      }
    }

    const hotels = await Hotel.findAll(findAllOptions);
    res.status(200).json(hotels);
  } catch (err) {
    next(err);
  }
};

关键调整说明 #

1. 可选limit处理：

   • 不再给limit设置默认值，仅当请求中存在limit且为正整数时，才将其加入查询配置。
   • 无limit参数时，Sequelize会使用默认行为返回所有符合条件的数据，不会出现返回0条的异常。

2. min/max范围查询：

   • 分别判断min和max是否存在，仅当参数有效时才添加对应范围条件。
   • 避免了原代码中用|设置默认值导致的逻辑异常（比如用户传min=0会被强制覆盖为1）。

3. 通用参数兼容：

   • 保留...others逻辑，自动支持任意匹配酒店模型字段的自定义查询参数，无需额外修改代码。

4. 类型安全校验：

   • 所有数值型参数（limit、min、max）均做Number()转换，同时给limit增加正整数校验，避免非法参数导致的查询错误。

内容的提问来源于stack exchange，提问作者Patrick Thøgersen