Nestjs使用Joi的validationSchema验证嵌套对象无报错问题排查

根本原因 #

• NestJS 官方 ConfigModule 的 validationSchema 默认仅校验原生环境变量（即 process.env 上的扁平字符串键值对），不会校验你通过 load 配置导入的自定义嵌套配置对象。
• 你写在 .env 文件中的 a: { "b": 1 } 并不会被默认解析为嵌套对象，它本质是 process.env 上一个键为a、值为{ "b": 1 }的字符串，与你定义的a: Joi.object(...)校验规则类型不匹配，且你开启了allowUnknown: true，未匹配到规则的字段会被直接忽略，因此不会触发校验错误。
• 你修改为根层级校验b字段时触发报错是正常逻辑：因为process.env根级别不存在b这个键，符合required()的触发条件，自然抛出错误。

解决方案 #

方案1：自定义配置加载时内置校验（最推荐） #

直接在你引入的generalConfig加载逻辑中加入Joi校验，校验自定义配置的完整嵌套结构：

// generalConfig 定义文件
import * as Joi from 'joi';

export const generalConfig = () => {
  // 组装你的嵌套配置，可从process.env读取字段拼接
  const config = {
    a: {
      b: process.env.A_B ? Number(process.env.A_B) : 'c'
      // 其他配置字段
    }
  };

  // 自定义校验逻辑
  const validationSchema = Joi.object({
    a: Joi.object({
      b: Joi.number().min(0).max(2).required(),
    }),
  });

  const { error } = validationSchema.validate(config, {
    abortEarly: true
  });
  if (error) {
    throw new Error(`配置校验失败: ${error.message}`);
  }
  return config;
};

方案2：拉平环境变量校验 #

将嵌套结构拆分为扁平的环境变量写入.env，直接用validationSchema校验：

1. .env修改为：

A_B=1

2. validationSchema修改为：

validationSchema: Joi.object({
  A_B: Joi.number().min(0).max(2).required(),
}),

3. 在generalConfig中再将扁平变量组装为嵌套结构即可。

方案3：前置解析.env嵌套结构 #

如果必须在.env中写嵌套JSON格式，你需要在ConfigModule初始化前，自行解析.env文件中的JSON字符串，将嵌套结构合并到待校验的配置对象中再传入校验，该方案需要额外处理JSON解析异常，复杂度较高，不推荐。

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