如何用Joi实现异步自定义验证：检查对象字段值是否存在于数据库

核心思路 #

通过Joi的custom方法绑定异步验证函数，在函数中完成数据库查询校验，最后用validateAsync执行异步验证流程。

完整实现步骤 #

1. 定义数据库查询逻辑

先封装你的数据库查询函数（替换成实际项目中的数据库操作，比如ORM或原生SQL查询）：

// 模拟数据库查询，实际项目中替换为你的真实查询逻辑
async function checkValueExists(value) {
  // 示例：用Sequelize查询
  // const record = await YourModel.findOne({ where: { targetColumn: value } });
  // 示例：用MongoDB查询
  // const record = await yourCollection.findOne({ targetField: value });
  
  // 这里用模拟结果演示：仅当值为'valueA'时判定存在
  return value === 'valueA';
}

2. 编写异步验证函数

创建符合Joi要求的异步验证函数，通过helpers.error抛出标准验证错误：

async function validateFieldA(value, helpers) {
  const isExists = await checkValueExists(value);
  if (!isExists) {
    // 抛出自定义错误消息，Joi会自动格式化错误结构
    return helpers.error('any.invalid', { message: '字段a的值不存在于数据库中' });
  }
  // 验证通过时返回原字段值
  return value;
}

3. 构建Joi Schema

将验证函数绑定到字段a的规则中：

const Joi = require('joi');

const targetSchema = Joi.object({
  a: Joi.string().custom(validateFieldA, '数据库存在性校验'), // 第二个参数为校验描述，方便调试
  b: Joi.string().required()
});

4. 执行异步验证

使用validateAsync方法执行验证（必须用async/await处理异步流程）：

async function validateTargetObject(obj) {
  try {
    const validatedData = await targetSchema.validateAsync(obj);
    console.log('验证通过：', validatedData);
    return validatedData;
  } catch (error) {
    // 捕获并处理验证错误
    console.error('验证失败：', error.details[0].message);
    throw error;
  }
}

// 测试用例
validateTargetObject({ a: 'valueA', b: 'valueB' }); // 验证通过
validateTargetObject({ a: 'invalidValue', b: 'valueB' }); // 验证失败，抛出错误

关键注意点 #

• 必须使用validateAsync而非同步的validate方法，因为异步验证规则不支持同步执行。
• 验证函数必须标记为async，确保数据库查询的异步流程被正确处理。
• 用helpers.error抛出错误能保证错误格式与Joi原生错误一致，便于统一处理错误信息。

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